]> git.saurik.com Git - apple/cf.git/blobdiff - CFPlugIn.c
CF-476.10.tar.gz
[apple/cf.git] / CFPlugIn.c
diff --git a/CFPlugIn.c b/CFPlugIn.c
new file mode 100644 (file)
index 0000000..da89132
--- /dev/null
@@ -0,0 +1,175 @@
+/*
+ * Copyright (c) 2008 Apple Inc. All rights reserved.
+ *
+ * @APPLE_LICENSE_HEADER_START@
+ * 
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this
+ * file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ * 
+ * @APPLE_LICENSE_HEADER_END@
+ */
+/*     CFPlugIn.c
+       Copyright (c) 1999-2007 Apple Inc.  All rights reserved.
+       Responsibility: Doug Davidson
+*/
+
+#include "CFBundle_Internal.h"
+#include "CFInternal.h"
+
+CONST_STRING_DECL(kCFPlugInDynamicRegistrationKey, "CFPlugInDynamicRegistration")
+CONST_STRING_DECL(kCFPlugInDynamicRegisterFunctionKey, "CFPlugInDynamicRegisterFunction")
+CONST_STRING_DECL(kCFPlugInUnloadFunctionKey, "CFPlugInUnloadFunction")
+CONST_STRING_DECL(kCFPlugInFactoriesKey, "CFPlugInFactories")
+CONST_STRING_DECL(kCFPlugInTypesKey, "CFPlugInTypes")
+
+__private_extern__ void __CFPlugInInitialize(void) {
+}
+
+/* ===================== Finding factories and creating instances ===================== */
+/* For plugIn hosts. */
+/* Functions for finding factories to create specific types and actually creating instances of a type. */
+
+CF_EXPORT CFArrayRef CFPlugInFindFactoriesForPlugInType(CFUUIDRef typeID) {
+    CFArrayRef array = _CFPFactoryFindForType(typeID);
+    CFMutableArrayRef result = NULL;
+    
+    if (array) {
+        SInt32 i, c = CFArrayGetCount(array);
+
+        // Use default allocator
+        result = CFArrayCreateMutable(kCFAllocatorSystemDefault, 0, &kCFTypeArrayCallBacks);
+        
+        for (i=0; i<c; i++) {
+            CFArrayAppendValue(result, _CFPFactoryGetFactoryID((_CFPFactory *)CFArrayGetValueAtIndex(array, i)));
+        }
+    }
+    return result;
+}
+
+CF_EXPORT CFArrayRef CFPlugInFindFactoriesForPlugInTypeInPlugIn(CFUUIDRef typeID, CFPlugInRef plugIn) {
+    CFArrayRef array = _CFPFactoryFindForType(typeID);
+    CFMutableArrayRef result = NULL;
+
+    if (array) {
+        SInt32 i, c = CFArrayGetCount(array);
+        _CFPFactory *factory;
+        
+        // Use default allocator
+        result = CFArrayCreateMutable(kCFAllocatorSystemDefault, 0, &kCFTypeArrayCallBacks);
+
+        for (i=0; i<c; i++) {
+            factory = (_CFPFactory *)CFArrayGetValueAtIndex(array, i);
+            if (_CFPFactoryGetPlugIn(factory) == plugIn) {
+                CFArrayAppendValue(result, _CFPFactoryGetFactoryID(factory));
+            }
+        }
+    }
+    return result;
+}
+
+CF_EXPORT void *CFPlugInInstanceCreate(CFAllocatorRef allocator, CFUUIDRef factoryID, CFUUIDRef typeID) {
+    _CFPFactory *factory = _CFPFactoryFind(factoryID, true);
+    void *result = NULL;
+    if (!factory) {
+        /* MF:!!! No such factory. */
+        CFLog(__kCFLogPlugIn, CFSTR("Cannot find factory %@"), factoryID);
+    } else {
+        if (!_CFPFactorySupportsType(factory, typeID)) {
+            /* MF:!!! Factory does not support type. */
+            CFLog(__kCFLogPlugIn, CFSTR("Factory %@ does not support type %@"), factoryID, typeID);
+        } else {
+            result = _CFPFactoryCreateInstance(allocator, factory, typeID);
+        }
+    }
+    return result;
+}
+
+/* ===================== Registering factories and types ===================== */
+/* For plugIn writers who must dynamically register things. */
+/* Functions to register factory functions and to associate factories with types. */
+
+CF_EXPORT Boolean CFPlugInRegisterFactoryFunction(CFUUIDRef factoryID, CFPlugInFactoryFunction func) {
+    // Create factories without plugIns from default allocator
+    // MF:!!! Should probably check that this worked, and maybe do some pre-checking to see if it already exists
+    // _CFPFactory *factory =
+    (void)_CFPFactoryCreate(kCFAllocatorSystemDefault, factoryID, func);
+    return true;
+}
+
+CF_EXPORT Boolean CFPlugInRegisterFactoryFunctionByName(CFUUIDRef factoryID, CFPlugInRef plugIn, CFStringRef functionName) {
+    // Create factories with plugIns from plugIn's allocator
+    // MF:!!! Should probably check that this worked, and maybe do some pre-checking to see if it already exists
+    // _CFPFactory *factory =
+    (void)_CFPFactoryCreateByName(CFGetAllocator(plugIn), factoryID, plugIn, functionName);
+    return true;
+}
+
+CF_EXPORT Boolean CFPlugInUnregisterFactory(CFUUIDRef factoryID) {
+    _CFPFactory *factory = _CFPFactoryFind(factoryID, true);
+    
+    if (!factory) {
+        /* MF:!!! Error.  No factory registered for this ID. */
+    } else {
+        _CFPFactoryDisable(factory);
+    }
+    return true;
+}
+
+CF_EXPORT Boolean CFPlugInRegisterPlugInType(CFUUIDRef factoryID, CFUUIDRef typeID) {
+    _CFPFactory *factory = _CFPFactoryFind(factoryID, true);
+
+    if (!factory) {
+        /* MF:!!! Error.  Factory must be registered (and not disabled) before types can be associated with it. */
+    } else {
+        _CFPFactoryAddType(factory, typeID);
+    }
+    return true;
+}
+
+CF_EXPORT Boolean CFPlugInUnregisterPlugInType(CFUUIDRef factoryID, CFUUIDRef typeID) {
+    _CFPFactory *factory = _CFPFactoryFind(factoryID, true);
+
+    if (!factory) {
+        /* MF:!!! Error.  Could not find factory. */
+    } else {
+        _CFPFactoryRemoveType(factory, typeID);
+    }
+    return true;
+}
+
+
+/* ================= Registering instances ================= */
+/* When a new instance of a type is created, the instance is responsible for registering itself with the factory that created it and unregistering when it deallocates. */
+/* This means that an instance must keep track of the CFUUIDRef of the factory that created it so it can unregister when it goes away. */
+
+CF_EXPORT void CFPlugInAddInstanceForFactory(CFUUIDRef factoryID) {
+    _CFPFactory *factory = _CFPFactoryFind(factoryID, true);
+
+    if (!factory) {
+        /* MF:!!! Error.  Could not find factory. */
+    } else {
+        _CFPFactoryAddInstance(factory);
+    }
+}
+
+CF_EXPORT void CFPlugInRemoveInstanceForFactory(CFUUIDRef factoryID) {
+    _CFPFactory *factory = _CFPFactoryFind(factoryID, true);
+
+    if (!factory) {
+        /* MF:!!! Error.  Could not find factory. */
+    } else {
+        _CFPFactoryRemoveInstance(factory);
+    }
+}