API/JSContextRefPrivate.h

   1 /*
   2  * Copyright (C) 2009 Apple Computer, 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 #ifndef JSContextRefPrivate_h
  27 #define JSContextRefPrivate_h
  28
  29 #include <JavaScriptCore/JSObjectRef.h>
  30 #include <JavaScriptCore/JSValueRef.h>
  31 #include <JavaScriptCore/WebKitAvailability.h>
  32
  33 #ifndef __cplusplus
  34 #include <stdbool.h>
  35 #endif
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /*!
  42 @function
  43 @abstract Gets the global context of a JavaScript execution context.
  44 @param ctx The JSContext whose global context you want to get.
  45 @result ctx's global context.
  46 */
  47 JS_EXPORT JSGlobalContextRef JSContextGetGlobalContext(JSContextRef ctx);
  48
  49
  50 /*!
  51 @function
  52 @abstract Gets a Backtrace for the existing context
  53 @param ctx The JSContext whose backtrace you want to get
  54 @result A string containing the backtrace
  55 */
  56 JS_EXPORT JSStringRef JSContextCreateBacktrace(JSContextRef ctx, unsigned maxStackSize) AVAILABLE_IN_WEBKIT_VERSION_4_0;
  57
  58
  59 /*!
  60 @typedef JSShouldTerminateCallback
  61 @abstract The callback invoked when script execution has exceeded the allowed
  62  time limit previously specified via JSContextGroupSetExecutionTimeLimit.
  63 @param ctx The execution context to use.
  64 @param context User specified context data previously passed to
  65  JSContextGroupSetExecutionTimeLimit.
  66 @discussion If you named your function Callback, you would declare it like this:
  67
  68  bool Callback(JSContextRef ctx, void* context);
  69
  70  If you return true, the timed out script will terminate.
  71  If you return false, the script will run for another period of the allowed
  72  time limit specified via JSContextGroupSetExecutionTimeLimit.
  73
  74  Within this callback function, you may call JSContextGroupSetExecutionTimeLimit
  75  to set a new time limit, or JSContextGroupClearExecutionTimeLimit to cancel the
  76  timeout.
  77 */
  78 typedef bool
  79 (*JSShouldTerminateCallback) (JSContextRef ctx, void* context);
  80
  81 /*!
  82 @function
  83 @abstract Sets the script execution time limit.
  84 @param group The JavaScript context group that this time limit applies to.
  85 @param limit The time limit of allowed script execution time in seconds.
  86 @param callback The callback function that will be invoked when the time limit
  87  has been reached. This will give you a chance to decide if you want to
  88  terminate the script or not. If you pass a NULL callback, the script will be
  89  terminated unconditionally when the time limit has been reached.
  90 @param context User data that you can provide to be passed back to you
  91  in your callback.
  92
  93  In order to guarantee that the execution time limit will take effect, you will
  94  need to call JSContextGroupSetExecutionTimeLimit before you start executing
  95  any scripts.
  96 */
  97 JS_EXPORT void JSContextGroupSetExecutionTimeLimit(JSContextGroupRef, double limit, JSShouldTerminateCallback, void* context) AVAILABLE_IN_WEBKIT_VERSION_4_0;
  98
  99 /*!
 100 @function
 101 @abstract Clears the script execution time limit.
 102 @param group The JavaScript context group that the time limit is cleared on.
 103 */
 104 JS_EXPORT void JSContextGroupClearExecutionTimeLimit(JSContextGroupRef) AVAILABLE_IN_WEBKIT_VERSION_4_0;
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif
 109
 110 #endif /* JSContextRefPrivate_h */