Reviewed by Darin, landed by Anders.
[WebKit-https.git] / WebKit / mac / Plugins / WebBasePluginPackage.h
1 /*
2  * Copyright (C) 2005 Apple Computer, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #import <WebCore/WebCoreViewFactory.h>
30
31 #if USE(NPOBJECT)
32 #import <WebKit/npfunctions.h>
33 #else
34 typedef void (*BP_CreatePluginMIMETypesPreferencesFuncPtr)(void);
35 #endif
36
37 @class WebPluginDatabase;
38
39 @protocol WebPluginManualLoader
40 - (void)pluginView:(NSView *)pluginView receivedResponse:(NSURLResponse *)response;
41 - (void)pluginView:(NSView *)pluginView receivedData:(NSData *)data;
42 - (void)pluginView:(NSView *)pluginView receivedError:(NSError *)error;
43 - (void)pluginViewFinishedLoading:(NSView *)pluginView;
44 @end
45
46 #define WebPluginExtensionsKey          @"WebPluginExtensions"
47 #define WebPluginDescriptionKey         @"WebPluginDescription"
48 #define WebPluginLocalizationNameKey    @"WebPluginLocalizationName"
49 #define WebPluginMIMETypesFilenameKey   @"WebPluginMIMETypesFilename"
50 #define WebPluginMIMETypesKey           @"WebPluginMIMETypes"
51 #define WebPluginNameKey                @"WebPluginName"
52 #define WebPluginTypeDescriptionKey     @"WebPluginTypeDescription"
53 #define WebPluginTypeEnabledKey         @"WebPluginTypeEnabled"
54
55 @interface WebBasePluginPackage : NSObject <WebCorePluginInfo>
56 {
57     NSMutableSet *pluginDatabases;
58     
59     NSString *name;
60     NSString *path;
61     NSString *pluginDescription;
62
63     NSBundle *bundle;
64     CFBundleRef cfBundle;
65
66     NSDictionary *MIMEToDescription;
67     NSDictionary *MIMEToExtensions;
68     NSMutableDictionary *extensionToMIME;
69     
70     BP_CreatePluginMIMETypesPreferencesFuncPtr BP_CreatePluginMIMETypesPreferences;
71 }
72
73 + (WebBasePluginPackage *)pluginWithPath:(NSString *)pluginPath;
74 - (id)initWithPath:(NSString *)pluginPath;
75
76 - (BOOL)getPluginInfoFromPLists;
77
78 - (BOOL)load;
79
80 - (NSString *)name;
81 - (NSString *)path;
82 - (NSString *)filename;
83 - (NSString *)pluginDescription;
84 - (NSBundle *)bundle;
85
86 - (NSEnumerator *)extensionEnumerator;
87 - (NSEnumerator *)MIMETypeEnumerator;
88 - (NSString *)descriptionForMIMEType:(NSString *)MIMEType;
89 - (NSString *)MIMETypeForExtension:(NSString *)extension;
90 - (NSArray *)extensionsForMIMEType:(NSString *)MIMEType;
91
92 - (void)setName:(NSString *)theName;
93 - (void)setPath:(NSString *)thePath;
94 - (void)setPluginDescription:(NSString *)description;
95 - (void)setMIMEToDescriptionDictionary:(NSDictionary *)MIMEToDescriptionDictionary;
96 - (void)setMIMEToExtensionsDictionary:(NSDictionary *)MIMEToExtensionsDictionary;
97
98 - (BOOL)isQuickTimePlugIn;
99 - (BOOL)isJavaPlugIn;
100
101 - (BOOL)isNativeLibraryData:(NSData *)data;
102 - (UInt32)versionNumber;
103 - (void)wasAddedToPluginDatabase:(WebPluginDatabase *)database;
104 - (void)wasRemovedFromPluginDatabase:(WebPluginDatabase *)database;
105
106 @end