Reviewed by Darin.
[WebKit-https.git] / WebKitTools / DumpRenderTree / TestNetscapePlugIn.subproj / PluginObject.c
1 /*
2  IMPORTANT:  This Apple software is supplied to you by Apple Computer, Inc. ("Apple") in
3  consideration of your agreement to the following terms, and your use, installation, 
4  modification or redistribution of this Apple software constitutes acceptance of these 
5  terms.  If you do not agree with these terms, please do not use, install, modify or 
6  redistribute this Apple software.
7  
8  In consideration of your agreement to abide by the following terms, and subject to these 
9  terms, Apple grants you a personal, non-exclusive license, under Appleƕs copyrights in 
10  this original Apple software (the "Apple Software"), to use, reproduce, modify and 
11  redistribute the Apple Software, with or without modifications, in source and/or binary 
12  forms; provided that if you redistribute the Apple Software in its entirety and without 
13  modifications, you must retain this notice and the following text and disclaimers in all 
14  such redistributions of the Apple Software.  Neither the name, trademarks, service marks 
15  or logos of Apple Computer, Inc. may be used to endorse or promote products derived from 
16  the Apple Software without specific prior written permission from Apple. Except as expressly
17  stated in this notice, no other rights or licenses, express or implied, are granted by Apple
18  herein, including but not limited to any patent rights that may be infringed by your 
19  derivative works or by other works in which the Apple Software may be incorporated.
20  
21  The Apple Software is provided by Apple on an "AS IS" basis.  APPLE MAKES NO WARRANTIES, 
22  EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, 
23  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS 
24  USE AND OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
25  
26  IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL 
27  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 
28  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, 
29  REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND 
30  WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR 
31  OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 #import "PluginObject.h"
34
35 void pluginInvalidate ();
36 bool pluginHasProperty (NPClass *theClass, NPIdentifier name);
37 bool pluginHasMethod (NPClass *theClass, NPIdentifier name);
38 void pluginGetProperty (PluginObject *obj, NPIdentifier name, NPVariant *variant);
39 void pluginSetProperty (PluginObject *obj, NPIdentifier name, const NPVariant *variant);
40 void pluginInvoke (PluginObject *obj, NPIdentifier name, NPVariant *args, uint32_t argCount, NPVariant *result);
41 void pluginInvokeDefault (PluginObject *obj, NPVariant *args, uint32_t argCount, NPVariant *result);
42 NPObject *pluginAllocate (NPP npp, NPClass *theClass);
43 void pluginDeallocate (PluginObject *obj);
44
45 static NPClass _pluginFunctionPtrs = { 
46     NP_CLASS_STRUCT_VERSION,
47     (NPAllocateFunctionPtr) pluginAllocate, 
48     (NPDeallocateFunctionPtr) pluginDeallocate, 
49     (NPInvalidateFunctionPtr) pluginInvalidate,
50     (NPHasMethodFunctionPtr) pluginHasMethod,
51     (NPInvokeFunctionPtr) pluginInvoke,
52     (NPInvokeDefaultFunctionPtr) pluginInvokeDefault,
53     (NPHasPropertyFunctionPtr) pluginHasProperty,
54     (NPGetPropertyFunctionPtr) pluginGetProperty,
55     (NPSetPropertyFunctionPtr) pluginSetProperty,
56 };
57  
58 NPClass *getPluginClass(void)
59 {
60     return &_pluginFunctionPtrs;
61 }
62
63 static bool identifiersInitialized = false;
64
65 #define ID_PROPERTY_PROPERTY        0
66 #define NUM_PROPERTY_IDENTIFIERS    1
67
68 static NPIdentifier pluginPropertyIdentifiers[NUM_PROPERTY_IDENTIFIERS];
69 static const NPUTF8 *pluginPropertyIdentifierNames[NUM_PROPERTY_IDENTIFIERS] = {
70     "property"
71 };
72
73 #define ID_TEST_CALLBACK_METHOD     0
74 #define ID_TEST_GETURL              1
75 #define NUM_METHOD_IDENTIFIERS      2
76
77 static NPIdentifier pluginMethodIdentifiers[NUM_METHOD_IDENTIFIERS];
78 static const NPUTF8 *pluginMethodIdentifierNames[NUM_METHOD_IDENTIFIERS] = {
79     "testCallback",
80     "getURL"
81 };
82
83 static void initializeIdentifiers()
84 {
85     browser->getstringidentifiers (pluginPropertyIdentifierNames, NUM_PROPERTY_IDENTIFIERS, pluginPropertyIdentifiers);
86     browser->getstringidentifiers (pluginMethodIdentifierNames, NUM_METHOD_IDENTIFIERS, pluginMethodIdentifiers);
87 };
88
89 bool pluginHasProperty (NPClass *theClass, NPIdentifier name)
90 {
91     for (int i = 0; i < NUM_PROPERTY_IDENTIFIERS; i++) {
92         if (name == pluginPropertyIdentifiers[i])
93             return true;
94     }
95     return false;
96 }
97
98 bool pluginHasMethod (NPClass *theClass, NPIdentifier name)
99 {
100     for (int i = 0; i < NUM_METHOD_IDENTIFIERS; i++) {
101         if (name == pluginMethodIdentifiers[i])
102             return true;
103     }
104     return false;
105 }
106
107 void pluginGetProperty (PluginObject *obj, NPIdentifier name, NPVariant *variant)
108 {
109     if (name == pluginPropertyIdentifiers[ID_PROPERTY_PROPERTY]) {
110         // just return "property"
111         NPString propertyNameString;
112         propertyNameString.UTF8Characters = "property";
113         propertyNameString.UTF8Length = sizeof("property") - 1;
114         variant->type = NPVariantType_String;
115         variant->value.stringValue = propertyNameString;
116     } else
117         variant->type = NPVariantType_Void;
118 }
119
120 void pluginSetProperty (PluginObject *obj, NPIdentifier name, const NPVariant *variant)
121 {
122 }
123
124 void pluginInvoke (PluginObject *obj, NPIdentifier name, NPVariant *args, unsigned argCount, NPVariant *result)
125 {
126     if (name == pluginMethodIdentifiers[ID_TEST_CALLBACK_METHOD]) {
127         // call whatever method name we're given
128         if (argCount > 0 && args->type == NPVariantType_String) {
129             NPVariant browserResult;
130             
131             NPObject *windowScriptObject;
132             browser->getvalue(obj->npp, NPPVpluginScriptableNPObject, &windowScriptObject);
133
134             NPString argString = args[0].value.stringValue;
135             int size = argString.UTF8Length + 1;
136             NPUTF8 callbackString[size];
137             strncpy(callbackString, argString.UTF8Characters, argString.UTF8Length);
138             callbackString[size - 1] = '\0';
139
140             NPIdentifier callbackMethodID = browser->getstringidentifier(callbackString);
141             browser->invoke(obj->npp, windowScriptObject, callbackMethodID, 0, 0, &browserResult);
142         }
143     } else if (name == pluginMethodIdentifiers[ID_TEST_GETURL]) {
144         if (argCount == 2 && args[0].type == NPVariantType_String && args[1].type == NPVariantType_String) {
145             NPString argString = args[0].value.stringValue;
146             int size = argString.UTF8Length + 1;
147             NPUTF8 urlString[size];
148             strncpy(urlString, argString.UTF8Characters, argString.UTF8Length);
149             urlString[size - 1] = '\0';
150
151             argString = args[1].value.stringValue;
152             size = argString.UTF8Length + 1;
153             NPUTF8 targetString[size];
154             strncpy(targetString, argString.UTF8Characters, argString.UTF8Length);
155             targetString[size - 1] = '\0';
156             
157             browser->geturl(obj->npp, urlString, targetString);
158         }
159     }
160
161
162     result->type = NPVariantType_Void;
163 }
164
165 void pluginInvokeDefault (PluginObject *obj, NPVariant *args, unsigned argCount, NPVariant *result)
166 {
167     result->type = NPVariantType_Void;
168 }
169
170 void pluginInvalidate ()
171 {
172     // Make sure we've released any remainging references to JavaScript
173     // objects.
174 }
175
176 NPObject *pluginAllocate (NPP npp, NPClass *theClass)
177 {
178     PluginObject *newInstance = (PluginObject *)malloc (sizeof(PluginObject));
179     
180     if (!identifiersInitialized) {
181         identifiersInitialized = true;
182         initializeIdentifiers();
183     }
184
185     newInstance->npp = npp;
186     
187     return (NPObject *)newInstance;
188 }
189
190 void pluginDeallocate (PluginObject *obj) 
191 {
192     free ((void *)obj);
193 }
194