Fleece+CoreFoundation.h

Go to the documentation of this file.

//
// Fleece+CoreFoundation.h
//
// Copyright 2016-Present Couchbase, Inc.
//
// Use of this software is governed by the Business Source License included
// in the file licenses/BSL-Couchbase.txt.  As of the Change Date specified
// in that file, in accordance with the Business Source License, use of this
// software will be governed by the Apache License, Version 2.0, included in
// the file licenses/APL2.txt.
//
 
#pragma once
#include <CoreFoundation/CFBase.h>
#include "fleece/FLCollections.h"
 
#ifdef __OBJC__
#import <Foundation/NSMapTable.h>
#endif
 
FL_ASSUME_NONNULL_BEGIN
 
#ifdef __cplusplus
extern "C" {
#endif
 
    FLEECE_PUBLIC bool FLEncoder_WriteCFObject(FLEncoder, CFTypeRef) FLAPI;
 
 
    FLEECE_PUBLIC CFTypeRef FLValue_CopyCFObject(FLValue FL_NULLABLE) FLAPI;
 
 
    FLEECE_PUBLIC FLValue FLDict_GetWithCFString(FLDict FL_NULLABLE, CFStringRef) FLAPI;
 
 
#ifdef __OBJC__
    // Equivalents of the above functions that take & return Objective-C object types:
    
    FLEECE_PUBLIC bool FLEncoder_WriteNSObject(FLEncoder, id) FLAPI;
 
 
    FLEECE_PUBLIC NSMapTable* FLCreateSharedStringsTable(void) FLAPI;
 
    
    FLEECE_PUBLIC id FLValue_GetNSObject(FLValue FL_NULLABLE, NSMapTable* FL_NULLABLE sharedStrings) FLAPI;
 
 
    FLEECE_PUBLIC FLValue FLDict_GetWithNSString(FLDict FL_NULLABLE, NSString*) FLAPI;
 
 
    FLEECE_PUBLIC NSString* FLDictIterator_GetKeyAsNSString(const FLDictIterator *i,
                                              NSMapTable* FL_NULLABLE sharedStrings) FLAPI;
 
    FLEECE_PUBLIC NSData* FLEncoder_FinishWithNSData(FLEncoder, NSError** FL_NULLABLE) FLAPI;
 
 
    FLEECE_PUBLIC extern NSString* const FLErrorDomain;
 
 
    @interface NSObject (Fleece)
    - (void) fl_encodeToFLEncoder: (FLEncoder)enc;
    @end
#endif
 
#ifdef __cplusplus
}
#endif
 
FL_ASSUME_NONNULL_END