runtime/ExceptionHelpers.cpp

   1 /*
   2  * Copyright (C) 2008, 2009 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  *
   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 #include "config.h"
  30 #include "ExceptionHelpers.h"
  31
  32 #include "CodeBlock.h"
  33 #include "CallFrame.h"
  34 #include "JSGlobalObjectFunctions.h"
  35 #include "JSObject.h"
  36 #include "JSNotAnObject.h"
  37 #include "Interpreter.h"
  38 #include "Nodes.h"
  39
  40 namespace JSC {
  41
  42 class InterruptedExecutionError : public JSObject {
  43 public:
  44     InterruptedExecutionError(JSGlobalData* globalData)
  45         : JSObject(globalData->interruptedExecutionErrorStructure)
  46     {
  47     }
  48
  49     virtual bool isWatchdogException() const { return true; }
  50
  51     virtual UString toString(ExecState*) const { return "JavaScript execution exceeded timeout."; }
  52 };
  53
  54 JSValuePtr createInterruptedExecutionException(JSGlobalData* globalData)
  55 {
  56     return new (globalData) InterruptedExecutionError(globalData);
  57 }
  58
  59 static JSValuePtr createError(ExecState* exec, ErrorType e, const char* msg)
  60 {
  61     return Error::create(exec, e, msg, -1, -1, 0);
  62 }
  63
  64 JSValuePtr createStackOverflowError(ExecState* exec)
  65 {
  66     return createError(exec, RangeError, "Maximum call stack size exceeded.");
  67 }
  68
  69 JSValuePtr createUndefinedVariableError(ExecState* exec, const Identifier& ident, unsigned bytecodeOffset, CodeBlock* codeBlock)
  70 {
  71     int startOffset = 0;
  72     int endOffset = 0;
  73     int divotPoint = 0;
  74     int line = codeBlock->expressionRangeForBytecodeOffset(exec, bytecodeOffset, divotPoint, startOffset, endOffset);
  75     UString message = "Can't find variable: ";
  76     message.append(ident.ustring());
  77     JSObject* exception = Error::create(exec, ReferenceError, message, line, codeBlock->ownerNode()->sourceID(), codeBlock->ownerNode()->sourceURL());
  78     exception->putWithAttributes(exec, Identifier(exec, expressionBeginOffsetPropertyName), jsNumber(exec, divotPoint - startOffset), ReadOnly | DontDelete);
  79     exception->putWithAttributes(exec, Identifier(exec, expressionCaretOffsetPropertyName), jsNumber(exec, divotPoint), ReadOnly | DontDelete);
  80     exception->putWithAttributes(exec, Identifier(exec, expressionEndOffsetPropertyName), jsNumber(exec, divotPoint + endOffset), ReadOnly | DontDelete);
  81     return exception;
  82 }
  83
  84 static UString createErrorMessage(ExecState* exec, CodeBlock* codeBlock, int, int expressionStart, int expressionStop, JSValuePtr value, UString error)
  85 {
  86     if (!expressionStop || expressionStart > codeBlock->source()->length()) {
  87         UString errorText = value.toString(exec);
  88         errorText.append(" is ");
  89         errorText.append(error);
  90         return errorText;
  91     }
  92
  93     UString errorText = "Result of expression ";
  94
  95     if (expressionStart < expressionStop) {
  96         errorText.append('\'');
  97         errorText.append(codeBlock->source()->getRange(expressionStart, expressionStop));
  98         errorText.append("' [");
  99         errorText.append(value.toString(exec));
 100         errorText.append("] is ");
 101     } else {
 102         // No range information, so give a few characters of context
 103         const UChar* data = codeBlock->source()->data();
 104         int dataLength = codeBlock->source()->length();
 105         int start = expressionStart;
 106         int stop = expressionStart;
 107         // Get up to 20 characters of context to the left and right of the divot, clamping to the line.
 108         // then strip whitespace.
 109         while (start > 0 && (expressionStart - start < 20) && data[start - 1] != '\n')
 110             start--;
 111         while (start < (expressionStart - 1) && isStrWhiteSpace(data[start]))
 112             start++;
 113         while (stop < dataLength && (stop - expressionStart < 20) && data[stop] != '\n')
 114             stop++;
 115         while (stop > expressionStart && isStrWhiteSpace(data[stop]))
 116             stop--;
 117         errorText.append("near '...");
 118         errorText.append(codeBlock->source()->getRange(start, stop));
 119         errorText.append("...' [");
 120         errorText.append(value.toString(exec));
 121         errorText.append("] is ");
 122     }
 123     errorText.append(error);
 124     errorText.append(".");
 125     return errorText;
 126 }
 127
 128 JSObject* createInvalidParamError(ExecState* exec, const char* op, JSValuePtr value, unsigned bytecodeOffset, CodeBlock* codeBlock)
 129 {
 130     UString message = "not a valid argument for '";
 131     message.append(op);
 132     message.append("'");
 133
 134     int startOffset = 0;
 135     int endOffset = 0;
 136     int divotPoint = 0;
 137     int line = codeBlock->expressionRangeForBytecodeOffset(exec, bytecodeOffset, divotPoint, startOffset, endOffset);
 138     UString errorMessage = createErrorMessage(exec, codeBlock, line, divotPoint, divotPoint + endOffset, value, message);
 139     JSObject* exception = Error::create(exec, TypeError, errorMessage, line, codeBlock->ownerNode()->sourceID(), codeBlock->ownerNode()->sourceURL());
 140     exception->putWithAttributes(exec, Identifier(exec, expressionBeginOffsetPropertyName), jsNumber(exec, divotPoint - startOffset), ReadOnly | DontDelete);
 141     exception->putWithAttributes(exec, Identifier(exec, expressionCaretOffsetPropertyName), jsNumber(exec, divotPoint), ReadOnly | DontDelete);
 142     exception->putWithAttributes(exec, Identifier(exec, expressionEndOffsetPropertyName), jsNumber(exec, divotPoint + endOffset), ReadOnly | DontDelete);
 143     return exception;
 144 }
 145
 146 JSObject* createNotAConstructorError(ExecState* exec, JSValuePtr value, unsigned bytecodeOffset, CodeBlock* codeBlock)
 147 {
 148     int startOffset = 0;
 149     int endOffset = 0;
 150     int divotPoint = 0;
 151     int line = codeBlock->expressionRangeForBytecodeOffset(exec, bytecodeOffset, divotPoint, startOffset, endOffset);
 152
 153     // We're in a "new" expression, so we need to skip over the "new.." part
 154     int startPoint = divotPoint - (startOffset ? startOffset - 4 : 0); // -4 for "new "
 155     const UChar* data = codeBlock->source()->data();
 156     while (startPoint < divotPoint && isStrWhiteSpace(data[startPoint]))
 157         startPoint++;
 158
 159     UString errorMessage = createErrorMessage(exec, codeBlock, line, startPoint, divotPoint, value, "not a constructor");
 160     JSObject* exception = Error::create(exec, TypeError, errorMessage, line, codeBlock->ownerNode()->sourceID(), codeBlock->ownerNode()->sourceURL());
 161     exception->putWithAttributes(exec, Identifier(exec, expressionBeginOffsetPropertyName), jsNumber(exec, divotPoint - startOffset), ReadOnly | DontDelete);
 162     exception->putWithAttributes(exec, Identifier(exec, expressionCaretOffsetPropertyName), jsNumber(exec, divotPoint), ReadOnly | DontDelete);
 163     exception->putWithAttributes(exec, Identifier(exec, expressionEndOffsetPropertyName), jsNumber(exec, divotPoint + endOffset), ReadOnly | DontDelete);
 164     return exception;
 165 }
 166
 167 JSValuePtr createNotAFunctionError(ExecState* exec, JSValuePtr value, unsigned bytecodeOffset, CodeBlock* codeBlock)
 168 {
 169     int startOffset = 0;
 170     int endOffset = 0;
 171     int divotPoint = 0;
 172     int line = codeBlock->expressionRangeForBytecodeOffset(exec, bytecodeOffset, divotPoint, startOffset, endOffset);
 173     UString errorMessage = createErrorMessage(exec, codeBlock, line, divotPoint - startOffset, divotPoint, value, "not a function");
 174     JSObject* exception = Error::create(exec, TypeError, errorMessage, line, codeBlock->ownerNode()->sourceID(), codeBlock->ownerNode()->sourceURL());
 175     exception->putWithAttributes(exec, Identifier(exec, expressionBeginOffsetPropertyName), jsNumber(exec, divotPoint - startOffset), ReadOnly | DontDelete);
 176     exception->putWithAttributes(exec, Identifier(exec, expressionCaretOffsetPropertyName), jsNumber(exec, divotPoint), ReadOnly | DontDelete);
 177     exception->putWithAttributes(exec, Identifier(exec, expressionEndOffsetPropertyName), jsNumber(exec, divotPoint + endOffset), ReadOnly | DontDelete);
 178     return exception;
 179 }
 180
 181 JSNotAnObjectErrorStub* createNotAnObjectErrorStub(ExecState* exec, bool isNull)
 182 {
 183     return new (exec) JSNotAnObjectErrorStub(exec, isNull);
 184 }
 185
 186 JSObject* createNotAnObjectError(ExecState* exec, JSNotAnObjectErrorStub* error, unsigned bytecodeOffset, CodeBlock* codeBlock)
 187 {
 188     // Both op_construct and op_instanceof require a use of op_get_by_id to get
 189     // the prototype property from an object. The exception messages for exceptions
 190     // thrown by these instances op_get_by_id need to reflect this.
 191     OpcodeID followingOpcodeID;
 192     if (codeBlock->getByIdExceptionInfoForBytecodeOffset(exec, bytecodeOffset, followingOpcodeID)) {
 193         ASSERT(followingOpcodeID == op_construct || followingOpcodeID == op_instanceof);
 194         if (followingOpcodeID == op_construct)
 195             return createNotAConstructorError(exec, error->isNull() ? jsNull() : jsUndefined(), bytecodeOffset, codeBlock);
 196         return createInvalidParamError(exec, "instanceof", error->isNull() ? jsNull() : jsUndefined(), bytecodeOffset, codeBlock);
 197     }
 198
 199     int startOffset = 0;
 200     int endOffset = 0;
 201     int divotPoint = 0;
 202     int line = codeBlock->expressionRangeForBytecodeOffset(exec, bytecodeOffset, divotPoint, startOffset, endOffset);
 203     UString errorMessage = createErrorMessage(exec, codeBlock, line, divotPoint - startOffset, divotPoint, error->isNull() ? jsNull() : jsUndefined(), "not an object");
 204     JSObject* exception = Error::create(exec, TypeError, errorMessage, line, codeBlock->ownerNode()->sourceID(), codeBlock->ownerNode()->sourceURL());
 205     exception->putWithAttributes(exec, Identifier(exec, expressionBeginOffsetPropertyName), jsNumber(exec, divotPoint - startOffset), ReadOnly | DontDelete);
 206     exception->putWithAttributes(exec, Identifier(exec, expressionCaretOffsetPropertyName), jsNumber(exec, divotPoint), ReadOnly | DontDelete);
 207     exception->putWithAttributes(exec, Identifier(exec, expressionEndOffsetPropertyName), jsNumber(exec, divotPoint + endOffset), ReadOnly | DontDelete);
 208     return exception;
 209 }
 210
 211 } // namespace JSC