CFPropertyList.h

   1 /*
   2  * Copyright (c) 2009 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*      CFPropertyList.h
  24         Copyright (c) 1998-2009, Apple Inc. All rights reserved.
  25 */
  26
  27 #if !defined(__COREFOUNDATION_CFPROPERTYLIST__)
  28 #define __COREFOUNDATION_CFPROPERTYLIST__ 1
  29
  30 #include <CoreFoundation/CFBase.h>
  31 #include <CoreFoundation/CFData.h>
  32 #include <CoreFoundation/CFString.h>
  33 #include <CoreFoundation/CFStream.h>
  34
  35 CF_EXTERN_C_BEGIN
  36
  37 enum {
  38     kCFPropertyListImmutable = 0,
  39     kCFPropertyListMutableContainers,
  40     kCFPropertyListMutableContainersAndLeaves
  41 };
  42 typedef CFOptionFlags CFPropertyListMutabilityOptions;
  43
  44 /*
  45         Creates a property list object from its XML description; xmlData should
  46         be the raw bytes of that description, possibly the contents of an XML
  47         file. Returns NULL if the data cannot be parsed; if the parse fails
  48         and errorString is non-NULL, a human-readable description of the failure
  49         is returned in errorString. It is the caller's responsibility to release
  50         either the returned object or the error string, whichever is applicable.
  51
  52         This function is obsolete and will be deprecated soon. See CFPropertyListCreateWithData() for a replacement.
  53 */
  54 CF_EXPORT
  55 CFPropertyListRef CFPropertyListCreateFromXMLData(CFAllocatorRef allocator, CFDataRef xmlData, CFOptionFlags mutabilityOption, CFStringRef *errorString);
  56
  57 /*
  58         Returns the XML description of the given object; propertyList must
  59         be one of the supported property list types, and (for composite types
  60         like CFArray and CFDictionary) must not contain any elements that
  61         are not themselves of a property list type. If a non-property list
  62         type is encountered, NULL is returned. The returned data is
  63         appropriate for writing out to an XML file. Note that a data, not a
  64         string, is returned because the bytes contain in them a description
  65         of the string encoding used.
  66
  67         This function is obsolete and will be deprecated soon. See CFPropertyListCreateData() for a replacement.
  68 */
  69 CF_EXPORT
  70 CFDataRef CFPropertyListCreateXMLData(CFAllocatorRef allocator, CFPropertyListRef propertyList);
  71
  72 /*
  73         Recursively creates a copy of the given property list (so nested arrays
  74         and dictionaries are copied as well as the top-most container). The
  75         resulting property list has the mutability characteristics determined
  76         by mutabilityOption.
  77 */
  78 CF_EXPORT
  79 CFPropertyListRef CFPropertyListCreateDeepCopy(CFAllocatorRef allocator, CFPropertyListRef propertyList, CFOptionFlags mutabilityOption);
  80
  81 #if MAC_OS_X_VERSION_10_2 <= MAC_OS_X_VERSION_MAX_ALLOWED
  82
  83 enum {
  84     kCFPropertyListOpenStepFormat = 1,
  85     kCFPropertyListXMLFormat_v1_0 = 100,
  86     kCFPropertyListBinaryFormat_v1_0 = 200
  87 };
  88 typedef CFIndex CFPropertyListFormat;
  89
  90 /* Returns true if the object graph rooted at plist is a valid property list
  91  * graph -- that is, no cycles, containing only plist objects, and dictionary
  92  * keys are strings. The debugging library version spits out some messages
  93  * to be helpful. The plist structure which is to be allowed is given by
  94  * the format parameter. */
  95 CF_EXPORT
  96 Boolean CFPropertyListIsValid(CFPropertyListRef plist, CFPropertyListFormat format);
  97
  98 /* Writes the bytes of a plist serialization out to the stream.  The
  99  * stream must be opened and configured -- the function simply writes
 100  * a bunch of bytes to the stream. The output plist format can be chosen.
 101  * Leaves the stream open, but note that reading a plist expects the
 102  * reading stream to end wherever the writing ended, so that the
 103  * end of the plist data can be identified. Returns the number of bytes
 104  * written, or 0 on error. Error messages are not currently localized, but
 105  * may be in the future, so they are not suitable for comparison.
 106  *
 107  * This function is obsolete and will be deprecated soon. See CFPropertyListWrite() for a replacement. */
 108 CF_EXPORT
 109 CFIndex CFPropertyListWriteToStream(CFPropertyListRef propertyList, CFWriteStreamRef stream, CFPropertyListFormat format, CFStringRef *errorString);
 110
 111
 112 /* Same as current function CFPropertyListCreateFromXMLData()
 113  * but takes a stream instead of data, and works on any plist file format.
 114  * CFPropertyListCreateFromXMLData() also works on any plist file format.
 115  * The stream must be open and configured -- the function simply reads a bunch
 116  * of bytes from it starting at the current location in the stream, to the END
 117  * of the stream, which is expected to be the end of the plist, or up to the
 118  * number of bytes given by the length parameter if it is not 0. Error messages
 119  * are not currently localized, but may be in the future, so they are not
 120  * suitable for comparison.
 121  *
 122  * This function is obsolete and will be deprecated soon. See CFPropertyListCreateWithStream() for a replacement. */
 123 CF_EXPORT
 124 CFPropertyListRef CFPropertyListCreateFromStream(CFAllocatorRef allocator, CFReadStreamRef stream, CFIndex streamLength, CFOptionFlags mutabilityOption, CFPropertyListFormat *format, CFStringRef *errorString);
 125
 126 #endif
 127
 128 #if MAC_OS_X_VERSION_10_6 <= MAC_OS_X_VERSION_MAX_ALLOWED
 129 enum {
 130     kCFPropertyListReadCorruptError = 3840,              // Error parsing a property list
 131     kCFPropertyListReadUnknownVersionError = 3841,       // The version number in the property list is unknown
 132     kCFPropertyListReadStreamError = 3842,               // Stream error reading a property list
 133     kCFPropertyListWriteStreamError = 3851,              // Stream error writing a property list
 134 };
 135 #endif
 136
 137 /* Create a property list with a CFData input. If the format parameter is non-NULL, it will be set to the format of the data after parsing is complete. The options parameter is used to specify CFPropertyListMutabilityOptions. If an error occurs while parsing the data, the return value will be NULL. Additionally, if an error occurs and the error parameter is non-NULL, the error parameter will be set to a CFError describing the problem, which the caller must release. If the parse succeeds, the returned value is a reference to the new property list. It is the responsibility of the caller to release this value.
 138  */
 139 CF_EXPORT
 140 CFPropertyListRef CFPropertyListCreateWithData(CFAllocatorRef allocator, CFDataRef data, CFOptionFlags options, CFPropertyListFormat *format, CFErrorRef *error) AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER;
 141
 142 /* Create and return a property list with a CFReadStream input. TIf the format parameter is non-NULL, it will be set to the format of the data after parsing is complete. The options parameter is used to specify CFPropertyListMutabilityOptions. The streamLength parameter specifies the number of bytes to read from the stream. Set streamLength to 0 to read until the end of the stream is detected. If an error occurs while parsing the data, the return value will be NULL. Additionally, if an error occurs and the error parameter is non-NULL, the error parameter will be set to a CFError describing the problem, which the caller must release. If the parse succeeds, the returned value is a reference to the new property list. It is the responsibility of the caller to release this value.
 143  */
 144 CF_EXPORT
 145 CFPropertyListRef CFPropertyListCreateWithStream(CFAllocatorRef allocator, CFReadStreamRef stream, CFIndex streamLength, CFOptionFlags options, CFPropertyListFormat *format, CFErrorRef *error) AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER;
 146
 147 /* Write the bytes of a serialized property list out to a stream. The stream must be opened and configured. The format of the property list can be chosen with the format parameter. The options parameter is currently unused and should be set to 0. The return value is the number of bytes written or 0 in the case of an error. If an error occurs and the error parameter is non-NULL, the error parameter will be set to a CFError describing the problem, which the caller must release.
 148  */
 149 CF_EXPORT
 150 CFIndex CFPropertyListWrite(CFPropertyListRef propertyList, CFWriteStreamRef stream, CFPropertyListFormat format, CFOptionFlags options, CFErrorRef *error) AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER;
 151
 152 /* Create a CFData with the bytes of a serialized property list. The format of the property list can be chosen with the format parameter. The options parameter is currently unused and should be set to 0. If an error occurs while parsing the data, the return value will be NULL. Additionally, if an error occurs and the error parameter is non-NULL, the error parameter will be set to a CFError describing the problem, which the caller must release. If the conversion succeeds, the returned value is a reference to the created data. It is the responsibility of the caller to release this value.
 153  */
 154 CF_EXPORT
 155 CFDataRef CFPropertyListCreateData(CFAllocatorRef allocator, CFPropertyListRef propertyList, CFPropertyListFormat format, CFOptionFlags options, CFErrorRef *error) AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER;
 156
 157
 158 CF_EXTERN_C_END
 159
 160 #endif /* ! __COREFOUNDATION_CFPROPERTYLIST__ */
 161