Reviewed by Maciej.
[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
34 #import "PluginObject.h"
35
36 static void pluginInvalidate(NPObject *obj);
37 static bool pluginHasProperty(NPObject *obj, NPIdentifier name);
38 static bool pluginHasMethod(NPObject *obj, NPIdentifier name);
39 static bool pluginGetProperty(NPObject *obj, NPIdentifier name, NPVariant *variant);
40 static bool pluginSetProperty(NPObject *obj, NPIdentifier name, const NPVariant *variant);
41 static bool pluginInvoke(NPObject *obj, NPIdentifier name, const NPVariant *args, uint32_t argCount, NPVariant *result);
42 static bool pluginInvokeDefault(NPObject *obj, const NPVariant *args, uint32_t argCount, NPVariant *result);
43 static NPObject *pluginAllocate(NPP npp, NPClass *theClass);
44 static void pluginDeallocate(NPObject *obj);
45
46 NPNetscapeFuncs *browser;
47
48 static NPClass pluginClass = { 
49     NP_CLASS_STRUCT_VERSION,
50     pluginAllocate, 
51     pluginDeallocate, 
52     pluginInvalidate,
53     pluginHasMethod,
54     pluginInvoke,
55     pluginInvokeDefault,
56     pluginHasProperty,
57     pluginGetProperty,
58     pluginSetProperty,
59 };
60  
61 NPClass *getPluginClass(void)
62 {
63     return &pluginClass;
64 }
65
66 static bool identifiersInitialized = false;
67
68 #define ID_PROPERTY_PROPERTY        0
69 #define ID_PROPERTY_EVENT_LOGGING   1
70 #define NUM_PROPERTY_IDENTIFIERS    2
71
72 static NPIdentifier pluginPropertyIdentifiers[NUM_PROPERTY_IDENTIFIERS];
73 static const NPUTF8 *pluginPropertyIdentifierNames[NUM_PROPERTY_IDENTIFIERS] = {
74     "property",
75     "eventLoggingEnabled"
76 };
77
78 #define ID_TEST_CALLBACK_METHOD     0
79 #define ID_TEST_GETURL              1
80 #define ID_REMOVE_DEFAULT_METHOD    2
81 #define ID_TEST_DOM_ACCESS          3
82
83 #define NUM_METHOD_IDENTIFIERS      4
84
85 static NPIdentifier pluginMethodIdentifiers[NUM_METHOD_IDENTIFIERS];
86 static const NPUTF8 *pluginMethodIdentifierNames[NUM_METHOD_IDENTIFIERS] = {
87     "testCallback",
88     "getURL",
89     "removeDefaultMethod",
90     "testDOMAccess"
91 };
92
93 static NPUTF8* createCStringFromNPVariant(const NPVariant *variant)
94 {
95     size_t length = NPVARIANT_TO_STRING(*variant).UTF8Length;
96     NPUTF8* result = malloc(length + 1);
97     memcpy(result, NPVARIANT_TO_STRING(*variant).UTF8Characters, length);
98     result[length] = '\0';
99     return result;
100 }
101
102 static void initializeIdentifiers(void)
103 {
104     browser->getstringidentifiers(pluginPropertyIdentifierNames, NUM_PROPERTY_IDENTIFIERS, pluginPropertyIdentifiers);
105     browser->getstringidentifiers(pluginMethodIdentifierNames, NUM_METHOD_IDENTIFIERS, pluginMethodIdentifiers);
106 }
107
108 static bool pluginHasProperty(NPObject *obj, NPIdentifier name)
109 {
110     for (int i = 0; i < NUM_PROPERTY_IDENTIFIERS; i++)
111         if (name == pluginPropertyIdentifiers[i])
112             return true;
113     return false;
114 }
115
116 static bool pluginHasMethod(NPObject *obj, NPIdentifier name)
117 {
118     for (int i = 0; i < NUM_METHOD_IDENTIFIERS; i++)
119         if (name == pluginMethodIdentifiers[i])
120             return true;
121     return false;
122 }
123
124 static bool pluginGetProperty(NPObject *obj, NPIdentifier name, NPVariant *variant)
125 {
126     if (name == pluginPropertyIdentifiers[ID_PROPERTY_PROPERTY]) {
127         STRINGZ_TO_NPVARIANT("property", *variant);
128         return true;
129     } else if (name == pluginPropertyIdentifiers[ID_PROPERTY_EVENT_LOGGING]) {
130         BOOLEAN_TO_NPVARIANT(((PluginObject *)obj)->eventLogging, *variant);
131         return true;
132     }
133     return false;
134 }
135
136 static bool pluginSetProperty(NPObject *obj, NPIdentifier name, const NPVariant *variant)
137 {
138     if (name == pluginPropertyIdentifiers[ID_PROPERTY_EVENT_LOGGING]) {
139         ((PluginObject *)obj)->eventLogging = NPVARIANT_TO_BOOLEAN(*variant);
140         return true;
141     }
142     return false;
143 }
144
145 static void testDOMAccess(PluginObject *obj)
146 {
147     // Get plug-in's DOM element
148     NPObject *elementObject;
149     if (browser->getvalue(obj->npp, NPNVPluginElementNPObject, &elementObject) == NPERR_NO_ERROR) {
150         // Get style
151         NPVariant styleVariant;
152         NPIdentifier styleIdentifier = browser->getstringidentifier("style");
153         if (browser->getproperty(obj->npp, elementObject, styleIdentifier, &styleVariant) && NPVARIANT_IS_OBJECT(styleVariant)) {
154             // Set style.border
155             NPIdentifier borderIdentifier = browser->getstringidentifier("border");
156             NPVariant borderVariant;
157             STRINGZ_TO_NPVARIANT("3px solid red", borderVariant);
158             browser->setproperty(obj->npp, NPVARIANT_TO_OBJECT(styleVariant), borderIdentifier, &borderVariant);
159             browser->releasevariantvalue(&styleVariant);
160         }
161         
162         browser->releaseobject(elementObject);
163     }
164 }
165
166 static bool pluginInvoke(NPObject *header, NPIdentifier name, const NPVariant *args, uint32_t argCount, NPVariant *result)
167 {
168     PluginObject *obj = (PluginObject *)header;
169     if (name == pluginMethodIdentifiers[ID_TEST_CALLBACK_METHOD]) {
170         // call whatever method name we're given
171         if (argCount > 0 && NPVARIANT_IS_STRING(args[0])) {
172             NPObject *windowScriptObject;
173             browser->getvalue(obj->npp, NPPVpluginScriptableNPObject, &windowScriptObject);
174
175             NPUTF8* callbackString = createCStringFromNPVariant(&args[0]);
176             NPIdentifier callbackIdentifier = browser->getstringidentifier(callbackString);
177             free(callbackString);
178
179             NPVariant browserResult;
180             browser->invoke(obj->npp, windowScriptObject, callbackIdentifier, 0, 0, &browserResult);
181             browser->releasevariantvalue(&browserResult);
182
183             VOID_TO_NPVARIANT(*result);
184             return true;
185         }
186     } else if (name == pluginMethodIdentifiers[ID_TEST_GETURL]) {
187         if (argCount == 2 && NPVARIANT_IS_STRING(args[0]) && NPVARIANT_IS_STRING(args[1])) {
188             NPUTF8* urlString = createCStringFromNPVariant(&args[0]);
189             NPUTF8* targetString = createCStringFromNPVariant(&args[1]);
190             browser->geturl(obj->npp, urlString, targetString);
191             free(urlString);
192             free(targetString);
193
194             VOID_TO_NPVARIANT(*result);
195             return true;
196         } else if (argCount == 1 && NPVARIANT_IS_STRING(args[0])) {
197             NPUTF8* urlString = createCStringFromNPVariant(&args[0]);
198             browser->geturl(obj->npp, urlString, 0);
199             free(urlString);
200
201             VOID_TO_NPVARIANT(*result);
202             return true;
203         }
204     } else if (name == pluginMethodIdentifiers[ID_REMOVE_DEFAULT_METHOD]) {
205         pluginClass.invokeDefault = 0;
206         VOID_TO_NPVARIANT(*result);
207         return true;
208     } else if (name == pluginMethodIdentifiers[ID_TEST_DOM_ACCESS]) {
209         testDOMAccess(obj);
210         VOID_TO_NPVARIANT(*result);
211         return true;
212     }
213
214     return false;
215 }
216
217 static bool pluginInvokeDefault(NPObject *obj, const NPVariant *args, uint32_t argCount, NPVariant *result)
218 {
219     INT32_TO_NPVARIANT(1, *result);
220     return true;
221 }
222
223 static void pluginInvalidate(NPObject *obj)
224 {
225 }
226
227 static NPObject *pluginAllocate(NPP npp, NPClass *theClass)
228 {
229     PluginObject *newInstance = malloc(sizeof(PluginObject));
230     
231     if (!identifiersInitialized) {
232         identifiersInitialized = true;
233         initializeIdentifiers();
234     }
235
236     newInstance->npp = npp;
237     
238     newInstance->eventLogging = FALSE;
239     
240     return (NPObject *)newInstance;
241 }
242
243 static void pluginDeallocate(NPObject *obj) 
244 {
245     free(obj);
246 }