CFPlugIn_Factory.h

   1 /*
   2  * Copyright (c) 2008 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 /*      CFPlugIn_Factory.h
  24         Copyright (c) 1999-2007, Apple Inc.  All rights reserved.
  25 */
  26
  27 #if !defined(__COREFOUNDATION_CFPLUGIN_FACTORY__)
  28 #define __COREFOUNDATION_CFPLUGIN_FACTORY__ 1
  29
  30 #include "CFBundle_Internal.h"
  31
  32 CF_EXTERN_C_BEGIN
  33
  34 typedef struct __CFPFactory {
  35     CFAllocatorRef _allocator;
  36
  37     CFUUIDRef _uuid;
  38     Boolean _enabled;
  39     char _padding[3];
  40     SInt32 _instanceCount;
  41
  42     CFPlugInFactoryFunction _func;
  43
  44     CFPlugInRef _plugIn;
  45     CFStringRef _funcName;
  46
  47     CFMutableArrayRef _types;
  48 } _CFPFactory;
  49
  50 extern _CFPFactory *_CFPFactoryCreate(CFAllocatorRef allocator, CFUUIDRef factoryID, CFPlugInFactoryFunction func);
  51 extern _CFPFactory *_CFPFactoryCreateByName(CFAllocatorRef allocator, CFUUIDRef factoryID, CFPlugInRef plugIn, CFStringRef funcName);
  52
  53 extern _CFPFactory *_CFPFactoryFind(CFUUIDRef factoryID, Boolean enabled);
  54
  55 extern CFUUIDRef _CFPFactoryGetFactoryID(_CFPFactory *factory);
  56 extern CFPlugInRef _CFPFactoryGetPlugIn(_CFPFactory *factory);
  57
  58 extern void *_CFPFactoryCreateInstance(CFAllocatorRef allocator, _CFPFactory *factory, CFUUIDRef typeID);
  59 extern void _CFPFactoryDisable(_CFPFactory *factory);
  60 extern Boolean _CFPFactoryIsEnabled(_CFPFactory *factory);
  61
  62 extern void _CFPFactoryFlushFunctionCache(_CFPFactory *factory);
  63
  64 extern void _CFPFactoryAddType(_CFPFactory *factory, CFUUIDRef typeID);
  65 extern void _CFPFactoryRemoveType(_CFPFactory *factory, CFUUIDRef typeID);
  66
  67 extern Boolean _CFPFactorySupportsType(_CFPFactory *factory, CFUUIDRef typeID);
  68 extern CFArrayRef _CFPFactoryFindForType(CFUUIDRef typeID);
  69
  70 /* These methods are called by CFPlugInInstance when an instance is created or destroyed.  If a factory's instance count goes to 0 and the factory has been disabled, the factory is destroyed. */
  71 extern void _CFPFactoryAddInstance(_CFPFactory *factory);
  72 extern void _CFPFactoryRemoveInstance(_CFPFactory *factory);
  73
  74 CF_EXTERN_C_END
  75
  76 #endif /* ! __COREFOUNDATION_CFPLUGIN_FACTORY__ */
  77