CFPropertyList.h

   1 /*
   2  * Copyright (c) 2011 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
  24 /*      CFPropertyList.h
  25         Copyright (c) 1998-2011, Apple Inc. All rights reserved.
  26 */
  27
  28 #if !defined(__COREFOUNDATION_CFPROPERTYLIST__)
  29 #define __COREFOUNDATION_CFPROPERTYLIST__ 1
  30
  31 #include <CoreFoundation/CFBase.h>
  32 #include <CoreFoundation/CFData.h>
  33 #include <CoreFoundation/CFString.h>
  34 #include <CoreFoundation/CFError.h>
  35 #if TARGET_OS_MAC || TARGET_OS_WIN32 || TARGET_OS_EMBEDDED
  36 #include <CoreFoundation/CFStream.h>
  37 #endif
  38
  39 CF_EXTERN_C_BEGIN
  40
  41 enum {
  42     kCFPropertyListImmutable = 0,
  43     kCFPropertyListMutableContainers,
  44     kCFPropertyListMutableContainersAndLeaves
  45 };
  46 typedef CFOptionFlags CFPropertyListMutabilityOptions;
  47
  48 /*
  49         Creates a property list object from its XML description; xmlData should
  50         be the raw bytes of that description, possibly the contents of an XML
  51         file. Returns NULL if the data cannot be parsed; if the parse fails
  52         and errorString is non-NULL, a human-readable description of the failure
  53         is returned in errorString. It is the caller's responsibility to release
  54         either the returned object or the error string, whichever is applicable.
  55
  56         This function is obsolete and will be deprecated soon. See CFPropertyListCreateWithData() for a replacement.
  57 */
  58 CF_EXPORT
  59 CFPropertyListRef CFPropertyListCreateFromXMLData(CFAllocatorRef allocator, CFDataRef xmlData, CFOptionFlags mutabilityOption, CFStringRef *errorString);
  60
  61 /*
  62         Returns the XML description of the given object; propertyList must
  63         be one of the supported property list types, and (for composite types
  64         like CFArray and CFDictionary) must not contain any elements that
  65         are not themselves of a property list type. If a non-property list
  66         type is encountered, NULL is returned. The returned data is
  67         appropriate for writing out to an XML file. Note that a data, not a
  68         string, is returned because the bytes contain in them a description
  69         of the string encoding used.
  70
  71         This function is obsolete and will be deprecated soon. See CFPropertyListCreateData() for a replacement.
  72 */
  73 CF_EXPORT
  74 CFDataRef CFPropertyListCreateXMLData(CFAllocatorRef allocator, CFPropertyListRef propertyList);
  75
  76 /*
  77         Recursively creates a copy of the given property list (so nested arrays
  78         and dictionaries are copied as well as the top-most container). The
  79         resulting property list has the mutability characteristics determined
  80         by mutabilityOption.
  81 */
  82 CF_EXPORT
  83 CFPropertyListRef CFPropertyListCreateDeepCopy(CFAllocatorRef allocator, CFPropertyListRef propertyList, CFOptionFlags mutabilityOption);
  84
  85 enum {
  86     kCFPropertyListOpenStepFormat = 1,
  87     kCFPropertyListXMLFormat_v1_0 = 100,
  88     kCFPropertyListBinaryFormat_v1_0 = 200
  89 };
  90 typedef CFIndex CFPropertyListFormat;
  91
  92 /* Returns true if the object graph rooted at plist is a valid property list
  93  * graph -- that is, no cycles, containing only plist objects, and dictionary
  94  * keys are strings. The debugging library version spits out some messages
  95  * to be helpful. The plist structure which is to be allowed is given by
  96  * the format parameter. */
  97 CF_EXPORT
  98 Boolean CFPropertyListIsValid(CFPropertyListRef plist, CFPropertyListFormat format);
  99
 100 #if TARGET_OS_MAC || TARGET_OS_WIN32 || TARGET_OS_EMBEDDED
 101
 102 /* Writes the bytes of a plist serialization out to the stream.  The
 103  * stream must be opened and configured -- the function simply writes
 104  * a bunch of bytes to the stream. The output plist format can be chosen.
 105  * Leaves the stream open, but note that reading a plist expects the
 106  * reading stream to end wherever the writing ended, so that the
 107  * end of the plist data can be identified. Returns the number of bytes
 108  * written, or 0 on error. Error messages are not currently localized, but
 109  * may be in the future, so they are not suitable for comparison.
 110  *
 111  * This function is obsolete and will be deprecated soon. See CFPropertyListWrite() for a replacement. */
 112 CF_EXPORT
 113 CFIndex CFPropertyListWriteToStream(CFPropertyListRef propertyList, CFWriteStreamRef stream, CFPropertyListFormat format, CFStringRef *errorString);
 114
 115
 116 /* Same as current function CFPropertyListCreateFromXMLData()
 117  * but takes a stream instead of data, and works on any plist file format.
 118  * CFPropertyListCreateFromXMLData() also works on any plist file format.
 119  * The stream must be open and configured -- the function simply reads a bunch
 120  * of bytes from it starting at the current location in the stream, to the END
 121  * of the stream, which is expected to be the end of the plist, or up to the
 122  * number of bytes given by the length parameter if it is not 0. Error messages
 123  * are not currently localized, but may be in the future, so they are not
 124  * suitable for comparison.
 125  *
 126  * This function is obsolete and will be deprecated soon. See CFPropertyListCreateWithStream() for a replacement. */
 127 CF_EXPORT
 128 CFPropertyListRef CFPropertyListCreateFromStream(CFAllocatorRef allocator, CFReadStreamRef stream, CFIndex streamLength, CFOptionFlags mutabilityOption, CFPropertyListFormat *format, CFStringRef *errorString);
 129
 130 #endif
 131
 132 #if MAC_OS_X_VERSION_10_6 <= MAC_OS_X_VERSION_MAX_ALLOWED || __IPHONE_4_0 <=  __IPHONE_OS_VERSION_MAX_ALLOWED
 133 enum {
 134     kCFPropertyListReadCorruptError = 3840,              // Error parsing a property list
 135     kCFPropertyListReadUnknownVersionError = 3841,       // The version number in the property list is unknown
 136     kCFPropertyListReadStreamError = 3842,               // Stream error reading a property list
 137     kCFPropertyListWriteStreamError = 3851,              // Stream error writing a property list
 138 };
 139 #endif
 140
 141 /* 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.
 142  */
 143 CF_EXPORT
 144 CFPropertyListRef CFPropertyListCreateWithData(CFAllocatorRef allocator, CFDataRef data, CFOptionFlags options, CFPropertyListFormat *format, CFErrorRef *error) CF_AVAILABLE(10_6, 4_0);
 145
 146 #if TARGET_OS_MAC || TARGET_OS_WIN32 || TARGET_OS_EMBEDDED
 147
 148 /* 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.
 149  */
 150 CF_EXPORT
 151 CFPropertyListRef CFPropertyListCreateWithStream(CFAllocatorRef allocator, CFReadStreamRef stream, CFIndex streamLength, CFOptionFlags options, CFPropertyListFormat *format, CFErrorRef *error) CF_AVAILABLE(10_6, 4_0);
 152
 153 /* 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.
 154  */
 155 CF_EXPORT
 156 CFIndex CFPropertyListWrite(CFPropertyListRef propertyList, CFWriteStreamRef stream, CFPropertyListFormat format, CFOptionFlags options, CFErrorRef *error) CF_AVAILABLE(10_6, 4_0);
 157
 158 #endif
 159
 160 /* 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.
 161  */
 162 CF_EXPORT
 163 CFDataRef CFPropertyListCreateData(CFAllocatorRef allocator, CFPropertyListRef propertyList, CFPropertyListFormat format, CFOptionFlags options, CFErrorRef *error) CF_AVAILABLE(10_6, 4_0);
 164
 165
 166 CF_EXTERN_C_END
 167
 168 #endif /* ! __COREFOUNDATION_CFPROPERTYLIST__ */
 169