runtime/ExceptionHelpers.h

   1 /*
   2  * Copyright (C) 2008 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 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 #ifndef ExceptionHelpers_h
  30 #define ExceptionHelpers_h
  31
  32 #include "ErrorInstance.h"
  33 #include "JSObject.h"
  34
  35 namespace JSC {
  36
  37 typedef JSObject* (*ErrorFactory)(ExecState*, const String&, ErrorInstance::SourceAppender);
  38
  39 JSObject* createTerminatedExecutionException(VM*);
  40 JS_EXPORT_PRIVATE bool isTerminatedExecutionException(Exception*);
  41 JS_EXPORT_PRIVATE JSObject* createError(ExecState*, JSValue, const String&, ErrorInstance::SourceAppender);
  42 JS_EXPORT_PRIVATE JSObject* createStackOverflowError(ExecState*);
  43 JSObject* createUndefinedVariableError(ExecState*, const Identifier&);
  44 JSObject* createNotAnObjectError(ExecState*, JSValue);
  45 JSObject* createInvalidFunctionApplyParameterError(ExecState*, JSValue);
  46 JSObject* createInvalidInParameterError(ExecState*, JSValue);
  47 JSObject* createInvalidInstanceofParameterError(ExecState*, JSValue);
  48 JSObject* createNotAConstructorError(ExecState*, JSValue);
  49 JSObject* createNotAFunctionError(ExecState*, JSValue);
  50 JSObject* createErrorForInvalidGlobalAssignment(ExecState*, const String&);
  51 JSString* errorDescriptionForValue(ExecState*, JSValue);
  52
  53 JS_EXPORT_PRIVATE JSObject* throwOutOfMemoryError(ExecState*);
  54 JS_EXPORT_PRIVATE JSObject* throwStackOverflowError(ExecState*);
  55 JS_EXPORT_PRIVATE JSObject* throwTerminatedExecutionException(ExecState*);
  56
  57
  58 class TerminatedExecutionError final : public JSNonFinalObject {
  59 public:
  60     typedef JSNonFinalObject Base;
  61     static const unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
  62
  63     static TerminatedExecutionError* create(VM& vm)
  64     {
  65         TerminatedExecutionError* error = new (NotNull, allocateCell<TerminatedExecutionError>(vm.heap)) TerminatedExecutionError(vm);
  66         error->finishCreation(vm);
  67         return error;
  68     }
  69
  70     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
  71     {
  72         return Structure::create(vm, globalObject, prototype, TypeInfo(ObjectType, StructureFlags), info());
  73     }
  74
  75     DECLARE_EXPORT_INFO;
  76
  77 private:
  78     explicit TerminatedExecutionError(VM& vm)
  79         : JSNonFinalObject(vm, vm.terminatedExecutionErrorStructure.get())
  80     {
  81     }
  82
  83     static JSValue defaultValue(const JSObject*, ExecState*, PreferredPrimitiveType);
  84
  85 };
  86
  87 } // namespace JSC
  88
  89 #endif // ExceptionHelpers_h