Always enable ENABLE(XPATH)
[WebKit-https.git] / Source / WebCore / dom / ExceptionCode.cpp
1 /*
2  *  Copyright (C) 2006, 2007 Apple 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27 #include "ExceptionCode.h"
28
29 #include "EventException.h"
30 #include "IDBDatabaseException.h"
31 #include "RangeException.h"
32 #include "XMLHttpRequestException.h"
33 #include "XPathException.h"
34
35 #if ENABLE(SVG)
36 #include "SVGException.h"
37 #endif
38
39 #if ENABLE(SQL_DATABASE)
40 #include "SQLException.h"
41 #endif
42
43 #if ENABLE(BLOB) || ENABLE(FILE_SYSTEM)
44 #include "FileException.h"
45 #include "OperationNotAllowedException.h"
46 #endif
47
48 namespace WebCore {
49
50 static const char* const exceptionNames[] = {
51     "INDEX_SIZE_ERR",
52     "DOMSTRING_SIZE_ERR",
53     "HIERARCHY_REQUEST_ERR",
54     "WRONG_DOCUMENT_ERR",
55     "INVALID_CHARACTER_ERR",
56     "NO_DATA_ALLOWED_ERR",
57     "NO_MODIFICATION_ALLOWED_ERR",
58     "NOT_FOUND_ERR",
59     "NOT_SUPPORTED_ERR",
60     "INUSE_ATTRIBUTE_ERR",
61     "INVALID_STATE_ERR",
62     "SYNTAX_ERR",
63     "INVALID_MODIFICATION_ERR",
64     "NAMESPACE_ERR",
65     "INVALID_ACCESS_ERR",
66     "VALIDATION_ERR",
67     "TYPE_MISMATCH_ERR",
68     "SECURITY_ERR",
69     "NETWORK_ERR",
70     "ABORT_ERR",
71     "URL_MISMATCH_ERR",
72     "QUOTA_EXCEEDED_ERR",
73     "TIMEOUT_ERR",
74     "INVALID_NODE_TYPE_ERR",
75     "DATA_CLONE_ERR"
76 };
77
78 static const char* const exceptionDescriptions[] = {
79     "Index or size was negative, or greater than the allowed value.",
80     "The specified range of text did not fit into a DOMString.",
81     "A Node was inserted somewhere it doesn't belong.",
82     "A Node was used in a different document than the one that created it (that doesn't support it).",
83     "An invalid or illegal character was specified, such as in an XML name.",
84     "Data was specified for a Node which does not support data.",
85     "An attempt was made to modify an object where modifications are not allowed.",
86     "An attempt was made to reference a Node in a context where it does not exist.",
87     "The implementation did not support the requested type of object or operation.",
88     "An attempt was made to add an attribute that is already in use elsewhere.",
89     "An attempt was made to use an object that is not, or is no longer, usable.",
90     "An invalid or illegal string was specified.",
91     "An attempt was made to modify the type of the underlying object.",
92     "An attempt was made to create or change an object in a way which is incorrect with regard to namespaces.",
93     "A parameter or an operation was not supported by the underlying object.",
94     "A call to a method such as insertBefore or removeChild would make the Node invalid with respect to \"partial validity\", this exception would be raised and the operation would not be done.",
95     "The type of an object was incompatible with the expected type of the parameter associated to the object.",
96     "An attempt was made to break through the security policy of the user agent.",
97     // FIXME: Couldn't find a description in the HTML/DOM specifications for NETWORK_ERR, ABORT_ERR, URL_MISMATCH_ERR, and QUOTA_EXCEEDED_ERR
98     "A network error occured.",
99     "The user aborted a request.",
100     "A worker global scope represented an absolute URL that is not equal to the resulting absolute URL.",
101     "An attempt was made to add something to storage that exceeded the quota.",
102     "A timeout occurred.",
103     "The supplied node is invalid or has an invalid ancestor for this operation.",
104     "An object could not be cloned."
105 };
106
107 static const char* const rangeExceptionNames[] = {
108     "BAD_BOUNDARYPOINTS_ERR",
109     "INVALID_NODE_TYPE_ERR"
110 };
111
112 static const char* const rangeExceptionDescriptions[] = {
113     "The boundary-points of a Range did not meet specific requirements.",
114     "The container of an boundary-point of a Range was being set to either a node of an invalid type or a node with an ancestor of an invalid type."
115 };
116
117 static const char* const eventExceptionNames[] = {
118     "UNSPECIFIED_EVENT_TYPE_ERR",
119     "DISPATCH_REQUEST_ERR"
120 };
121
122 static const char* const eventExceptionDescriptions[] = {
123     "The Event's type was not specified by initializing the event before the method was called.",
124     "The Event object is already being dispatched."
125 };
126
127 static const char* const xmlHttpRequestExceptionNames[] = {
128     "NETWORK_ERR",
129     "ABORT_ERR"
130 };
131
132 static const char* const xmlHttpRequestExceptionDescriptions[] = {
133     "A network error occured in synchronous requests.",
134     "The user aborted a request in synchronous requests."
135 };
136
137 static const char* const xpathExceptionNames[] = {
138     "INVALID_EXPRESSION_ERR",
139     "TYPE_ERR"
140 };
141
142 static const char* const xpathExceptionDescriptions[] = {
143     "The expression had a syntax error or otherwise is not a legal expression according to the rules of the specific XPathEvaluator.",
144     "The expression could not be converted to return the specified type."
145 };
146
147 #if ENABLE(SVG)
148 static const char* const svgExceptionNames[] = {
149     "SVG_WRONG_TYPE_ERR",
150     "SVG_INVALID_VALUE_ERR",
151     "SVG_MATRIX_NOT_INVERTABLE"
152 };
153
154 static const char* const svgExceptionDescriptions[] = {
155     "An object of the wrong type was passed to an operation.",
156     "An invalid value was passed to an operation or assigned to an attribute.",
157     "An attempt was made to invert a matrix that is not invertible."
158 };
159 #endif
160
161 #if ENABLE(SQL_DATABASE)
162 static const char* const sqlExceptionNames[] = {
163     "UNKNOWN_ERR",
164     "DATABASE_ERR",
165     "VERSION_ERR",
166     "TOO_LARGE_ERR",
167     "QUOTA_ERR",
168     "SYNTAX_ERR",
169     "CONSTRAINT_ERR",
170     "TIMEOUT_ERR"
171 };
172
173 static const char* const sqlExceptionDescriptions[] = {
174     "The operation failed for reasons unrelated to the database.",
175     "The operation failed for some reason related to the database.",
176     "The actual database version did not match the expected version.",
177     "Data returned from the database is too large.",
178     "Quota was exceeded.",
179     "Invalid or unauthorized statement; or the number of arguments did not match the number of ? placeholders.",
180     "A constraint was violated.",
181     "A transaction lock could not be acquired in a reasonable time."
182 };
183 #endif
184
185 #if ENABLE(BLOB) || ENABLE(FILE_SYSTEM)
186 static const char* const fileExceptionNames[] = {
187     "NOT_FOUND_ERR",
188     "SECURITY_ERR",
189     "ABORT_ERR",
190     "NOT_READABLE_ERR",
191     "ENCODING_ERR",
192     "NO_MODIFICATION_ALLOWED_ERR",
193     "INVALID_STATE_ERR",
194     "SYNTAX_ERR",
195     "INVALID_MODIFICATION_ERR",
196     "QUOTA_EXCEEDED_ERR",
197     "TYPE_MISMATCH_ERR",
198     "PATH_EXISTS_ERR"
199 };
200
201 static const char* const fileExceptionDescriptions[] = {
202     "A requested file or directory could not be found at the time an operation was processed.",
203     "It was determined that certain files are unsafe for access within a Web application, or that too many calls are being made on file resources.",
204     "An ongoing operation was aborted, typically with a call to abort().",
205     "The requested file could not be read, typically due to permission problems that have occured after a reference to a file was acquired.",
206     "A URI supplied to the API was malformed, or the resulting Data URL has exceeded the URL length limitations for Data URLs.",
207     "An attempt was made to write to a file or directory which could not be modified due to the state of the underlying filesystem.",
208     "An operation that depends on state cached in an interface object was made but the state had changed since it was read from disk.",
209     "An invalid or unsupported argument was given, like an invalid line ending specifier.",
210     "The modification request was illegal.",
211     "The operation failed because it would cause the application to exceed its storage quota.",
212     "The path supplied exists, but was not an entry of requested type.",
213     "An attempt was made to create a file or directory where an element already exists."
214 };
215
216 static const char* const operationNotAllowedExceptionNames[] = {
217     "NOT_ALLOWED_ERR"
218 };
219
220 static const char* const operationNotAllowedExceptionDescriptions[] = {
221     "A read method was called while the object was in the LOADING state due to a previous read call."
222 };
223 #endif
224
225 #if ENABLE(INDEXED_DATABASE)
226 static const char* const idbDatabaseExceptionNames[] = {
227     "UNKNOWN_ERR",
228     "NON_TRANSIENT_ERR",
229     "NOT_FOUND_ERR",
230     "CONSTRAINT_ERR",
231     "DATA_ERR",
232     "NOT_ALLOWED_ERR",
233     "SERIAL_ERR",
234     "RECOVERABLE_ERR",
235     "TRANSIENT_ERR",
236     "TIMEOUT_ERR",
237     "DEADLOCK_ERR",
238     "READ_ONLY_ERR",
239     "ABORT_ERR"
240 };
241
242 static const char* const idbDatabaseExceptionDescriptions[] = {
243     "An unknown error occurred within Indexed Database.",
244     "NON_TRANSIENT_ERR", // FIXME: Write a better message if it's ever possible this is thrown.
245     "The name supplied does not match any existing item.",
246     "The request cannot be completed due to a failed constraint.",
247     "The data provided does not meet the requirements of the function.",
248     "This function is not allowed to be called in such a context.",
249     "The data supplied cannot be serialized according to the structured cloning algorithm.",
250     "RECOVERABLE_ERR", // FIXME: This isn't even used.
251     "TRANSIENT_ERR", // FIXME: This isn't even used.
252     "TIMEOUT_ERR", // This can't be thrown.
253     "DEADLOCK_ERR", // This can't be thrown.
254     "Write operations cannot be preformed on a read-only transaction.",
255     "The transaction was aborted, so the request cannot be fulfilled."
256 };
257 #endif
258
259 void getExceptionCodeDescription(ExceptionCode ec, ExceptionCodeDescription& description)
260 {
261     ASSERT(ec);
262
263     const char* typeName;
264     int code = ec;
265     const char* const* nameTable;
266     const char* const* descriptionTable;
267     int nameTableSize;
268     int nameTableOffset;
269     ExceptionType type;
270
271     if (code >= RangeException::RangeExceptionOffset && code <= RangeException::RangeExceptionMax) {
272         type = RangeExceptionType;
273         typeName = "DOM Range";
274         code -= RangeException::RangeExceptionOffset;
275         nameTable = rangeExceptionNames;
276         descriptionTable = rangeExceptionDescriptions;
277         nameTableSize = WTF_ARRAY_LENGTH(rangeExceptionNames);
278         nameTableOffset = RangeException::BAD_BOUNDARYPOINTS_ERR;
279     } else if (code >= EventException::EventExceptionOffset && code <= EventException::EventExceptionMax) {
280         type = EventExceptionType;
281         typeName = "DOM Events";
282         code -= EventException::EventExceptionOffset;
283         nameTable = eventExceptionNames;
284         descriptionTable = eventExceptionDescriptions;
285         nameTableSize = WTF_ARRAY_LENGTH(eventExceptionNames);
286         nameTableOffset = EventException::UNSPECIFIED_EVENT_TYPE_ERR;
287     } else if (code >= XMLHttpRequestException::XMLHttpRequestExceptionOffset && code <= XMLHttpRequestException::XMLHttpRequestExceptionMax) {
288         type = XMLHttpRequestExceptionType;
289         typeName = "XMLHttpRequest";
290         code -= XMLHttpRequestException::XMLHttpRequestExceptionOffset;
291         nameTable = xmlHttpRequestExceptionNames;
292         descriptionTable = xmlHttpRequestExceptionDescriptions;
293         nameTableSize = WTF_ARRAY_LENGTH(xmlHttpRequestExceptionNames);
294         // XMLHttpRequest exception codes start with 101 and we don't want 100 empty elements in the name array
295         nameTableOffset = XMLHttpRequestException::NETWORK_ERR;
296     } else if (code >= XPathException::XPathExceptionOffset && code <= XPathException::XPathExceptionMax) {
297         type = XPathExceptionType;
298         typeName = "DOM XPath";
299         code -= XPathException::XPathExceptionOffset;
300         nameTable = xpathExceptionNames;
301         descriptionTable = xpathExceptionDescriptions;
302         nameTableSize = WTF_ARRAY_LENGTH(xpathExceptionNames);
303         // XPath exception codes start with 51 and we don't want 51 empty elements in the name array
304         nameTableOffset = XPathException::INVALID_EXPRESSION_ERR;
305 #if ENABLE(SVG)
306     } else if (code >= SVGException::SVGExceptionOffset && code <= SVGException::SVGExceptionMax) {
307         type = SVGExceptionType;
308         typeName = "DOM SVG";
309         code -= SVGException::SVGExceptionOffset;
310         nameTable = svgExceptionNames;
311         descriptionTable = svgExceptionDescriptions;
312         nameTableSize = WTF_ARRAY_LENGTH(svgExceptionNames);
313         nameTableOffset = SVGException::SVG_WRONG_TYPE_ERR;
314 #endif
315 #if ENABLE(SQL_DATABASE)
316     } else if (code >= SQLException::SQLExceptionOffset && code <= SQLException::SQLExceptionMax) {
317         type = SQLExceptionType;
318         typeName = "DOM SQL";
319         code -= SQLException::SQLExceptionOffset;
320         nameTable = sqlExceptionNames;
321         descriptionTable = sqlExceptionDescriptions;
322         nameTableSize = WTF_ARRAY_LENGTH(sqlExceptionNames);
323         nameTableOffset = SQLException::UNKNOWN_ERR;
324 #endif
325 #if ENABLE(BLOB) || ENABLE(FILE_SYSTEM)
326     } else if (code >= FileException::FileExceptionOffset && code <= FileException::FileExceptionMax) {
327         type = FileExceptionType;
328         typeName = "DOM File";
329         code -= FileException::FileExceptionOffset;
330         nameTable = fileExceptionNames;
331         descriptionTable = fileExceptionDescriptions;
332         nameTableSize = WTF_ARRAY_LENGTH(fileExceptionNames);
333         nameTableOffset = FileException::NOT_FOUND_ERR;
334     } else if (code >= OperationNotAllowedException::OperationNotAllowedExceptionOffset && code <= OperationNotAllowedException::OperationNotAllowedExceptionMax) {
335         type = OperationNotAllowedExceptionType;
336         typeName = "DOM OperationNotAllowed";
337         code -= OperationNotAllowedException::OperationNotAllowedExceptionOffset;
338         nameTable = operationNotAllowedExceptionNames;
339         descriptionTable = operationNotAllowedExceptionDescriptions;
340         nameTableSize = WTF_ARRAY_LENGTH(operationNotAllowedExceptionNames);
341         nameTableOffset = OperationNotAllowedException::NOT_ALLOWED_ERR;
342 #endif
343 #if ENABLE(INDEXED_DATABASE)
344     } else if (code >= IDBDatabaseException::IDBDatabaseExceptionOffset && code <= IDBDatabaseException::IDBDatabaseExceptionMax) {
345         type = IDBDatabaseExceptionType;
346         typeName = "DOM IDBDatabase";
347         code -= IDBDatabaseException::IDBDatabaseExceptionOffset;
348         nameTable = idbDatabaseExceptionNames;
349         descriptionTable = idbDatabaseExceptionDescriptions;
350         nameTableSize = WTF_ARRAY_LENGTH(idbDatabaseExceptionNames);
351         nameTableOffset = IDBDatabaseException::UNKNOWN_ERR;
352 #endif
353     } else {
354         type = DOMExceptionType;
355         typeName = "DOM";
356         nameTable = exceptionNames;
357         descriptionTable = exceptionDescriptions;
358         nameTableSize = WTF_ARRAY_LENGTH(exceptionNames);
359         nameTableOffset = INDEX_SIZE_ERR;
360     }
361
362     description.typeName = typeName;
363     description.name = (ec >= nameTableOffset && ec - nameTableOffset < nameTableSize) ? nameTable[ec - nameTableOffset] : 0;
364     description.description = (ec >= nameTableOffset && ec - nameTableOffset < nameTableSize) ? descriptionTable[ec - nameTableOffset] : 0;
365     description.code = code;
366     description.type = type;
367
368     // All exceptions used in the DOM code should have names.
369     ASSERT(description.name);
370     ASSERT(description.description);
371 }
372
373 } // namespace WebCore