blob: 181994358082162d44da5f2e760f0d15baf319eb [file] [log] [blame]
sgjesse@chromium.org8e8294a2011-05-02 14:30:53 +00001// Copyright 2011 the V8 project authors. All rights reserved.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002// Redistribution and use in source and binary forms, with or without
3// modification, are permitted provided that the following conditions are
4// met:
5//
6// * Redistributions of source code must retain the above copyright
7// notice, this list of conditions and the following disclaimer.
8// * Redistributions in binary form must reproduce the above
9// copyright notice, this list of conditions and the following
10// disclaimer in the documentation and/or other materials provided
11// with the distribution.
12// * Neither the name of Google Inc. nor the names of its
13// contributors may be used to endorse or promote products derived
14// from this software without specific prior written permission.
15//
16// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
v8.team.kasperl727e9952008-09-02 14:56:44 +000028/** \mainpage V8 API Reference Guide
ager@chromium.org9258b6b2008-09-11 09:11:10 +000029 *
30 * V8 is Google's open source JavaScript engine.
v8.team.kasperl727e9952008-09-02 14:56:44 +000031 *
32 * This set of documents provides reference material generated from the
33 * V8 header file, include/v8.h.
34 *
35 * For other documentation see http://code.google.com/apis/v8/
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000036 */
v8.team.kasperl727e9952008-09-02 14:56:44 +000037
ager@chromium.org9258b6b2008-09-11 09:11:10 +000038#ifndef V8_H_
39#define V8_H_
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000040
whesse@chromium.orgf0ac72d2010-11-08 12:47:26 +000041#include "v8stdint.h"
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000042
43#ifdef _WIN32
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000044
45// Setup for Windows DLL export/import. When building the V8 DLL the
46// BUILDING_V8_SHARED needs to be defined. When building a program which uses
47// the V8 DLL USING_V8_SHARED needs to be defined. When either building the V8
48// static library or building a program which uses the V8 static library neither
49// BUILDING_V8_SHARED nor USING_V8_SHARED should be defined.
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000050#if defined(BUILDING_V8_SHARED) && defined(USING_V8_SHARED)
51#error both BUILDING_V8_SHARED and USING_V8_SHARED are set - please check the\
52 build configuration to ensure that at most one of these is set
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000053#endif
54
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000055#ifdef BUILDING_V8_SHARED
ager@chromium.orgbb29dc92009-03-24 13:25:23 +000056#define V8EXPORT __declspec(dllexport)
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000057#elif USING_V8_SHARED
ager@chromium.orgbb29dc92009-03-24 13:25:23 +000058#define V8EXPORT __declspec(dllimport)
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000059#else
ager@chromium.orgbb29dc92009-03-24 13:25:23 +000060#define V8EXPORT
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000061#endif // BUILDING_V8_SHARED
62
63#else // _WIN32
ager@chromium.org9085a012009-05-11 19:22:57 +000064
sgjesse@chromium.orgb9d7da12009-08-05 08:38:10 +000065// Setup for Linux shared library export. There is no need to distinguish
66// between building or using the V8 shared library, but we should not
67// export symbols when we are building a static library.
68#if defined(__GNUC__) && (__GNUC__ >= 4) && defined(V8_SHARED)
ager@chromium.orgbb29dc92009-03-24 13:25:23 +000069#define V8EXPORT __attribute__ ((visibility("default")))
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000070#else // defined(__GNUC__) && (__GNUC__ >= 4)
ager@chromium.orgbb29dc92009-03-24 13:25:23 +000071#define V8EXPORT
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000072#endif // defined(__GNUC__) && (__GNUC__ >= 4)
73
74#endif // _WIN32
75
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000076/**
v8.team.kasperl727e9952008-09-02 14:56:44 +000077 * The v8 JavaScript engine.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000078 */
79namespace v8 {
80
81class Context;
82class String;
svenpanne@chromium.org84bcc552011-07-18 09:50:57 +000083class StringObject;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000084class Value;
85class Utils;
86class Number;
svenpanne@chromium.org84bcc552011-07-18 09:50:57 +000087class NumberObject;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000088class Object;
89class Array;
90class Int32;
91class Uint32;
92class External;
93class Primitive;
94class Boolean;
svenpanne@chromium.org84bcc552011-07-18 09:50:57 +000095class BooleanObject;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000096class Integer;
97class Function;
98class Date;
99class ImplementationUtilities;
100class Signature;
101template <class T> class Handle;
102template <class T> class Local;
103template <class T> class Persistent;
104class FunctionTemplate;
105class ObjectTemplate;
106class Data;
kmillikin@chromium.org9155e252010-05-26 13:27:57 +0000107class AccessorInfo;
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +0000108class StackTrace;
109class StackFrame;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000110
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000111namespace internal {
112
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +0000113class Arguments;
ager@chromium.orgc4c92722009-11-18 14:12:51 +0000114class Object;
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +0000115class Heap;
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +0000116class HeapObject;
117class Isolate;
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000118}
119
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000120
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +0000121// --- Weak Handles ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000122
123
124/**
125 * A weak reference callback function.
126 *
fschneider@chromium.orged78ffd2010-07-21 11:05:19 +0000127 * This callback should either explicitly invoke Dispose on |object| if
128 * V8 wrapper is not needed anymore, or 'revive' it by invocation of MakeWeak.
129 *
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000130 * \param object the weak global object to be reclaimed by the garbage collector
131 * \param parameter the value passed in when making the weak global object
132 */
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000133typedef void (*WeakReferenceCallback)(Persistent<Value> object,
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000134 void* parameter);
135
136
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +0000137// --- Handles ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000138
fschneider@chromium.orged78ffd2010-07-21 11:05:19 +0000139#define TYPE_CHECK(T, S) \
140 while (false) { \
141 *(static_cast<T* volatile*>(0)) = static_cast<S*>(0); \
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000142 }
143
144/**
145 * An object reference managed by the v8 garbage collector.
146 *
147 * All objects returned from v8 have to be tracked by the garbage
148 * collector so that it knows that the objects are still alive. Also,
149 * because the garbage collector may move objects, it is unsafe to
150 * point directly to an object. Instead, all objects are stored in
151 * handles which are known by the garbage collector and updated
152 * whenever an object moves. Handles should always be passed by value
153 * (except in cases like out-parameters) and they should never be
154 * allocated on the heap.
155 *
156 * There are two types of handles: local and persistent handles.
157 * Local handles are light-weight and transient and typically used in
158 * local operations. They are managed by HandleScopes. Persistent
159 * handles can be used when storing objects across several independent
160 * operations and have to be explicitly deallocated when they're no
161 * longer used.
162 *
163 * It is safe to extract the object stored in the handle by
164 * dereferencing the handle (for instance, to extract the Object* from
vegorov@chromium.org7304bca2011-05-16 12:14:13 +0000165 * a Handle<Object>); the value will still be governed by a handle
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000166 * behind the scenes and the same rules apply to these values as to
167 * their handles.
168 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000169template <class T> class Handle {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000170 public:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000171 /**
172 * Creates an empty handle.
173 */
danno@chromium.orgb6451162011-08-17 14:33:23 +0000174 inline Handle() : val_(0) {}
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000175
176 /**
177 * Creates a new handle for the specified value.
178 */
danno@chromium.orgb6451162011-08-17 14:33:23 +0000179 inline explicit Handle(T* val) : val_(val) {}
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000180
181 /**
182 * Creates a handle for the contents of the specified handle. This
183 * constructor allows you to pass handles as arguments by value and
v8.team.kasperl727e9952008-09-02 14:56:44 +0000184 * to assign between handles. However, if you try to assign between
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000185 * incompatible handles, for instance from a Handle<String> to a
vegorov@chromium.org7304bca2011-05-16 12:14:13 +0000186 * Handle<Number> it will cause a compile-time error. Assigning
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000187 * between compatible handles, for instance assigning a
188 * Handle<String> to a variable declared as Handle<Value>, is legal
189 * because String is a subclass of Value.
190 */
191 template <class S> inline Handle(Handle<S> that)
192 : val_(reinterpret_cast<T*>(*that)) {
193 /**
194 * This check fails when trying to convert between incompatible
195 * handles. For example, converting from a Handle<String> to a
196 * Handle<Number>.
197 */
198 TYPE_CHECK(T, S);
199 }
200
201 /**
202 * Returns true if the handle is empty.
203 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000204 inline bool IsEmpty() const { return val_ == 0; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000205
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000206 /**
207 * Sets the handle to be empty. IsEmpty() will then return true.
208 */
danno@chromium.orgb6451162011-08-17 14:33:23 +0000209 inline void Clear() { val_ = 0; }
210
211 inline T* operator->() const { return val_; }
212
213 inline T* operator*() const { return val_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000214
215 /**
216 * Checks whether two handles are the same.
217 * Returns true if both are empty, or if the objects
218 * to which they refer are identical.
219 * The handles' references are not checked.
220 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000221 template <class S> inline bool operator==(Handle<S> that) const {
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000222 internal::Object** a = reinterpret_cast<internal::Object**>(**this);
223 internal::Object** b = reinterpret_cast<internal::Object**>(*that);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000224 if (a == 0) return b == 0;
225 if (b == 0) return false;
226 return *a == *b;
227 }
228
229 /**
230 * Checks whether two handles are different.
231 * Returns true if only one of the handles is empty, or if
232 * the objects to which they refer are different.
233 * The handles' references are not checked.
234 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000235 template <class S> inline bool operator!=(Handle<S> that) const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000236 return !operator==(that);
237 }
238
239 template <class S> static inline Handle<T> Cast(Handle<S> that) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000240#ifdef V8_ENABLE_CHECKS
241 // If we're going to perform the type check then we have to check
242 // that the handle isn't empty before doing the checked cast.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000243 if (that.IsEmpty()) return Handle<T>();
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000244#endif
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000245 return Handle<T>(T::Cast(*that));
246 }
247
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000248 template <class S> inline Handle<S> As() {
249 return Handle<S>::Cast(*this);
250 }
251
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000252 private:
253 T* val_;
254};
255
256
257/**
258 * A light-weight stack-allocated object handle. All operations
259 * that return objects from within v8 return them in local handles. They
260 * are created within HandleScopes, and all local handles allocated within a
261 * handle scope are destroyed when the handle scope is destroyed. Hence it
262 * is not necessary to explicitly deallocate local handles.
263 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000264template <class T> class Local : public Handle<T> {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000265 public:
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000266 inline Local();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000267 template <class S> inline Local(Local<S> that)
268 : Handle<T>(reinterpret_cast<T*>(*that)) {
269 /**
270 * This check fails when trying to convert between incompatible
271 * handles. For example, converting from a Handle<String> to a
272 * Handle<Number>.
273 */
274 TYPE_CHECK(T, S);
275 }
276 template <class S> inline Local(S* that) : Handle<T>(that) { }
277 template <class S> static inline Local<T> Cast(Local<S> that) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000278#ifdef V8_ENABLE_CHECKS
279 // If we're going to perform the type check then we have to check
280 // that the handle isn't empty before doing the checked cast.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000281 if (that.IsEmpty()) return Local<T>();
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000282#endif
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000283 return Local<T>(T::Cast(*that));
284 }
285
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000286 template <class S> inline Local<S> As() {
287 return Local<S>::Cast(*this);
288 }
289
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000290 /** Create a local handle for the content of another handle.
291 * The referee is kept alive by the local handle even when
292 * the original handle is destroyed/disposed.
293 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000294 inline static Local<T> New(Handle<T> that);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000295};
296
297
298/**
299 * An object reference that is independent of any handle scope. Where
v8.team.kasperl727e9952008-09-02 14:56:44 +0000300 * a Local handle only lives as long as the HandleScope in which it was
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000301 * allocated, a Persistent handle remains valid until it is explicitly
302 * disposed.
303 *
304 * A persistent handle contains a reference to a storage cell within
305 * the v8 engine which holds an object value and which is updated by
306 * the garbage collector whenever the object is moved. A new storage
307 * cell can be created using Persistent::New and existing handles can
308 * be disposed using Persistent::Dispose. Since persistent handles
309 * are passed by value you may have many persistent handle objects
310 * that point to the same storage cell. For instance, if you pass a
311 * persistent handle as an argument to a function you will not get two
312 * different storage cells but rather two references to the same
313 * storage cell.
314 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000315template <class T> class Persistent : public Handle<T> {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000316 public:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000317 /**
318 * Creates an empty persistent handle that doesn't point to any
319 * storage cell.
320 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000321 inline Persistent();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000322
323 /**
324 * Creates a persistent handle for the same storage cell as the
325 * specified handle. This constructor allows you to pass persistent
326 * handles as arguments by value and to assign between persistent
v8.team.kasperl727e9952008-09-02 14:56:44 +0000327 * handles. However, attempting to assign between incompatible
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000328 * persistent handles, for instance from a Persistent<String> to a
vegorov@chromium.org7304bca2011-05-16 12:14:13 +0000329 * Persistent<Number> will cause a compile-time error. Assigning
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000330 * between compatible persistent handles, for instance assigning a
331 * Persistent<String> to a variable declared as Persistent<Value>,
v8.team.kasperl727e9952008-09-02 14:56:44 +0000332 * is allowed as String is a subclass of Value.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000333 */
334 template <class S> inline Persistent(Persistent<S> that)
335 : Handle<T>(reinterpret_cast<T*>(*that)) {
336 /**
337 * This check fails when trying to convert between incompatible
338 * handles. For example, converting from a Handle<String> to a
339 * Handle<Number>.
340 */
341 TYPE_CHECK(T, S);
342 }
343
344 template <class S> inline Persistent(S* that) : Handle<T>(that) { }
345
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000346 /**
347 * "Casts" a plain handle which is known to be a persistent handle
348 * to a persistent handle.
349 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000350 template <class S> explicit inline Persistent(Handle<S> that)
351 : Handle<T>(*that) { }
352
353 template <class S> static inline Persistent<T> Cast(Persistent<S> that) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000354#ifdef V8_ENABLE_CHECKS
355 // If we're going to perform the type check then we have to check
356 // that the handle isn't empty before doing the checked cast.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000357 if (that.IsEmpty()) return Persistent<T>();
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000358#endif
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000359 return Persistent<T>(T::Cast(*that));
360 }
361
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000362 template <class S> inline Persistent<S> As() {
363 return Persistent<S>::Cast(*this);
364 }
365
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000366 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +0000367 * Creates a new persistent handle for an existing local or
368 * persistent handle.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000369 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000370 inline static Persistent<T> New(Handle<T> that);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000371
372 /**
373 * Releases the storage cell referenced by this persistent handle.
374 * Does not remove the reference to the cell from any handles.
vegorov@chromium.org7304bca2011-05-16 12:14:13 +0000375 * This handle's reference, and any other references to the storage
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000376 * cell remain and IsEmpty will still return false.
377 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000378 inline void Dispose();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000379
380 /**
381 * Make the reference to this object weak. When only weak handles
382 * refer to the object, the garbage collector will perform a
383 * callback to the given V8::WeakReferenceCallback function, passing
384 * it the object reference and the given parameters.
385 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000386 inline void MakeWeak(void* parameters, WeakReferenceCallback callback);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000387
388 /** Clears the weak reference to this object.*/
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000389 inline void ClearWeak();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000390
391 /**
kmillikin@chromium.orgc53e10d2011-05-18 09:12:58 +0000392 * Marks the reference to this object independent. Garbage collector
393 * is free to ignore any object groups containing this object.
394 * Weak callback for an independent handle should not
395 * assume that it will be preceded by a global GC prologue callback
396 * or followed by a global GC epilogue callback.
397 */
398 inline void MarkIndependent();
399
400 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000401 *Checks if the handle holds the only reference to an object.
402 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000403 inline bool IsNearDeath() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000404
405 /**
406 * Returns true if the handle's reference is weak.
407 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000408 inline bool IsWeak() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000409
whesse@chromium.orgb08986c2011-03-14 16:13:42 +0000410 /**
411 * Assigns a wrapper class ID to the handle. See RetainedObjectInfo
412 * interface description in v8-profiler.h for details.
413 */
414 inline void SetWrapperClassId(uint16_t class_id);
415
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000416 private:
417 friend class ImplementationUtilities;
418 friend class ObjectTemplate;
419};
420
421
v8.team.kasperl727e9952008-09-02 14:56:44 +0000422 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000423 * A stack-allocated class that governs a number of local handles.
424 * After a handle scope has been created, all local handles will be
425 * allocated within that handle scope until either the handle scope is
426 * deleted or another handle scope is created. If there is already a
427 * handle scope and a new one is created, all allocations will take
v8.team.kasperl727e9952008-09-02 14:56:44 +0000428 * place in the new handle scope until it is deleted. After that,
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000429 * new handles will again be allocated in the original handle scope.
430 *
431 * After the handle scope of a local handle has been deleted the
432 * garbage collector will no longer track the object stored in the
433 * handle and may deallocate it. The behavior of accessing a handle
434 * for which the handle scope has been deleted is undefined.
435 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000436class V8EXPORT HandleScope {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000437 public:
ager@chromium.orgddb913d2009-01-27 10:01:48 +0000438 HandleScope();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000439
ager@chromium.orgddb913d2009-01-27 10:01:48 +0000440 ~HandleScope();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000441
442 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000443 * Closes the handle scope and returns the value as a handle in the
444 * previous scope, which is the new current scope after the call.
445 */
446 template <class T> Local<T> Close(Handle<T> value);
447
448 /**
449 * Counts the number of allocated handles.
450 */
451 static int NumberOfHandles();
452
453 /**
454 * Creates a new handle with the given value.
455 */
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000456 static internal::Object** CreateHandle(internal::Object* value);
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +0000457 // Faster version, uses HeapObject to obtain the current Isolate.
458 static internal::Object** CreateHandle(internal::HeapObject* value);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000459
460 private:
461 // Make it impossible to create heap-allocated or illegal handle
462 // scopes by disallowing certain operations.
463 HandleScope(const HandleScope&);
464 void operator=(const HandleScope&);
465 void* operator new(size_t size);
466 void operator delete(void*, size_t);
467
ager@chromium.org3811b432009-10-28 14:53:37 +0000468 // This Data class is accessible internally as HandleScopeData through a
469 // typedef in the ImplementationUtilities class.
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000470 class V8EXPORT Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000471 public:
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000472 internal::Object** next;
473 internal::Object** limit;
lrn@chromium.org303ada72010-10-27 09:33:13 +0000474 int level;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000475 inline void Initialize() {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000476 next = limit = NULL;
lrn@chromium.org303ada72010-10-27 09:33:13 +0000477 level = 0;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000478 }
479 };
whesse@chromium.orgf0ac72d2010-11-08 12:47:26 +0000480
lrn@chromium.org303ada72010-10-27 09:33:13 +0000481 void Leave();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000482
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +0000483 internal::Isolate* isolate_;
lrn@chromium.org303ada72010-10-27 09:33:13 +0000484 internal::Object** prev_next_;
485 internal::Object** prev_limit_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000486
ager@chromium.orgddb913d2009-01-27 10:01:48 +0000487 // Allow for the active closing of HandleScopes which allows to pass a handle
488 // from the HandleScope being closed to the next top most HandleScope.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000489 bool is_closed_;
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000490 internal::Object** RawClose(internal::Object** value);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000491
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000492 friend class ImplementationUtilities;
493};
494
495
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +0000496// --- Special objects ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000497
498
499/**
500 * The superclass of values and API object templates.
501 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000502class V8EXPORT Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000503 private:
504 Data();
505};
506
507
508/**
509 * Pre-compilation data that can be associated with a script. This
510 * data can be calculated for a script in advance of actually
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000511 * compiling it, and can be stored between compilations. When script
v8.team.kasperl727e9952008-09-02 14:56:44 +0000512 * data is given to the compile method compilation will be faster.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000513 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000514class V8EXPORT ScriptData { // NOLINT
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000515 public:
516 virtual ~ScriptData() { }
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +0000517
kmillikin@chromium.org9155e252010-05-26 13:27:57 +0000518 /**
519 * Pre-compiles the specified script (context-independent).
520 *
521 * \param input Pointer to UTF-8 script source code.
522 * \param length Length of UTF-8 script source code.
523 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000524 static ScriptData* PreCompile(const char* input, int length);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000525
kmillikin@chromium.org9155e252010-05-26 13:27:57 +0000526 /**
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +0000527 * Pre-compiles the specified script (context-independent).
528 *
529 * NOTE: Pre-compilation using this method cannot happen on another thread
530 * without using Lockers.
531 *
532 * \param source Script source code.
533 */
534 static ScriptData* PreCompile(Handle<String> source);
535
536 /**
kmillikin@chromium.org9155e252010-05-26 13:27:57 +0000537 * Load previous pre-compilation data.
538 *
539 * \param data Pointer to data returned by a call to Data() of a previous
540 * ScriptData. Ownership is not transferred.
541 * \param length Length of data.
542 */
543 static ScriptData* New(const char* data, int length);
544
545 /**
546 * Returns the length of Data().
547 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000548 virtual int Length() = 0;
kmillikin@chromium.org9155e252010-05-26 13:27:57 +0000549
550 /**
551 * Returns a serialized representation of this ScriptData that can later be
552 * passed to New(). NOTE: Serialized data is platform-dependent.
553 */
554 virtual const char* Data() = 0;
555
556 /**
557 * Returns true if the source code could not be parsed.
558 */
fschneider@chromium.org0c20e672010-01-14 15:28:53 +0000559 virtual bool HasError() = 0;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000560};
561
562
563/**
564 * The origin, within a file, of a script.
565 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000566class ScriptOrigin {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000567 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000568 inline ScriptOrigin(
569 Handle<Value> resource_name,
570 Handle<Integer> resource_line_offset = Handle<Integer>(),
571 Handle<Integer> resource_column_offset = Handle<Integer>())
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000572 : resource_name_(resource_name),
573 resource_line_offset_(resource_line_offset),
574 resource_column_offset_(resource_column_offset) { }
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000575 inline Handle<Value> ResourceName() const;
576 inline Handle<Integer> ResourceLineOffset() const;
577 inline Handle<Integer> ResourceColumnOffset() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000578 private:
mads.s.agercbaa0602008-08-14 13:41:48 +0000579 Handle<Value> resource_name_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000580 Handle<Integer> resource_line_offset_;
581 Handle<Integer> resource_column_offset_;
582};
583
584
585/**
v8.team.kasperl727e9952008-09-02 14:56:44 +0000586 * A compiled JavaScript script.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000587 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000588class V8EXPORT Script {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000589 public:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000590 /**
ager@chromium.org5c838252010-02-19 08:53:10 +0000591 * Compiles the specified script (context-independent).
sgjesse@chromium.org911335c2009-08-19 12:59:44 +0000592 *
ager@chromium.org5c838252010-02-19 08:53:10 +0000593 * \param source Script source code.
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000594 * \param origin Script origin, owned by caller, no references are kept
ager@chromium.org5c838252010-02-19 08:53:10 +0000595 * when New() returns
596 * \param pre_data Pre-parsing data, as obtained by ScriptData::PreCompile()
597 * using pre_data speeds compilation if it's done multiple times.
598 * Owned by caller, no references are kept when New() returns.
599 * \param script_data Arbitrary data associated with script. Using
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000600 * this has same effect as calling SetData(), but allows data to be
ager@chromium.org5c838252010-02-19 08:53:10 +0000601 * available to compile event handlers.
602 * \return Compiled script object (context independent; when run it
603 * will use the currently entered context).
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000604 */
ager@chromium.org5c838252010-02-19 08:53:10 +0000605 static Local<Script> New(Handle<String> source,
606 ScriptOrigin* origin = NULL,
607 ScriptData* pre_data = NULL,
608 Handle<String> script_data = Handle<String>());
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000609
mads.s.agercbaa0602008-08-14 13:41:48 +0000610 /**
611 * Compiles the specified script using the specified file name
612 * object (typically a string) as the script's origin.
sgjesse@chromium.org911335c2009-08-19 12:59:44 +0000613 *
ager@chromium.org5c838252010-02-19 08:53:10 +0000614 * \param source Script source code.
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000615 * \param file_name file name object (typically a string) to be used
ager@chromium.org5c838252010-02-19 08:53:10 +0000616 * as the script's origin.
617 * \return Compiled script object (context independent; when run it
618 * will use the currently entered context).
619 */
620 static Local<Script> New(Handle<String> source,
621 Handle<Value> file_name);
622
623 /**
624 * Compiles the specified script (bound to current context).
625 *
626 * \param source Script source code.
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000627 * \param origin Script origin, owned by caller, no references are kept
ager@chromium.org5c838252010-02-19 08:53:10 +0000628 * when Compile() returns
629 * \param pre_data Pre-parsing data, as obtained by ScriptData::PreCompile()
630 * using pre_data speeds compilation if it's done multiple times.
631 * Owned by caller, no references are kept when Compile() returns.
632 * \param script_data Arbitrary data associated with script. Using
633 * this has same effect as calling SetData(), but makes data available
634 * earlier (i.e. to compile event handlers).
635 * \return Compiled script object, bound to the context that was active
636 * when this function was called. When run it will always use this
637 * context.
mads.s.agercbaa0602008-08-14 13:41:48 +0000638 */
639 static Local<Script> Compile(Handle<String> source,
ager@chromium.org5c838252010-02-19 08:53:10 +0000640 ScriptOrigin* origin = NULL,
641 ScriptData* pre_data = NULL,
642 Handle<String> script_data = Handle<String>());
643
644 /**
645 * Compiles the specified script using the specified file name
646 * object (typically a string) as the script's origin.
647 *
648 * \param source Script source code.
649 * \param file_name File name to use as script's origin
650 * \param script_data Arbitrary data associated with script. Using
651 * this has same effect as calling SetData(), but makes data available
652 * earlier (i.e. to compile event handlers).
653 * \return Compiled script object, bound to the context that was active
654 * when this function was called. When run it will always use this
655 * context.
656 */
657 static Local<Script> Compile(Handle<String> source,
658 Handle<Value> file_name,
659 Handle<String> script_data = Handle<String>());
mads.s.agercbaa0602008-08-14 13:41:48 +0000660
v8.team.kasperl727e9952008-09-02 14:56:44 +0000661 /**
sgjesse@chromium.org911335c2009-08-19 12:59:44 +0000662 * Runs the script returning the resulting value. If the script is
663 * context independent (created using ::New) it will be run in the
664 * currently entered context. If it is context specific (created
665 * using ::Compile) it will be run in the context in which it was
666 * compiled.
v8.team.kasperl727e9952008-09-02 14:56:44 +0000667 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000668 Local<Value> Run();
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000669
670 /**
671 * Returns the script id value.
672 */
673 Local<Value> Id();
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000674
675 /**
676 * Associate an additional data object with the script. This is mainly used
677 * with the debugger as this data object is only available through the
678 * debugger API.
679 */
sgjesse@chromium.org499aaa52009-11-30 08:07:20 +0000680 void SetData(Handle<String> data);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000681};
682
683
684/**
685 * An error message.
686 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000687class V8EXPORT Message {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000688 public:
ager@chromium.org32912102009-01-16 10:38:43 +0000689 Local<String> Get() const;
690 Local<String> GetSourceLine() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000691
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000692 /**
693 * Returns the resource name for the script from where the function causing
694 * the error originates.
695 */
ager@chromium.org32912102009-01-16 10:38:43 +0000696 Handle<Value> GetScriptResourceName() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000697
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000698 /**
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000699 * Returns the resource data for the script from where the function causing
700 * the error originates.
701 */
702 Handle<Value> GetScriptData() const;
703
704 /**
ager@chromium.org6a2b0aa2010-07-13 20:58:03 +0000705 * Exception stack trace. By default stack traces are not captured for
706 * uncaught exceptions. SetCaptureStackTraceForUncaughtExceptions allows
707 * to change this option.
708 */
709 Handle<StackTrace> GetStackTrace() const;
710
711 /**
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000712 * Returns the number, 1-based, of the line where the error occurred.
713 */
ager@chromium.org32912102009-01-16 10:38:43 +0000714 int GetLineNumber() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000715
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000716 /**
717 * Returns the index within the script of the first character where
718 * the error occurred.
719 */
ager@chromium.org32912102009-01-16 10:38:43 +0000720 int GetStartPosition() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000721
722 /**
723 * Returns the index within the script of the last character where
724 * the error occurred.
725 */
ager@chromium.org32912102009-01-16 10:38:43 +0000726 int GetEndPosition() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000727
728 /**
729 * Returns the index within the line of the first character where
730 * the error occurred.
731 */
ager@chromium.org32912102009-01-16 10:38:43 +0000732 int GetStartColumn() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000733
734 /**
735 * Returns the index within the line of the last character where
736 * the error occurred.
737 */
ager@chromium.org32912102009-01-16 10:38:43 +0000738 int GetEndColumn() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000739
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000740 // TODO(1245381): Print to a string instead of on a FILE.
741 static void PrintCurrentStackTrace(FILE* out);
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +0000742
743 static const int kNoLineNumberInfo = 0;
744 static const int kNoColumnInfo = 0;
745};
746
747
748/**
749 * Representation of a JavaScript stack trace. The information collected is a
750 * snapshot of the execution stack and the information remains valid after
751 * execution continues.
752 */
753class V8EXPORT StackTrace {
754 public:
755 /**
756 * Flags that determine what information is placed captured for each
757 * StackFrame when grabbing the current stack trace.
758 */
759 enum StackTraceOptions {
760 kLineNumber = 1,
761 kColumnOffset = 1 << 1 | kLineNumber,
762 kScriptName = 1 << 2,
763 kFunctionName = 1 << 3,
764 kIsEval = 1 << 4,
765 kIsConstructor = 1 << 5,
ager@chromium.orgb61a0d12010-10-13 08:35:23 +0000766 kScriptNameOrSourceURL = 1 << 6,
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +0000767 kOverview = kLineNumber | kColumnOffset | kScriptName | kFunctionName,
ager@chromium.orgb61a0d12010-10-13 08:35:23 +0000768 kDetailed = kOverview | kIsEval | kIsConstructor | kScriptNameOrSourceURL
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +0000769 };
770
771 /**
772 * Returns a StackFrame at a particular index.
773 */
774 Local<StackFrame> GetFrame(uint32_t index) const;
775
776 /**
777 * Returns the number of StackFrames.
778 */
779 int GetFrameCount() const;
780
781 /**
782 * Returns StackTrace as a v8::Array that contains StackFrame objects.
783 */
784 Local<Array> AsArray();
785
786 /**
vegorov@chromium.org7304bca2011-05-16 12:14:13 +0000787 * Grab a snapshot of the current JavaScript execution stack.
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +0000788 *
789 * \param frame_limit The maximum number of stack frames we want to capture.
790 * \param options Enumerates the set of things we will capture for each
791 * StackFrame.
792 */
793 static Local<StackTrace> CurrentStackTrace(
794 int frame_limit,
795 StackTraceOptions options = kOverview);
796};
797
798
799/**
800 * A single JavaScript stack frame.
801 */
802class V8EXPORT StackFrame {
803 public:
804 /**
805 * Returns the number, 1-based, of the line for the associate function call.
806 * This method will return Message::kNoLineNumberInfo if it is unable to
807 * retrieve the line number, or if kLineNumber was not passed as an option
808 * when capturing the StackTrace.
809 */
810 int GetLineNumber() const;
811
812 /**
813 * Returns the 1-based column offset on the line for the associated function
814 * call.
815 * This method will return Message::kNoColumnInfo if it is unable to retrieve
816 * the column number, or if kColumnOffset was not passed as an option when
817 * capturing the StackTrace.
818 */
819 int GetColumn() const;
820
821 /**
822 * Returns the name of the resource that contains the script for the
823 * function for this StackFrame.
824 */
825 Local<String> GetScriptName() const;
826
827 /**
ager@chromium.orgb61a0d12010-10-13 08:35:23 +0000828 * Returns the name of the resource that contains the script for the
829 * function for this StackFrame or sourceURL value if the script name
830 * is undefined and its source ends with //@ sourceURL=... string.
831 */
832 Local<String> GetScriptNameOrSourceURL() const;
833
834 /**
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +0000835 * Returns the name of the function associated with this stack frame.
836 */
837 Local<String> GetFunctionName() const;
838
839 /**
840 * Returns whether or not the associated function is compiled via a call to
841 * eval().
842 */
843 bool IsEval() const;
844
845 /**
vegorov@chromium.org7304bca2011-05-16 12:14:13 +0000846 * Returns whether or not the associated function is called as a
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +0000847 * constructor via "new".
848 */
849 bool IsConstructor() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000850};
851
852
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +0000853// --- Value ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000854
855
856/**
v8.team.kasperl727e9952008-09-02 14:56:44 +0000857 * The superclass of all JavaScript values and objects.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000858 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000859class Value : public Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000860 public:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000861 /**
862 * Returns true if this value is the undefined value. See ECMA-262
863 * 4.3.10.
864 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000865 V8EXPORT bool IsUndefined() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000866
867 /**
868 * Returns true if this value is the null value. See ECMA-262
869 * 4.3.11.
870 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000871 V8EXPORT bool IsNull() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000872
873 /**
874 * Returns true if this value is true.
875 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000876 V8EXPORT bool IsTrue() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000877
878 /**
879 * Returns true if this value is false.
880 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000881 V8EXPORT bool IsFalse() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000882
883 /**
884 * Returns true if this value is an instance of the String type.
885 * See ECMA-262 8.4.
886 */
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000887 inline bool IsString() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000888
889 /**
890 * Returns true if this value is a function.
891 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000892 V8EXPORT bool IsFunction() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000893
894 /**
895 * Returns true if this value is an array.
896 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000897 V8EXPORT bool IsArray() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000898
v8.team.kasperl727e9952008-09-02 14:56:44 +0000899 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000900 * Returns true if this value is an object.
901 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000902 V8EXPORT bool IsObject() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000903
v8.team.kasperl727e9952008-09-02 14:56:44 +0000904 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000905 * Returns true if this value is boolean.
906 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000907 V8EXPORT bool IsBoolean() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000908
v8.team.kasperl727e9952008-09-02 14:56:44 +0000909 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000910 * Returns true if this value is a number.
911 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000912 V8EXPORT bool IsNumber() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000913
v8.team.kasperl727e9952008-09-02 14:56:44 +0000914 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000915 * Returns true if this value is external.
916 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000917 V8EXPORT bool IsExternal() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000918
v8.team.kasperl727e9952008-09-02 14:56:44 +0000919 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000920 * Returns true if this value is a 32-bit signed integer.
921 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000922 V8EXPORT bool IsInt32() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000923
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000924 /**
lrn@chromium.orgc34f5802010-04-28 12:53:43 +0000925 * Returns true if this value is a 32-bit unsigned integer.
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000926 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000927 V8EXPORT bool IsUint32() const;
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000928
929 /**
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000930 * Returns true if this value is a Date.
931 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000932 V8EXPORT bool IsDate() const;
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000933
vegorov@chromium.org26c16f82010-08-11 13:41:03 +0000934 /**
svenpanne@chromium.org84bcc552011-07-18 09:50:57 +0000935 * Returns true if this value is a Boolean object.
936 */
937 V8EXPORT bool IsBooleanObject() const;
938
939 /**
940 * Returns true if this value is a Number object.
941 */
942 V8EXPORT bool IsNumberObject() const;
943
944 /**
945 * Returns true if this value is a String object.
946 */
947 V8EXPORT bool IsStringObject() const;
948
949 /**
950 * Returns true if this value is a NativeError.
951 */
952 V8EXPORT bool IsNativeError() const;
953
954 /**
vegorov@chromium.org26c16f82010-08-11 13:41:03 +0000955 * Returns true if this value is a RegExp.
956 */
957 V8EXPORT bool IsRegExp() const;
958
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000959 V8EXPORT Local<Boolean> ToBoolean() const;
960 V8EXPORT Local<Number> ToNumber() const;
961 V8EXPORT Local<String> ToString() const;
962 V8EXPORT Local<String> ToDetailString() const;
963 V8EXPORT Local<Object> ToObject() const;
964 V8EXPORT Local<Integer> ToInteger() const;
965 V8EXPORT Local<Uint32> ToUint32() const;
966 V8EXPORT Local<Int32> ToInt32() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000967
968 /**
969 * Attempts to convert a string to an array index.
970 * Returns an empty handle if the conversion fails.
971 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000972 V8EXPORT Local<Uint32> ToArrayIndex() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000973
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000974 V8EXPORT bool BooleanValue() const;
975 V8EXPORT double NumberValue() const;
976 V8EXPORT int64_t IntegerValue() const;
977 V8EXPORT uint32_t Uint32Value() const;
978 V8EXPORT int32_t Int32Value() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000979
980 /** JS == */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000981 V8EXPORT bool Equals(Handle<Value> that) const;
982 V8EXPORT bool StrictEquals(Handle<Value> that) const;
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +0000983
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000984 private:
985 inline bool QuickIsString() const;
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000986 V8EXPORT bool FullIsString() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000987};
988
989
990/**
991 * The superclass of primitive values. See ECMA-262 4.3.2.
992 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000993class Primitive : public Value { };
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000994
995
996/**
997 * A primitive boolean value (ECMA-262, 4.3.14). Either the true
998 * or false value.
999 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001000class Boolean : public Primitive {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001001 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001002 V8EXPORT bool Value() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001003 static inline Handle<Boolean> New(bool value);
1004};
1005
1006
1007/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001008 * A JavaScript string value (ECMA-262, 4.3.17).
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001009 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001010class String : public Primitive {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001011 public:
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001012 /**
1013 * Returns the number of characters in this string.
1014 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001015 V8EXPORT int Length() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001016
v8.team.kasperl727e9952008-09-02 14:56:44 +00001017 /**
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001018 * Returns the number of bytes in the UTF-8 encoded
1019 * representation of this string.
1020 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001021 V8EXPORT int Utf8Length() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001022
1023 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001024 * Write the contents of the string to an external buffer.
1025 * If no arguments are given, expects the buffer to be large
1026 * enough to hold the entire string and NULL terminator. Copies
1027 * the contents of the string and the NULL terminator into the
1028 * buffer.
1029 *
ager@chromium.org5f0c45f2010-12-17 08:51:21 +00001030 * WriteUtf8 will not write partial UTF-8 sequences, preferring to stop
1031 * before the end of the buffer.
1032 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00001033 * Copies up to length characters into the output buffer.
1034 * Only null-terminates if there is enough space in the buffer.
1035 *
1036 * \param buffer The buffer into which the string will be copied.
1037 * \param start The starting position within the string at which
1038 * copying begins.
ager@chromium.org5f0c45f2010-12-17 08:51:21 +00001039 * \param length The number of characters to copy from the string. For
1040 * WriteUtf8 the number of bytes in the buffer.
ager@chromium.org357bf652010-04-12 11:30:10 +00001041 * \param nchars_ref The number of characters written, can be NULL.
ricow@chromium.orgddd545c2011-08-24 12:02:41 +00001042 * \param options Various options that might affect performance of this or
ricow@chromium.orgc9c80822010-04-21 08:22:37 +00001043 * subsequent operations.
ager@chromium.org5f0c45f2010-12-17 08:51:21 +00001044 * \return The number of characters copied to the buffer excluding the null
1045 * terminator. For WriteUtf8: The number of bytes copied to the buffer
ricow@chromium.orgddd545c2011-08-24 12:02:41 +00001046 * including the null terminator (if written).
v8.team.kasperl727e9952008-09-02 14:56:44 +00001047 */
ricow@chromium.orgddd545c2011-08-24 12:02:41 +00001048 enum WriteOptions {
1049 NO_OPTIONS = 0,
1050 HINT_MANY_WRITES_EXPECTED = 1,
1051 NO_NULL_TERMINATION = 2
whesse@chromium.orgb6e43bb2010-04-14 09:36:28 +00001052 };
1053
lrn@chromium.org34e60782011-09-15 07:25:40 +00001054 // 16-bit character codes.
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001055 V8EXPORT int Write(uint16_t* buffer,
1056 int start = 0,
1057 int length = -1,
lrn@chromium.org34e60782011-09-15 07:25:40 +00001058 int options = NO_OPTIONS) const;
1059 // ASCII characters.
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001060 V8EXPORT int WriteAscii(char* buffer,
1061 int start = 0,
1062 int length = -1,
lrn@chromium.org34e60782011-09-15 07:25:40 +00001063 int options = NO_OPTIONS) const;
1064 // UTF-8 encoded characters.
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001065 V8EXPORT int WriteUtf8(char* buffer,
1066 int length = -1,
1067 int* nchars_ref = NULL,
lrn@chromium.org34e60782011-09-15 07:25:40 +00001068 int options = NO_OPTIONS) const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001069
v8.team.kasperl727e9952008-09-02 14:56:44 +00001070 /**
ager@chromium.org563b8dc2009-03-20 14:23:52 +00001071 * A zero length string.
1072 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001073 V8EXPORT static v8::Local<v8::String> Empty();
ager@chromium.org563b8dc2009-03-20 14:23:52 +00001074
1075 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001076 * Returns true if the string is external
1077 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001078 V8EXPORT bool IsExternal() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001079
v8.team.kasperl727e9952008-09-02 14:56:44 +00001080 /**
lrn@chromium.org34e60782011-09-15 07:25:40 +00001081 * Returns true if the string is both external and ASCII
v8.team.kasperl727e9952008-09-02 14:56:44 +00001082 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001083 V8EXPORT bool IsExternalAscii() const;
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001084
whesse@chromium.orgf0ac72d2010-11-08 12:47:26 +00001085 class V8EXPORT ExternalStringResourceBase { // NOLINT
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001086 public:
1087 virtual ~ExternalStringResourceBase() {}
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001088
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001089 protected:
1090 ExternalStringResourceBase() {}
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001091
1092 /**
1093 * Internally V8 will call this Dispose method when the external string
1094 * resource is no longer needed. The default implementation will use the
1095 * delete operator. This method can be overridden in subclasses to
1096 * control how allocated external string resources are disposed.
1097 */
1098 virtual void Dispose() { delete this; }
1099
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001100 private:
1101 // Disallow copying and assigning.
1102 ExternalStringResourceBase(const ExternalStringResourceBase&);
1103 void operator=(const ExternalStringResourceBase&);
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001104
1105 friend class v8::internal::Heap;
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001106 };
1107
v8.team.kasperl727e9952008-09-02 14:56:44 +00001108 /**
1109 * An ExternalStringResource is a wrapper around a two-byte string
1110 * buffer that resides outside V8's heap. Implement an
1111 * ExternalStringResource to manage the life cycle of the underlying
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001112 * buffer. Note that the string data must be immutable.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001113 */
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001114 class V8EXPORT ExternalStringResource
1115 : public ExternalStringResourceBase {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001116 public:
1117 /**
1118 * Override the destructor to manage the life cycle of the underlying
1119 * buffer.
1120 */
1121 virtual ~ExternalStringResource() {}
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001122
1123 /**
1124 * The string data from the underlying buffer.
1125 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001126 virtual const uint16_t* data() const = 0;
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001127
1128 /**
1129 * The length of the string. That is, the number of two-byte characters.
1130 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001131 virtual size_t length() const = 0;
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001132
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001133 protected:
1134 ExternalStringResource() {}
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001135 };
1136
1137 /**
lrn@chromium.org34e60782011-09-15 07:25:40 +00001138 * An ExternalAsciiStringResource is a wrapper around an ASCII
v8.team.kasperl727e9952008-09-02 14:56:44 +00001139 * string buffer that resides outside V8's heap. Implement an
1140 * ExternalAsciiStringResource to manage the life cycle of the
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001141 * underlying buffer. Note that the string data must be immutable
lrn@chromium.org34e60782011-09-15 07:25:40 +00001142 * and that the data must be strict (7-bit) ASCII, not Latin-1 or
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001143 * UTF-8, which would require special treatment internally in the
1144 * engine and, in the case of UTF-8, do not allow efficient indexing.
1145 * Use String::New or convert to 16 bit data for non-ASCII.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001146 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001147
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001148 class V8EXPORT ExternalAsciiStringResource
1149 : public ExternalStringResourceBase {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001150 public:
1151 /**
1152 * Override the destructor to manage the life cycle of the underlying
1153 * buffer.
1154 */
1155 virtual ~ExternalAsciiStringResource() {}
1156 /** The string data from the underlying buffer.*/
1157 virtual const char* data() const = 0;
lrn@chromium.org34e60782011-09-15 07:25:40 +00001158 /** The number of ASCII characters in the string.*/
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001159 virtual size_t length() const = 0;
1160 protected:
1161 ExternalAsciiStringResource() {}
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001162 };
1163
1164 /**
ager@chromium.org9085a012009-05-11 19:22:57 +00001165 * Get the ExternalStringResource for an external string. Returns
1166 * NULL if IsExternal() doesn't return true.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001167 */
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001168 inline ExternalStringResource* GetExternalStringResource() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001169
1170 /**
lrn@chromium.org34e60782011-09-15 07:25:40 +00001171 * Get the ExternalAsciiStringResource for an external ASCII string.
ager@chromium.org9085a012009-05-11 19:22:57 +00001172 * Returns NULL if IsExternalAscii() doesn't return true.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001173 */
erik.corry@gmail.comc3b670f2011-10-05 21:44:48 +00001174 V8EXPORT const ExternalAsciiStringResource* GetExternalAsciiStringResource()
1175 const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001176
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001177 static inline String* Cast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001178
1179 /**
lrn@chromium.org34e60782011-09-15 07:25:40 +00001180 * Allocates a new string from either UTF-8 encoded or ASCII data.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001181 * The second parameter 'length' gives the buffer length.
lrn@chromium.org34e60782011-09-15 07:25:40 +00001182 * If the data is UTF-8 encoded, the caller must
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001183 * be careful to supply the length parameter.
1184 * If it is not given, the function calls
1185 * 'strlen' to determine the buffer length, it might be
kasper.lund7276f142008-07-30 08:49:36 +00001186 * wrong if 'data' contains a null character.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001187 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001188 V8EXPORT static Local<String> New(const char* data, int length = -1);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001189
lrn@chromium.org34e60782011-09-15 07:25:40 +00001190 /** Allocates a new string from 16-bit character codes.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001191 V8EXPORT static Local<String> New(const uint16_t* data, int length = -1);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001192
1193 /** Creates a symbol. Returns one if it exists already.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001194 V8EXPORT static Local<String> NewSymbol(const char* data, int length = -1);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001195
v8.team.kasperl727e9952008-09-02 14:56:44 +00001196 /**
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001197 * Creates a new string by concatenating the left and the right strings
1198 * passed in as parameters.
1199 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001200 V8EXPORT static Local<String> Concat(Handle<String> left,
1201 Handle<String>right);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001202
1203 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001204 * Creates a new external string using the data defined in the given
lrn@chromium.org1af7e1b2010-06-07 11:12:01 +00001205 * resource. When the external string is no longer live on V8's heap the
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001206 * resource will be disposed by calling its Dispose method. The caller of
1207 * this function should not otherwise delete or modify the resource. Neither
1208 * should the underlying buffer be deallocated or modified except through the
1209 * destructor of the external string resource.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001210 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001211 V8EXPORT static Local<String> NewExternal(ExternalStringResource* resource);
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001212
ager@chromium.org6f10e412009-02-13 10:11:16 +00001213 /**
1214 * Associate an external string resource with this string by transforming it
1215 * in place so that existing references to this string in the JavaScript heap
1216 * will use the external string resource. The external string resource's
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00001217 * character contents need to be equivalent to this string.
ager@chromium.org6f10e412009-02-13 10:11:16 +00001218 * Returns true if the string has been changed to be an external string.
lrn@chromium.org1af7e1b2010-06-07 11:12:01 +00001219 * The string is not modified if the operation fails. See NewExternal for
1220 * information on the lifetime of the resource.
ager@chromium.org6f10e412009-02-13 10:11:16 +00001221 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001222 V8EXPORT bool MakeExternal(ExternalStringResource* resource);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001223
v8.team.kasperl727e9952008-09-02 14:56:44 +00001224 /**
lrn@chromium.org34e60782011-09-15 07:25:40 +00001225 * Creates a new external string using the ASCII data defined in the given
lrn@chromium.org1af7e1b2010-06-07 11:12:01 +00001226 * resource. When the external string is no longer live on V8's heap the
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001227 * resource will be disposed by calling its Dispose method. The caller of
1228 * this function should not otherwise delete or modify the resource. Neither
1229 * should the underlying buffer be deallocated or modified except through the
1230 * destructor of the external string resource.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001231 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001232 V8EXPORT static Local<String> NewExternal(
1233 ExternalAsciiStringResource* resource);
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001234
ager@chromium.org6f10e412009-02-13 10:11:16 +00001235 /**
1236 * Associate an external string resource with this string by transforming it
1237 * in place so that existing references to this string in the JavaScript heap
1238 * will use the external string resource. The external string resource's
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00001239 * character contents need to be equivalent to this string.
ager@chromium.org6f10e412009-02-13 10:11:16 +00001240 * Returns true if the string has been changed to be an external string.
lrn@chromium.org1af7e1b2010-06-07 11:12:01 +00001241 * The string is not modified if the operation fails. See NewExternal for
1242 * information on the lifetime of the resource.
ager@chromium.org6f10e412009-02-13 10:11:16 +00001243 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001244 V8EXPORT bool MakeExternal(ExternalAsciiStringResource* resource);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001245
christian.plesner.hansen@gmail.com5a6af922009-08-12 14:20:51 +00001246 /**
1247 * Returns true if this string can be made external.
1248 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001249 V8EXPORT bool CanMakeExternal();
christian.plesner.hansen@gmail.com5a6af922009-08-12 14:20:51 +00001250
lrn@chromium.org34e60782011-09-15 07:25:40 +00001251 /** Creates an undetectable string from the supplied ASCII or UTF-8 data.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001252 V8EXPORT static Local<String> NewUndetectable(const char* data,
1253 int length = -1);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001254
lrn@chromium.org34e60782011-09-15 07:25:40 +00001255 /** Creates an undetectable string from the supplied 16-bit character codes.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001256 V8EXPORT static Local<String> NewUndetectable(const uint16_t* data,
1257 int length = -1);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001258
1259 /**
lrn@chromium.org34e60782011-09-15 07:25:40 +00001260 * Converts an object to a UTF-8-encoded character array. Useful if
ager@chromium.org71daaf62009-04-01 07:22:49 +00001261 * you want to print the object. If conversion to a string fails
lrn@chromium.org34e60782011-09-15 07:25:40 +00001262 * (e.g. due to an exception in the toString() method of the object)
ager@chromium.org71daaf62009-04-01 07:22:49 +00001263 * then the length() method returns 0 and the * operator returns
1264 * NULL.
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001265 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001266 class V8EXPORT Utf8Value {
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001267 public:
1268 explicit Utf8Value(Handle<v8::Value> obj);
1269 ~Utf8Value();
ager@chromium.orga1645e22009-09-09 19:27:10 +00001270 char* operator*() { return str_; }
1271 const char* operator*() const { return str_; }
1272 int length() const { return length_; }
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001273 private:
1274 char* str_;
1275 int length_;
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00001276
1277 // Disallow copying and assigning.
1278 Utf8Value(const Utf8Value&);
1279 void operator=(const Utf8Value&);
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001280 };
1281
1282 /**
lrn@chromium.org34e60782011-09-15 07:25:40 +00001283 * Converts an object to an ASCII string.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001284 * Useful if you want to print the object.
ager@chromium.org71daaf62009-04-01 07:22:49 +00001285 * If conversion to a string fails (eg. due to an exception in the toString()
1286 * method of the object) then the length() method returns 0 and the * operator
1287 * returns NULL.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001288 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001289 class V8EXPORT AsciiValue {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001290 public:
1291 explicit AsciiValue(Handle<v8::Value> obj);
1292 ~AsciiValue();
ager@chromium.orga1645e22009-09-09 19:27:10 +00001293 char* operator*() { return str_; }
1294 const char* operator*() const { return str_; }
1295 int length() const { return length_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001296 private:
1297 char* str_;
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001298 int length_;
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00001299
1300 // Disallow copying and assigning.
1301 AsciiValue(const AsciiValue&);
1302 void operator=(const AsciiValue&);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001303 };
1304
1305 /**
1306 * Converts an object to a two-byte string.
ager@chromium.org71daaf62009-04-01 07:22:49 +00001307 * If conversion to a string fails (eg. due to an exception in the toString()
1308 * method of the object) then the length() method returns 0 and the * operator
1309 * returns NULL.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001310 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001311 class V8EXPORT Value {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001312 public:
1313 explicit Value(Handle<v8::Value> obj);
1314 ~Value();
ager@chromium.orga1645e22009-09-09 19:27:10 +00001315 uint16_t* operator*() { return str_; }
1316 const uint16_t* operator*() const { return str_; }
1317 int length() const { return length_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001318 private:
1319 uint16_t* str_;
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001320 int length_;
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00001321
1322 // Disallow copying and assigning.
1323 Value(const Value&);
1324 void operator=(const Value&);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001325 };
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001326
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001327 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001328 V8EXPORT void VerifyExternalStringResource(ExternalStringResource* val) const;
1329 V8EXPORT static void CheckCast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001330};
1331
1332
1333/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001334 * A JavaScript number value (ECMA-262, 4.3.20)
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001335 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001336class Number : public Primitive {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001337 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001338 V8EXPORT double Value() const;
1339 V8EXPORT static Local<Number> New(double value);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001340 static inline Number* Cast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001341 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001342 V8EXPORT Number();
ricow@chromium.orgddd545c2011-08-24 12:02:41 +00001343 V8EXPORT static void CheckCast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001344};
1345
1346
1347/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001348 * A JavaScript value representing a signed integer.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001349 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001350class Integer : public Number {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001351 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001352 V8EXPORT static Local<Integer> New(int32_t value);
1353 V8EXPORT static Local<Integer> NewFromUnsigned(uint32_t value);
1354 V8EXPORT int64_t Value() const;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001355 static inline Integer* Cast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001356 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001357 V8EXPORT Integer();
1358 V8EXPORT static void CheckCast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001359};
1360
1361
1362/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001363 * A JavaScript value representing a 32-bit signed integer.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001364 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001365class Int32 : public Integer {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001366 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001367 V8EXPORT int32_t Value() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001368 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001369 V8EXPORT Int32();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001370};
1371
1372
1373/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001374 * A JavaScript value representing a 32-bit unsigned integer.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001375 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001376class Uint32 : public Integer {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001377 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001378 V8EXPORT uint32_t Value() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001379 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001380 V8EXPORT Uint32();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001381};
1382
1383
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001384enum PropertyAttribute {
1385 None = 0,
1386 ReadOnly = 1 << 0,
1387 DontEnum = 1 << 1,
1388 DontDelete = 1 << 2
1389};
1390
ager@chromium.org3811b432009-10-28 14:53:37 +00001391enum ExternalArrayType {
1392 kExternalByteArray = 1,
1393 kExternalUnsignedByteArray,
1394 kExternalShortArray,
1395 kExternalUnsignedShortArray,
1396 kExternalIntArray,
1397 kExternalUnsignedIntArray,
danno@chromium.org4d3fe4e2011-03-10 10:14:28 +00001398 kExternalFloatArray,
erik.corry@gmail.com3847bd52011-04-27 10:38:56 +00001399 kExternalDoubleArray,
danno@chromium.org4d3fe4e2011-03-10 10:14:28 +00001400 kExternalPixelArray
ager@chromium.org3811b432009-10-28 14:53:37 +00001401};
1402
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001403/**
kmillikin@chromium.org9155e252010-05-26 13:27:57 +00001404 * Accessor[Getter|Setter] are used as callback functions when
1405 * setting|getting a particular property. See Object and ObjectTemplate's
1406 * method SetAccessor.
1407 */
1408typedef Handle<Value> (*AccessorGetter)(Local<String> property,
1409 const AccessorInfo& info);
1410
1411
1412typedef void (*AccessorSetter)(Local<String> property,
1413 Local<Value> value,
1414 const AccessorInfo& info);
1415
1416
1417/**
1418 * Access control specifications.
1419 *
1420 * Some accessors should be accessible across contexts. These
1421 * accessors have an explicit access control parameter which specifies
1422 * the kind of cross-context access that should be allowed.
1423 *
1424 * Additionally, for security, accessors can prohibit overwriting by
1425 * accessors defined in JavaScript. For objects that have such
1426 * accessors either locally or in their prototype chain it is not
1427 * possible to overwrite the accessor by using __defineGetter__ or
1428 * __defineSetter__ from JavaScript code.
1429 */
1430enum AccessControl {
1431 DEFAULT = 0,
1432 ALL_CAN_READ = 1,
1433 ALL_CAN_WRITE = 1 << 1,
1434 PROHIBITS_OVERWRITING = 1 << 2
1435};
1436
1437
1438/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001439 * A JavaScript object (ECMA-262, 4.3.3)
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001440 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001441class Object : public Value {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001442 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001443 V8EXPORT bool Set(Handle<Value> key,
1444 Handle<Value> value,
1445 PropertyAttribute attribs = None);
ager@chromium.org65dad4b2009-04-23 08:48:43 +00001446
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001447 V8EXPORT bool Set(uint32_t index,
1448 Handle<Value> value);
ager@chromium.orgce5e87b2010-03-10 10:24:18 +00001449
ager@chromium.orge2902be2009-06-08 12:21:35 +00001450 // Sets a local property on this object bypassing interceptors and
ager@chromium.org65dad4b2009-04-23 08:48:43 +00001451 // overriding accessors or read-only properties.
1452 //
1453 // Note that if the object has an interceptor the property will be set
1454 // locally, but since the interceptor takes precedence the local property
1455 // will only be returned if the interceptor doesn't return a value.
1456 //
1457 // Note also that this only works for named properties.
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001458 V8EXPORT bool ForceSet(Handle<Value> key,
1459 Handle<Value> value,
1460 PropertyAttribute attribs = None);
ager@chromium.orge2902be2009-06-08 12:21:35 +00001461
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001462 V8EXPORT Local<Value> Get(Handle<Value> key);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001463
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001464 V8EXPORT Local<Value> Get(uint32_t index);
ager@chromium.orgce5e87b2010-03-10 10:24:18 +00001465
rossberg@chromium.org717967f2011-07-20 13:44:42 +00001466 /**
1467 * Gets the property attributes of a property which can be None or
1468 * any combination of ReadOnly, DontEnum and DontDelete. Returns
1469 * None when the property doesn't exist.
1470 */
1471 V8EXPORT PropertyAttribute GetPropertyAttributes(Handle<Value> key);
1472
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001473 // TODO(1245389): Replace the type-specific versions of these
1474 // functions with generic ones that accept a Handle<Value> key.
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001475 V8EXPORT bool Has(Handle<String> key);
ager@chromium.orge2902be2009-06-08 12:21:35 +00001476
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001477 V8EXPORT bool Delete(Handle<String> key);
ager@chromium.orge2902be2009-06-08 12:21:35 +00001478
1479 // Delete a property on this object bypassing interceptors and
1480 // ignoring dont-delete attributes.
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001481 V8EXPORT bool ForceDelete(Handle<Value> key);
ager@chromium.orge2902be2009-06-08 12:21:35 +00001482
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001483 V8EXPORT bool Has(uint32_t index);
ager@chromium.orge2902be2009-06-08 12:21:35 +00001484
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001485 V8EXPORT bool Delete(uint32_t index);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001486
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001487 V8EXPORT bool SetAccessor(Handle<String> name,
1488 AccessorGetter getter,
1489 AccessorSetter setter = 0,
1490 Handle<Value> data = Handle<Value>(),
1491 AccessControl settings = DEFAULT,
1492 PropertyAttribute attribute = None);
kmillikin@chromium.org9155e252010-05-26 13:27:57 +00001493
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001494 /**
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00001495 * Returns an array containing the names of the enumerable properties
1496 * of this object, including properties from prototype objects. The
1497 * array returned by this method contains the same values as would
1498 * be enumerated by a for-in statement over this object.
1499 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001500 V8EXPORT Local<Array> GetPropertyNames();
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00001501
1502 /**
svenpanne@chromium.org6d786c92011-06-15 10:58:27 +00001503 * This function has the same functionality as GetPropertyNames but
1504 * the returned array doesn't contain the names of properties from
1505 * prototype objects.
1506 */
1507 V8EXPORT Local<Array> GetOwnPropertyNames();
1508
1509 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001510 * Get the prototype object. This does not skip objects marked to
1511 * be skipped by __proto__ and it does not consult the security
1512 * handler.
1513 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001514 V8EXPORT Local<Value> GetPrototype();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001515
1516 /**
ager@chromium.org5c838252010-02-19 08:53:10 +00001517 * Set the prototype object. This does not skip objects marked to
1518 * be skipped by __proto__ and it does not consult the security
1519 * handler.
1520 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001521 V8EXPORT bool SetPrototype(Handle<Value> prototype);
ager@chromium.org5c838252010-02-19 08:53:10 +00001522
1523 /**
sgjesse@chromium.org900d3b72009-08-07 11:24:25 +00001524 * Finds an instance of the given function template in the prototype
1525 * chain.
1526 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001527 V8EXPORT Local<Object> FindInstanceInPrototypeChain(
1528 Handle<FunctionTemplate> tmpl);
sgjesse@chromium.org900d3b72009-08-07 11:24:25 +00001529
1530 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001531 * Call builtin Object.prototype.toString on this object.
1532 * This is different from Value::ToString() that may call
1533 * user-defined toString function. This one does not.
1534 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001535 V8EXPORT Local<String> ObjectProtoToString();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001536
ager@chromium.orgbeb25712010-11-29 08:02:25 +00001537 /**
1538 * Returns the name of the function invoked as a constructor for this object.
1539 */
1540 V8EXPORT Local<String> GetConstructorName();
1541
kasper.lund212ac232008-07-16 07:07:30 +00001542 /** Gets the number of internal fields for this Object. */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001543 V8EXPORT int InternalFieldCount();
kasper.lund212ac232008-07-16 07:07:30 +00001544 /** Gets the value in an internal field. */
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001545 inline Local<Value> GetInternalField(int index);
kasper.lund212ac232008-07-16 07:07:30 +00001546 /** Sets the value in an internal field. */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001547 V8EXPORT void SetInternalField(int index, Handle<Value> value);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001548
kasperl@chromium.orge959c182009-07-27 08:59:04 +00001549 /** Gets a native pointer from an internal field. */
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001550 inline void* GetPointerFromInternalField(int index);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001551
kasperl@chromium.orge959c182009-07-27 08:59:04 +00001552 /** Sets a native pointer in an internal field. */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001553 V8EXPORT void SetPointerInInternalField(int index, void* value);
kasperl@chromium.orge959c182009-07-27 08:59:04 +00001554
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001555 // Testers for local properties.
sgjesse@chromium.org8e8294a2011-05-02 14:30:53 +00001556 V8EXPORT bool HasOwnProperty(Handle<String> key);
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001557 V8EXPORT bool HasRealNamedProperty(Handle<String> key);
1558 V8EXPORT bool HasRealIndexedProperty(uint32_t index);
1559 V8EXPORT bool HasRealNamedCallbackProperty(Handle<String> key);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001560
1561 /**
1562 * If result.IsEmpty() no real property was located in the prototype chain.
1563 * This means interceptors in the prototype chain are not called.
1564 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001565 V8EXPORT Local<Value> GetRealNamedPropertyInPrototypeChain(
1566 Handle<String> key);
sgjesse@chromium.org98aff2f2009-09-30 08:27:10 +00001567
1568 /**
1569 * If result.IsEmpty() no real property was located on the object or
1570 * in the prototype chain.
1571 * This means interceptors in the prototype chain are not called.
1572 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001573 V8EXPORT Local<Value> GetRealNamedProperty(Handle<String> key);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001574
1575 /** Tests for a named lookup interceptor.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001576 V8EXPORT bool HasNamedLookupInterceptor();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001577
kasper.lund212ac232008-07-16 07:07:30 +00001578 /** Tests for an index lookup interceptor.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001579 V8EXPORT bool HasIndexedLookupInterceptor();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001580
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00001581 /**
1582 * Turns on access check on the object if the object is an instance of
1583 * a template that has access check callbacks. If an object has no
1584 * access check info, the object cannot be accessed by anyone.
1585 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001586 V8EXPORT void TurnOnAccessCheck();
ager@chromium.org41826e72009-03-30 13:30:57 +00001587
ager@chromium.org3b45ab52009-03-19 22:21:34 +00001588 /**
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00001589 * Returns the identity hash for this object. The current implementation
1590 * uses a hidden property on the object to store the identity hash.
ager@chromium.org5ec48922009-05-05 07:25:34 +00001591 *
ager@chromium.org9085a012009-05-11 19:22:57 +00001592 * The return value will never be 0. Also, it is not guaranteed to be
ager@chromium.org5ec48922009-05-05 07:25:34 +00001593 * unique.
ager@chromium.org3b45ab52009-03-19 22:21:34 +00001594 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001595 V8EXPORT int GetIdentityHash();
ager@chromium.org41826e72009-03-30 13:30:57 +00001596
ager@chromium.org3b45ab52009-03-19 22:21:34 +00001597 /**
1598 * Access hidden properties on JavaScript objects. These properties are
1599 * hidden from the executing JavaScript and only accessible through the V8
1600 * C++ API. Hidden properties introduced by V8 internally (for example the
1601 * identity hash) are prefixed with "v8::".
1602 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001603 V8EXPORT bool SetHiddenValue(Handle<String> key, Handle<Value> value);
1604 V8EXPORT Local<Value> GetHiddenValue(Handle<String> key);
1605 V8EXPORT bool DeleteHiddenValue(Handle<String> key);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001606
christian.plesner.hansen@gmail.com2bc58ef2009-09-22 10:00:30 +00001607 /**
1608 * Returns true if this is an instance of an api function (one
1609 * created from a function created from a function template) and has
1610 * been modified since it was created. Note that this method is
1611 * conservative and may return true for objects that haven't actually
1612 * been modified.
1613 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001614 V8EXPORT bool IsDirty();
ager@chromium.org3b45ab52009-03-19 22:21:34 +00001615
1616 /**
1617 * Clone this object with a fast but shallow copy. Values will point
1618 * to the same values as the original object.
1619 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001620 V8EXPORT Local<Object> Clone();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001621
sgjesse@chromium.org0b6db592009-07-30 14:48:31 +00001622 /**
kmillikin@chromium.orgc36ce6e2011-04-04 08:25:31 +00001623 * Returns the context in which the object was created.
1624 */
1625 V8EXPORT Local<Context> CreationContext();
1626
1627 /**
sgjesse@chromium.org0b6db592009-07-30 14:48:31 +00001628 * Set the backing store of the indexed properties to be managed by the
1629 * embedding layer. Access to the indexed properties will follow the rules
1630 * spelled out in CanvasPixelArray.
1631 * Note: The embedding program still owns the data and needs to ensure that
1632 * the backing store is preserved while V8 has a reference.
1633 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001634 V8EXPORT void SetIndexedPropertiesToPixelData(uint8_t* data, int length);
lrn@chromium.org5d00b602011-01-05 09:51:43 +00001635 V8EXPORT bool HasIndexedPropertiesInPixelData();
1636 V8EXPORT uint8_t* GetIndexedPropertiesPixelData();
1637 V8EXPORT int GetIndexedPropertiesPixelDataLength();
sgjesse@chromium.org0b6db592009-07-30 14:48:31 +00001638
ager@chromium.org3811b432009-10-28 14:53:37 +00001639 /**
1640 * Set the backing store of the indexed properties to be managed by the
1641 * embedding layer. Access to the indexed properties will follow the rules
1642 * spelled out for the CanvasArray subtypes in the WebGL specification.
1643 * Note: The embedding program still owns the data and needs to ensure that
1644 * the backing store is preserved while V8 has a reference.
1645 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001646 V8EXPORT void SetIndexedPropertiesToExternalArrayData(
1647 void* data,
1648 ExternalArrayType array_type,
1649 int number_of_elements);
lrn@chromium.org5d00b602011-01-05 09:51:43 +00001650 V8EXPORT bool HasIndexedPropertiesInExternalArrayData();
1651 V8EXPORT void* GetIndexedPropertiesExternalArrayData();
1652 V8EXPORT ExternalArrayType GetIndexedPropertiesExternalArrayDataType();
1653 V8EXPORT int GetIndexedPropertiesExternalArrayDataLength();
ager@chromium.org3811b432009-10-28 14:53:37 +00001654
lrn@chromium.org1c092762011-05-09 09:42:16 +00001655 /**
karlklose@chromium.org83a47282011-05-11 11:54:09 +00001656 * Checks whether a callback is set by the
1657 * ObjectTemplate::SetCallAsFunctionHandler method.
1658 * When an Object is callable this method returns true.
1659 */
1660 V8EXPORT bool IsCallable();
1661
1662 /**
fschneider@chromium.org1805e212011-09-05 10:49:12 +00001663 * Call an Object as a function if a callback is set by the
lrn@chromium.org1c092762011-05-09 09:42:16 +00001664 * ObjectTemplate::SetCallAsFunctionHandler method.
1665 */
1666 V8EXPORT Local<Value> CallAsFunction(Handle<Object> recv,
1667 int argc,
1668 Handle<Value> argv[]);
1669
1670 /**
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00001671 * Call an Object as a constructor if a callback is set by the
lrn@chromium.org1c092762011-05-09 09:42:16 +00001672 * ObjectTemplate::SetCallAsFunctionHandler method.
1673 * Note: This method behaves like the Function::NewInstance method.
1674 */
1675 V8EXPORT Local<Value> CallAsConstructor(int argc,
1676 Handle<Value> argv[]);
1677
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001678 V8EXPORT static Local<Object> New();
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001679 static inline Object* Cast(Value* obj);
jkummerow@chromium.orge297f592011-06-08 10:05:15 +00001680
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001681 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001682 V8EXPORT Object();
1683 V8EXPORT static void CheckCast(Value* obj);
1684 V8EXPORT Local<Value> CheckedGetInternalField(int index);
1685 V8EXPORT void* SlowGetPointerFromInternalField(int index);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001686
1687 /**
1688 * If quick access to the internal field is possible this method
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001689 * returns the value. Otherwise an empty handle is returned.
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001690 */
1691 inline Local<Value> UncheckedGetInternalField(int index);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001692};
1693
1694
1695/**
1696 * An instance of the built-in array constructor (ECMA-262, 15.4.2).
1697 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001698class Array : public Object {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001699 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001700 V8EXPORT uint32_t Length() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001701
ager@chromium.org3e875802009-06-29 08:26:34 +00001702 /**
1703 * Clones an element at index |index|. Returns an empty
1704 * handle if cloning fails (for any reason).
1705 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001706 V8EXPORT Local<Object> CloneElementAt(uint32_t index);
ager@chromium.org3e875802009-06-29 08:26:34 +00001707
ricow@chromium.orgbadaffc2011-03-17 12:15:27 +00001708 /**
1709 * Creates a JavaScript array with the given length. If the length
1710 * is negative the returned array will have length 0.
1711 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001712 V8EXPORT static Local<Array> New(int length = 0);
ricow@chromium.orgbadaffc2011-03-17 12:15:27 +00001713
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001714 static inline Array* Cast(Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001715 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001716 V8EXPORT Array();
ricow@chromium.orgddd545c2011-08-24 12:02:41 +00001717 V8EXPORT static void CheckCast(Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001718};
1719
1720
1721/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001722 * A JavaScript function object (ECMA-262, 15.3).
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001723 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001724class Function : public Object {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001725 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001726 V8EXPORT Local<Object> NewInstance() const;
1727 V8EXPORT Local<Object> NewInstance(int argc, Handle<Value> argv[]) const;
1728 V8EXPORT Local<Value> Call(Handle<Object> recv,
1729 int argc,
1730 Handle<Value> argv[]);
1731 V8EXPORT void SetName(Handle<String> name);
1732 V8EXPORT Handle<Value> GetName() const;
ager@chromium.org5c838252010-02-19 08:53:10 +00001733
1734 /**
1735 * Returns zero based line number of function body and
1736 * kLineOffsetNotFound if no information available.
1737 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001738 V8EXPORT int GetScriptLineNumber() const;
danno@chromium.orgc612e022011-11-10 11:38:15 +00001739 /**
1740 * Returns zero based column number of function body and
1741 * kLineOffsetNotFound if no information available.
1742 */
1743 V8EXPORT int GetScriptColumnNumber() const;
1744 V8EXPORT Handle<Value> GetScriptId() const;
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001745 V8EXPORT ScriptOrigin GetScriptOrigin() const;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001746 static inline Function* Cast(Value* obj);
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001747 V8EXPORT static const int kLineOffsetNotFound;
danno@chromium.orgc612e022011-11-10 11:38:15 +00001748
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001749 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001750 V8EXPORT Function();
1751 V8EXPORT static void CheckCast(Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001752};
1753
1754
1755/**
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00001756 * An instance of the built-in Date constructor (ECMA-262, 15.9).
1757 */
1758class Date : public Object {
1759 public:
1760 V8EXPORT static Local<Value> New(double time);
1761
1762 /**
1763 * A specialization of Value::NumberValue that is more efficient
1764 * because we know the structure of this object.
1765 */
1766 V8EXPORT double NumberValue() const;
1767
1768 static inline Date* Cast(v8::Value* obj);
1769
1770 /**
1771 * Notification that the embedder has changed the time zone,
1772 * daylight savings time, or other date / time configuration
1773 * parameters. V8 keeps a cache of various values used for
1774 * date / time computation. This notification will reset
1775 * those cached values for the current context so that date /
1776 * time configuration changes would be reflected in the Date
1777 * object.
1778 *
1779 * This API should not be called more than needed as it will
1780 * negatively impact the performance of date operations.
1781 */
1782 V8EXPORT static void DateTimeConfigurationChangeNotification();
1783
1784 private:
1785 V8EXPORT static void CheckCast(v8::Value* obj);
1786};
1787
1788
1789/**
svenpanne@chromium.org84bcc552011-07-18 09:50:57 +00001790 * A Number object (ECMA-262, 4.3.21).
1791 */
1792class NumberObject : public Object {
1793 public:
1794 V8EXPORT static Local<Value> New(double value);
1795
1796 /**
1797 * Returns the Number held by the object.
1798 */
1799 V8EXPORT double NumberValue() const;
1800
1801 static inline NumberObject* Cast(v8::Value* obj);
1802
1803 private:
1804 V8EXPORT static void CheckCast(v8::Value* obj);
1805};
1806
1807
1808/**
1809 * A Boolean object (ECMA-262, 4.3.15).
1810 */
1811class BooleanObject : public Object {
1812 public:
1813 V8EXPORT static Local<Value> New(bool value);
1814
1815 /**
1816 * Returns the Boolean held by the object.
1817 */
1818 V8EXPORT bool BooleanValue() const;
1819
1820 static inline BooleanObject* Cast(v8::Value* obj);
1821
1822 private:
1823 V8EXPORT static void CheckCast(v8::Value* obj);
1824};
1825
1826
1827/**
1828 * A String object (ECMA-262, 4.3.18).
1829 */
1830class StringObject : public Object {
1831 public:
1832 V8EXPORT static Local<Value> New(Handle<String> value);
1833
1834 /**
1835 * Returns the String held by the object.
1836 */
1837 V8EXPORT Local<String> StringValue() const;
1838
1839 static inline StringObject* Cast(v8::Value* obj);
1840
1841 private:
1842 V8EXPORT static void CheckCast(v8::Value* obj);
1843};
1844
1845
1846/**
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00001847 * An instance of the built-in RegExp constructor (ECMA-262, 15.10).
1848 */
1849class RegExp : public Object {
1850 public:
1851 /**
1852 * Regular expression flag bits. They can be or'ed to enable a set
1853 * of flags.
1854 */
1855 enum Flags {
1856 kNone = 0,
1857 kGlobal = 1,
1858 kIgnoreCase = 2,
1859 kMultiline = 4
1860 };
1861
1862 /**
1863 * Creates a regular expression from the given pattern string and
1864 * the flags bit field. May throw a JavaScript exception as
1865 * described in ECMA-262, 15.10.4.1.
1866 *
1867 * For example,
1868 * RegExp::New(v8::String::New("foo"),
1869 * static_cast<RegExp::Flags>(kGlobal | kMultiline))
1870 * is equivalent to evaluating "/foo/gm".
1871 */
1872 V8EXPORT static Local<RegExp> New(Handle<String> pattern,
1873 Flags flags);
1874
1875 /**
1876 * Returns the value of the source property: a string representing
1877 * the regular expression.
1878 */
1879 V8EXPORT Local<String> GetSource() const;
1880
1881 /**
1882 * Returns the flags bit field.
1883 */
1884 V8EXPORT Flags GetFlags() const;
1885
1886 static inline RegExp* Cast(v8::Value* obj);
1887
1888 private:
1889 V8EXPORT static void CheckCast(v8::Value* obj);
1890};
1891
1892
1893/**
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001894 * A JavaScript value that wraps a C++ void*. This type of value is
1895 * mainly used to associate C++ data structures with JavaScript
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001896 * objects.
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001897 *
1898 * The Wrap function V8 will return the most optimal Value object wrapping the
1899 * C++ void*. The type of the value is not guaranteed to be an External object
1900 * and no assumptions about its type should be made. To access the wrapped
1901 * value Unwrap should be used, all other operations on that object will lead
1902 * to unpredictable results.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001903 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001904class External : public Value {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001905 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001906 V8EXPORT static Local<Value> Wrap(void* data);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001907 static inline void* Unwrap(Handle<Value> obj);
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001908
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001909 V8EXPORT static Local<External> New(void* value);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001910 static inline External* Cast(Value* obj);
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001911 V8EXPORT void* Value() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001912 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001913 V8EXPORT External();
1914 V8EXPORT static void CheckCast(v8::Value* obj);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001915 static inline void* QuickUnwrap(Handle<v8::Value> obj);
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001916 V8EXPORT static void* FullUnwrap(Handle<v8::Value> obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001917};
1918
1919
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00001920// --- Templates ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001921
1922
1923/**
1924 * The superclass of object and function templates.
1925 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001926class V8EXPORT Template : public Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001927 public:
1928 /** Adds a property to each instance created by this template.*/
1929 void Set(Handle<String> name, Handle<Data> value,
1930 PropertyAttribute attributes = None);
1931 inline void Set(const char* name, Handle<Data> value);
1932 private:
1933 Template();
1934
1935 friend class ObjectTemplate;
1936 friend class FunctionTemplate;
1937};
1938
1939
1940/**
1941 * The argument information given to function call callbacks. This
v8.team.kasperl727e9952008-09-02 14:56:44 +00001942 * class provides access to information about the context of the call,
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001943 * including the receiver, the number and values of arguments, and
1944 * the holder of the function.
1945 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001946class Arguments {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001947 public:
1948 inline int Length() const;
1949 inline Local<Value> operator[](int i) const;
1950 inline Local<Function> Callee() const;
1951 inline Local<Object> This() const;
1952 inline Local<Object> Holder() const;
1953 inline bool IsConstructCall() const;
1954 inline Local<Value> Data() const;
1955 private:
fschneider@chromium.orge03fb642010-11-01 12:34:09 +00001956 static const int kDataIndex = 0;
1957 static const int kCalleeIndex = -1;
1958 static const int kHolderIndex = -2;
1959
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001960 friend class ImplementationUtilities;
fschneider@chromium.orge03fb642010-11-01 12:34:09 +00001961 inline Arguments(internal::Object** implicit_args,
1962 internal::Object** values,
1963 int length,
1964 bool is_construct_call);
1965 internal::Object** implicit_args_;
1966 internal::Object** values_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001967 int length_;
fschneider@chromium.orge03fb642010-11-01 12:34:09 +00001968 bool is_construct_call_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001969};
1970
1971
1972/**
1973 * The information passed to an accessor callback about the context
1974 * of the property access.
1975 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001976class V8EXPORT AccessorInfo {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001977 public:
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00001978 inline AccessorInfo(internal::Object** args)
1979 : args_(args) { }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001980 inline Local<Value> Data() const;
1981 inline Local<Object> This() const;
1982 inline Local<Object> Holder() const;
1983 private:
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00001984 internal::Object** args_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001985};
1986
1987
1988typedef Handle<Value> (*InvocationCallback)(const Arguments& args);
1989
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001990/**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001991 * NamedProperty[Getter|Setter] are used as interceptors on object.
1992 * See ObjectTemplate::SetNamedPropertyHandler.
1993 */
1994typedef Handle<Value> (*NamedPropertyGetter)(Local<String> property,
1995 const AccessorInfo& info);
1996
1997
1998/**
1999 * Returns the value if the setter intercepts the request.
2000 * Otherwise, returns an empty handle.
2001 */
2002typedef Handle<Value> (*NamedPropertySetter)(Local<String> property,
2003 Local<Value> value,
2004 const AccessorInfo& info);
2005
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002006/**
2007 * Returns a non-empty handle if the interceptor intercepts the request.
whesse@chromium.org2c186ca2010-06-16 11:32:39 +00002008 * The result is an integer encoding property attributes (like v8::None,
2009 * v8::DontEnum, etc.)
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002010 */
lrn@chromium.org1af7e1b2010-06-07 11:12:01 +00002011typedef Handle<Integer> (*NamedPropertyQuery)(Local<String> property,
2012 const AccessorInfo& info);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002013
2014
2015/**
2016 * Returns a non-empty handle if the deleter intercepts the request.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002017 * The return value is true if the property could be deleted and false
2018 * otherwise.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002019 */
2020typedef Handle<Boolean> (*NamedPropertyDeleter)(Local<String> property,
2021 const AccessorInfo& info);
2022
2023/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002024 * Returns an array containing the names of the properties the named
2025 * property getter intercepts.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002026 */
2027typedef Handle<Array> (*NamedPropertyEnumerator)(const AccessorInfo& info);
2028
v8.team.kasperl727e9952008-09-02 14:56:44 +00002029
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002030/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002031 * Returns the value of the property if the getter intercepts the
2032 * request. Otherwise, returns an empty handle.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002033 */
2034typedef Handle<Value> (*IndexedPropertyGetter)(uint32_t index,
2035 const AccessorInfo& info);
2036
2037
2038/**
2039 * Returns the value if the setter intercepts the request.
2040 * Otherwise, returns an empty handle.
2041 */
2042typedef Handle<Value> (*IndexedPropertySetter)(uint32_t index,
2043 Local<Value> value,
2044 const AccessorInfo& info);
2045
2046
2047/**
2048 * Returns a non-empty handle if the interceptor intercepts the request.
ager@chromium.orgea4f62e2010-08-16 16:28:43 +00002049 * The result is an integer encoding property attributes.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002050 */
vegorov@chromium.org26c16f82010-08-11 13:41:03 +00002051typedef Handle<Integer> (*IndexedPropertyQuery)(uint32_t index,
2052 const AccessorInfo& info);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002053
2054/**
2055 * Returns a non-empty handle if the deleter intercepts the request.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002056 * The return value is true if the property could be deleted and false
2057 * otherwise.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002058 */
2059typedef Handle<Boolean> (*IndexedPropertyDeleter)(uint32_t index,
2060 const AccessorInfo& info);
2061
v8.team.kasperl727e9952008-09-02 14:56:44 +00002062/**
2063 * Returns an array containing the indices of the properties the
2064 * indexed property getter intercepts.
2065 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002066typedef Handle<Array> (*IndexedPropertyEnumerator)(const AccessorInfo& info);
2067
2068
2069/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002070 * Access type specification.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002071 */
2072enum AccessType {
2073 ACCESS_GET,
2074 ACCESS_SET,
2075 ACCESS_HAS,
2076 ACCESS_DELETE,
2077 ACCESS_KEYS
2078};
2079
v8.team.kasperl727e9952008-09-02 14:56:44 +00002080
2081/**
2082 * Returns true if cross-context access should be allowed to the named
christian.plesner.hansen@gmail.com2bc58ef2009-09-22 10:00:30 +00002083 * property with the given key on the host object.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002084 */
christian.plesner.hansen@gmail.com2bc58ef2009-09-22 10:00:30 +00002085typedef bool (*NamedSecurityCallback)(Local<Object> host,
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002086 Local<Value> key,
2087 AccessType type,
2088 Local<Value> data);
2089
v8.team.kasperl727e9952008-09-02 14:56:44 +00002090
2091/**
2092 * Returns true if cross-context access should be allowed to the indexed
christian.plesner.hansen@gmail.com2bc58ef2009-09-22 10:00:30 +00002093 * property with the given index on the host object.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002094 */
christian.plesner.hansen@gmail.com2bc58ef2009-09-22 10:00:30 +00002095typedef bool (*IndexedSecurityCallback)(Local<Object> host,
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002096 uint32_t index,
2097 AccessType type,
2098 Local<Value> data);
2099
2100
2101/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002102 * A FunctionTemplate is used to create functions at runtime. There
2103 * can only be one function created from a FunctionTemplate in a
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00002104 * context. The lifetime of the created function is equal to the
2105 * lifetime of the context. So in case the embedder needs to create
2106 * temporary functions that can be collected using Scripts is
2107 * preferred.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002108 *
2109 * A FunctionTemplate can have properties, these properties are added to the
v8.team.kasperl727e9952008-09-02 14:56:44 +00002110 * function object when it is created.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002111 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002112 * A FunctionTemplate has a corresponding instance template which is
2113 * used to create object instances when the function is used as a
2114 * constructor. Properties added to the instance template are added to
2115 * each object instance.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002116 *
2117 * A FunctionTemplate can have a prototype template. The prototype template
2118 * is used to create the prototype object of the function.
2119 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002120 * The following example shows how to use a FunctionTemplate:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002121 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002122 * \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002123 * v8::Local<v8::FunctionTemplate> t = v8::FunctionTemplate::New();
2124 * t->Set("func_property", v8::Number::New(1));
2125 *
2126 * v8::Local<v8::Template> proto_t = t->PrototypeTemplate();
2127 * proto_t->Set("proto_method", v8::FunctionTemplate::New(InvokeCallback));
2128 * proto_t->Set("proto_const", v8::Number::New(2));
2129 *
2130 * v8::Local<v8::ObjectTemplate> instance_t = t->InstanceTemplate();
2131 * instance_t->SetAccessor("instance_accessor", InstanceAccessorCallback);
2132 * instance_t->SetNamedPropertyHandler(PropertyHandlerCallback, ...);
2133 * instance_t->Set("instance_property", Number::New(3));
2134 *
2135 * v8::Local<v8::Function> function = t->GetFunction();
2136 * v8::Local<v8::Object> instance = function->NewInstance();
v8.team.kasperl727e9952008-09-02 14:56:44 +00002137 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002138 *
2139 * Let's use "function" as the JS variable name of the function object
v8.team.kasperl727e9952008-09-02 14:56:44 +00002140 * and "instance" for the instance object created above. The function
2141 * and the instance will have the following properties:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002142 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002143 * \code
2144 * func_property in function == true;
2145 * function.func_property == 1;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002146 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002147 * function.prototype.proto_method() invokes 'InvokeCallback'
2148 * function.prototype.proto_const == 2;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002149 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002150 * instance instanceof function == true;
2151 * instance.instance_accessor calls 'InstanceAccessorCallback'
2152 * instance.instance_property == 3;
2153 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002154 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002155 * A FunctionTemplate can inherit from another one by calling the
2156 * FunctionTemplate::Inherit method. The following graph illustrates
2157 * the semantics of inheritance:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002158 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002159 * \code
2160 * FunctionTemplate Parent -> Parent() . prototype -> { }
2161 * ^ ^
2162 * | Inherit(Parent) | .__proto__
2163 * | |
2164 * FunctionTemplate Child -> Child() . prototype -> { }
2165 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002166 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002167 * A FunctionTemplate 'Child' inherits from 'Parent', the prototype
2168 * object of the Child() function has __proto__ pointing to the
2169 * Parent() function's prototype object. An instance of the Child
2170 * function has all properties on Parent's instance templates.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002171 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002172 * Let Parent be the FunctionTemplate initialized in the previous
2173 * section and create a Child FunctionTemplate by:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002174 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002175 * \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002176 * Local<FunctionTemplate> parent = t;
2177 * Local<FunctionTemplate> child = FunctionTemplate::New();
2178 * child->Inherit(parent);
2179 *
2180 * Local<Function> child_function = child->GetFunction();
2181 * Local<Object> child_instance = child_function->NewInstance();
v8.team.kasperl727e9952008-09-02 14:56:44 +00002182 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002183 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002184 * The Child function and Child instance will have the following
2185 * properties:
2186 *
2187 * \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002188 * child_func.prototype.__proto__ == function.prototype;
v8.team.kasperl727e9952008-09-02 14:56:44 +00002189 * child_instance.instance_accessor calls 'InstanceAccessorCallback'
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002190 * child_instance.instance_property == 3;
v8.team.kasperl727e9952008-09-02 14:56:44 +00002191 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002192 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002193class V8EXPORT FunctionTemplate : public Template {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002194 public:
2195 /** Creates a function template.*/
v8.team.kasperl727e9952008-09-02 14:56:44 +00002196 static Local<FunctionTemplate> New(
2197 InvocationCallback callback = 0,
2198 Handle<Value> data = Handle<Value>(),
2199 Handle<Signature> signature = Handle<Signature>());
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002200 /** Returns the unique function instance in the current execution context.*/
2201 Local<Function> GetFunction();
2202
v8.team.kasperl727e9952008-09-02 14:56:44 +00002203 /**
2204 * Set the call-handler callback for a FunctionTemplate. This
2205 * callback is called whenever the function created from this
2206 * FunctionTemplate is called.
2207 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002208 void SetCallHandler(InvocationCallback callback,
2209 Handle<Value> data = Handle<Value>());
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002210
v8.team.kasperl727e9952008-09-02 14:56:44 +00002211 /** Get the InstanceTemplate. */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002212 Local<ObjectTemplate> InstanceTemplate();
2213
2214 /** Causes the function template to inherit from a parent function template.*/
2215 void Inherit(Handle<FunctionTemplate> parent);
2216
2217 /**
2218 * A PrototypeTemplate is the template used to create the prototype object
2219 * of the function created by this template.
2220 */
2221 Local<ObjectTemplate> PrototypeTemplate();
2222
v8.team.kasperl727e9952008-09-02 14:56:44 +00002223
2224 /**
2225 * Set the class name of the FunctionTemplate. This is used for
2226 * printing objects created with the function created from the
2227 * FunctionTemplate as its constructor.
2228 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002229 void SetClassName(Handle<String> name);
2230
2231 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002232 * Determines whether the __proto__ accessor ignores instances of
2233 * the function template. If instances of the function template are
2234 * ignored, __proto__ skips all instances and instead returns the
2235 * next object in the prototype chain.
2236 *
2237 * Call with a value of true to make the __proto__ accessor ignore
2238 * instances of the function template. Call with a value of false
2239 * to make the __proto__ accessor not ignore instances of the
2240 * function template. By default, instances of a function template
2241 * are not ignored.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002242 */
2243 void SetHiddenPrototype(bool value);
2244
2245 /**
ricow@chromium.org2c99e282011-07-28 09:15:17 +00002246 * Sets the ReadOnly flag in the attributes of the 'prototype' property
2247 * of functions created from this FunctionTemplate to true.
ager@chromium.org04921a82011-06-27 13:21:41 +00002248 */
ricow@chromium.org2c99e282011-07-28 09:15:17 +00002249 void ReadOnlyPrototype();
ager@chromium.org04921a82011-06-27 13:21:41 +00002250
2251 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002252 * Returns true if the given object is an instance of this function
2253 * template.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002254 */
2255 bool HasInstance(Handle<Value> object);
2256
2257 private:
2258 FunctionTemplate();
2259 void AddInstancePropertyAccessor(Handle<String> name,
2260 AccessorGetter getter,
2261 AccessorSetter setter,
2262 Handle<Value> data,
2263 AccessControl settings,
2264 PropertyAttribute attributes);
2265 void SetNamedInstancePropertyHandler(NamedPropertyGetter getter,
2266 NamedPropertySetter setter,
2267 NamedPropertyQuery query,
2268 NamedPropertyDeleter remover,
2269 NamedPropertyEnumerator enumerator,
whesse@chromium.org2c186ca2010-06-16 11:32:39 +00002270 Handle<Value> data);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002271 void SetIndexedInstancePropertyHandler(IndexedPropertyGetter getter,
2272 IndexedPropertySetter setter,
2273 IndexedPropertyQuery query,
2274 IndexedPropertyDeleter remover,
2275 IndexedPropertyEnumerator enumerator,
ager@chromium.orgea4f62e2010-08-16 16:28:43 +00002276 Handle<Value> data);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002277 void SetInstanceCallAsFunctionHandler(InvocationCallback callback,
2278 Handle<Value> data);
2279
2280 friend class Context;
2281 friend class ObjectTemplate;
2282};
2283
2284
2285/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002286 * An ObjectTemplate is used to create objects at runtime.
2287 *
2288 * Properties added to an ObjectTemplate are added to each object
2289 * created from the ObjectTemplate.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002290 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002291class V8EXPORT ObjectTemplate : public Template {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002292 public:
v8.team.kasperl727e9952008-09-02 14:56:44 +00002293 /** Creates an ObjectTemplate. */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002294 static Local<ObjectTemplate> New();
v8.team.kasperl727e9952008-09-02 14:56:44 +00002295
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002296 /** Creates a new instance of this template.*/
2297 Local<Object> NewInstance();
2298
2299 /**
2300 * Sets an accessor on the object template.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002301 *
2302 * Whenever the property with the given name is accessed on objects
2303 * created from this ObjectTemplate the getter and setter callbacks
2304 * are called instead of getting and setting the property directly
2305 * on the JavaScript object.
2306 *
2307 * \param name The name of the property for which an accessor is added.
2308 * \param getter The callback to invoke when getting the property.
2309 * \param setter The callback to invoke when setting the property.
2310 * \param data A piece of data that will be passed to the getter and setter
2311 * callbacks whenever they are invoked.
2312 * \param settings Access control settings for the accessor. This is a bit
2313 * field consisting of one of more of
2314 * DEFAULT = 0, ALL_CAN_READ = 1, or ALL_CAN_WRITE = 2.
2315 * The default is to not allow cross-context access.
2316 * ALL_CAN_READ means that all cross-context reads are allowed.
2317 * ALL_CAN_WRITE means that all cross-context writes are allowed.
2318 * The combination ALL_CAN_READ | ALL_CAN_WRITE can be used to allow all
2319 * cross-context access.
2320 * \param attribute The attributes of the property for which an accessor
2321 * is added.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002322 */
2323 void SetAccessor(Handle<String> name,
2324 AccessorGetter getter,
2325 AccessorSetter setter = 0,
2326 Handle<Value> data = Handle<Value>(),
2327 AccessControl settings = DEFAULT,
2328 PropertyAttribute attribute = None);
2329
2330 /**
2331 * Sets a named property handler on the object template.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002332 *
2333 * Whenever a named property is accessed on objects created from
2334 * this object template, the provided callback is invoked instead of
2335 * accessing the property directly on the JavaScript object.
2336 *
2337 * \param getter The callback to invoke when getting a property.
2338 * \param setter The callback to invoke when setting a property.
whesse@chromium.org2c186ca2010-06-16 11:32:39 +00002339 * \param query The callback to invoke to check if a property is present,
2340 * and if present, get its attributes.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002341 * \param deleter The callback to invoke when deleting a property.
2342 * \param enumerator The callback to invoke to enumerate all the named
2343 * properties of an object.
2344 * \param data A piece of data that will be passed to the callbacks
2345 * whenever they are invoked.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002346 */
2347 void SetNamedPropertyHandler(NamedPropertyGetter getter,
2348 NamedPropertySetter setter = 0,
2349 NamedPropertyQuery query = 0,
2350 NamedPropertyDeleter deleter = 0,
2351 NamedPropertyEnumerator enumerator = 0,
whesse@chromium.org2c186ca2010-06-16 11:32:39 +00002352 Handle<Value> data = Handle<Value>());
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002353
2354 /**
2355 * Sets an indexed property handler on the object template.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002356 *
2357 * Whenever an indexed property is accessed on objects created from
2358 * this object template, the provided callback is invoked instead of
2359 * accessing the property directly on the JavaScript object.
2360 *
2361 * \param getter The callback to invoke when getting a property.
2362 * \param setter The callback to invoke when setting a property.
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00002363 * \param query The callback to invoke to check if an object has a property.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002364 * \param deleter The callback to invoke when deleting a property.
2365 * \param enumerator The callback to invoke to enumerate all the indexed
2366 * properties of an object.
2367 * \param data A piece of data that will be passed to the callbacks
2368 * whenever they are invoked.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002369 */
2370 void SetIndexedPropertyHandler(IndexedPropertyGetter getter,
2371 IndexedPropertySetter setter = 0,
2372 IndexedPropertyQuery query = 0,
2373 IndexedPropertyDeleter deleter = 0,
2374 IndexedPropertyEnumerator enumerator = 0,
ager@chromium.orgea4f62e2010-08-16 16:28:43 +00002375 Handle<Value> data = Handle<Value>());
vegorov@chromium.org26c16f82010-08-11 13:41:03 +00002376
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002377 /**
2378 * Sets the callback to be used when calling instances created from
2379 * this template as a function. If no callback is set, instances
v8.team.kasperl727e9952008-09-02 14:56:44 +00002380 * behave like normal JavaScript objects that cannot be called as a
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002381 * function.
2382 */
2383 void SetCallAsFunctionHandler(InvocationCallback callback,
2384 Handle<Value> data = Handle<Value>());
2385
v8.team.kasperl727e9952008-09-02 14:56:44 +00002386 /**
2387 * Mark object instances of the template as undetectable.
2388 *
2389 * In many ways, undetectable objects behave as though they are not
2390 * there. They behave like 'undefined' in conditionals and when
2391 * printed. However, properties can be accessed and called as on
2392 * normal objects.
2393 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002394 void MarkAsUndetectable();
2395
v8.team.kasperl727e9952008-09-02 14:56:44 +00002396 /**
2397 * Sets access check callbacks on the object template.
2398 *
2399 * When accessing properties on instances of this object template,
2400 * the access check callback will be called to determine whether or
2401 * not to allow cross-context access to the properties.
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002402 * The last parameter specifies whether access checks are turned
2403 * on by default on instances. If access checks are off by default,
2404 * they can be turned on on individual instances by calling
2405 * Object::TurnOnAccessCheck().
v8.team.kasperl727e9952008-09-02 14:56:44 +00002406 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002407 void SetAccessCheckCallbacks(NamedSecurityCallback named_handler,
2408 IndexedSecurityCallback indexed_handler,
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002409 Handle<Value> data = Handle<Value>(),
2410 bool turned_on_by_default = true);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002411
kasper.lund212ac232008-07-16 07:07:30 +00002412 /**
2413 * Gets the number of internal fields for objects generated from
2414 * this template.
2415 */
2416 int InternalFieldCount();
2417
2418 /**
2419 * Sets the number of internal fields for objects generated from
2420 * this template.
2421 */
2422 void SetInternalFieldCount(int value);
2423
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002424 private:
2425 ObjectTemplate();
2426 static Local<ObjectTemplate> New(Handle<FunctionTemplate> constructor);
2427 friend class FunctionTemplate;
2428};
2429
2430
2431/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002432 * A Signature specifies which receivers and arguments a function can
2433 * legally be called with.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002434 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002435class V8EXPORT Signature : public Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002436 public:
2437 static Local<Signature> New(Handle<FunctionTemplate> receiver =
2438 Handle<FunctionTemplate>(),
2439 int argc = 0,
2440 Handle<FunctionTemplate> argv[] = 0);
2441 private:
2442 Signature();
2443};
2444
2445
2446/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002447 * A utility for determining the type of objects based on the template
2448 * they were constructed from.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002449 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002450class V8EXPORT TypeSwitch : public Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002451 public:
2452 static Local<TypeSwitch> New(Handle<FunctionTemplate> type);
2453 static Local<TypeSwitch> New(int argc, Handle<FunctionTemplate> types[]);
2454 int match(Handle<Value> value);
2455 private:
2456 TypeSwitch();
2457};
2458
2459
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00002460// --- Extensions ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002461
erik.corry@gmail.comc3b670f2011-10-05 21:44:48 +00002462class V8EXPORT ExternalAsciiStringResourceImpl
2463 : public String::ExternalAsciiStringResource {
2464 public:
2465 ExternalAsciiStringResourceImpl() : data_(0), length_(0) {}
2466 ExternalAsciiStringResourceImpl(const char* data, size_t length)
2467 : data_(data), length_(length) {}
2468 const char* data() const { return data_; }
2469 size_t length() const { return length_; }
2470
2471 private:
2472 const char* data_;
2473 size_t length_;
2474};
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002475
2476/**
2477 * Ignore
2478 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002479class V8EXPORT Extension { // NOLINT
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002480 public:
erik.corry@gmail.comc3b670f2011-10-05 21:44:48 +00002481 // Note that the strings passed into this constructor must live as long
2482 // as the Extension itself.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002483 Extension(const char* name,
2484 const char* source = 0,
2485 int dep_count = 0,
erik.corry@gmail.comc3b670f2011-10-05 21:44:48 +00002486 const char** deps = 0,
2487 int source_length = -1);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002488 virtual ~Extension() { }
2489 virtual v8::Handle<v8::FunctionTemplate>
2490 GetNativeFunction(v8::Handle<v8::String> name) {
2491 return v8::Handle<v8::FunctionTemplate>();
2492 }
2493
erik.corry@gmail.comc3b670f2011-10-05 21:44:48 +00002494 const char* name() const { return name_; }
2495 size_t source_length() const { return source_length_; }
2496 const String::ExternalAsciiStringResource* source() const {
2497 return &source_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002498 int dependency_count() { return dep_count_; }
2499 const char** dependencies() { return deps_; }
2500 void set_auto_enable(bool value) { auto_enable_ = value; }
2501 bool auto_enable() { return auto_enable_; }
2502
2503 private:
2504 const char* name_;
erik.corry@gmail.comc3b670f2011-10-05 21:44:48 +00002505 size_t source_length_; // expected to initialize before source_
2506 ExternalAsciiStringResourceImpl source_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002507 int dep_count_;
2508 const char** deps_;
2509 bool auto_enable_;
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00002510
2511 // Disallow copying and assigning.
2512 Extension(const Extension&);
2513 void operator=(const Extension&);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002514};
2515
2516
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002517void V8EXPORT RegisterExtension(Extension* extension);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002518
2519
2520/**
2521 * Ignore
2522 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002523class V8EXPORT DeclareExtension {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002524 public:
2525 inline DeclareExtension(Extension* extension) {
2526 RegisterExtension(extension);
2527 }
2528};
2529
2530
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00002531// --- Statics ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002532
2533
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002534Handle<Primitive> V8EXPORT Undefined();
2535Handle<Primitive> V8EXPORT Null();
2536Handle<Boolean> V8EXPORT True();
2537Handle<Boolean> V8EXPORT False();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002538
2539
2540/**
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00002541 * A set of constraints that specifies the limits of the runtime's memory use.
2542 * You must set the heap size before initializing the VM - the size cannot be
2543 * adjusted after the VM is initialized.
2544 *
2545 * If you are using threads then you should hold the V8::Locker lock while
2546 * setting the stack limit and you must set a non-default stack limit separately
2547 * for each thread.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002548 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002549class V8EXPORT ResourceConstraints {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002550 public:
2551 ResourceConstraints();
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002552 int max_young_space_size() const { return max_young_space_size_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002553 void set_max_young_space_size(int value) { max_young_space_size_ = value; }
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002554 int max_old_space_size() const { return max_old_space_size_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002555 void set_max_old_space_size(int value) { max_old_space_size_ = value; }
ager@chromium.org01fe7df2010-11-10 11:59:11 +00002556 int max_executable_size() { return max_executable_size_; }
2557 void set_max_executable_size(int value) { max_executable_size_ = value; }
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002558 uint32_t* stack_limit() const { return stack_limit_; }
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00002559 // Sets an address beyond which the VM's stack may not grow.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002560 void set_stack_limit(uint32_t* value) { stack_limit_ = value; }
2561 private:
2562 int max_young_space_size_;
2563 int max_old_space_size_;
ager@chromium.org01fe7df2010-11-10 11:59:11 +00002564 int max_executable_size_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002565 uint32_t* stack_limit_;
2566};
2567
2568
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +00002569bool V8EXPORT SetResourceConstraints(ResourceConstraints* constraints);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002570
2571
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00002572// --- Exceptions ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002573
2574
2575typedef void (*FatalErrorCallback)(const char* location, const char* message);
2576
2577
2578typedef void (*MessageCallback)(Handle<Message> message, Handle<Value> data);
2579
2580
2581/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002582 * Schedules an exception to be thrown when returning to JavaScript. When an
2583 * exception has been scheduled it is illegal to invoke any JavaScript
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002584 * operation; the caller must return immediately and only after the exception
v8.team.kasperl727e9952008-09-02 14:56:44 +00002585 * has been handled does it become legal to invoke JavaScript operations.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002586 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002587Handle<Value> V8EXPORT ThrowException(Handle<Value> exception);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002588
2589/**
2590 * Create new error objects by calling the corresponding error object
2591 * constructor with the message.
2592 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002593class V8EXPORT Exception {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002594 public:
2595 static Local<Value> RangeError(Handle<String> message);
2596 static Local<Value> ReferenceError(Handle<String> message);
2597 static Local<Value> SyntaxError(Handle<String> message);
2598 static Local<Value> TypeError(Handle<String> message);
2599 static Local<Value> Error(Handle<String> message);
2600};
2601
2602
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00002603// --- Counters Callbacks ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002604
ager@chromium.orga74f0da2008-12-03 16:05:52 +00002605typedef int* (*CounterLookupCallback)(const char* name);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002606
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002607typedef void* (*CreateHistogramCallback)(const char* name,
2608 int min,
2609 int max,
2610 size_t buckets);
2611
2612typedef void (*AddHistogramSampleCallback)(void* histogram, int sample);
2613
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00002614// --- Memory Allocation Callback ---
kmillikin@chromium.org3cdd9e12010-09-06 11:39:48 +00002615 enum ObjectSpace {
2616 kObjectSpaceNewSpace = 1 << 0,
2617 kObjectSpaceOldPointerSpace = 1 << 1,
2618 kObjectSpaceOldDataSpace = 1 << 2,
2619 kObjectSpaceCodeSpace = 1 << 3,
2620 kObjectSpaceMapSpace = 1 << 4,
2621 kObjectSpaceLoSpace = 1 << 5,
2622
2623 kObjectSpaceAll = kObjectSpaceNewSpace | kObjectSpaceOldPointerSpace |
2624 kObjectSpaceOldDataSpace | kObjectSpaceCodeSpace | kObjectSpaceMapSpace |
2625 kObjectSpaceLoSpace
2626 };
2627
2628 enum AllocationAction {
2629 kAllocationActionAllocate = 1 << 0,
2630 kAllocationActionFree = 1 << 1,
2631 kAllocationActionAll = kAllocationActionAllocate | kAllocationActionFree
2632 };
2633
2634typedef void (*MemoryAllocationCallback)(ObjectSpace space,
2635 AllocationAction action,
2636 int size);
2637
rossberg@chromium.orgfab14982012-01-05 15:02:15 +00002638// --- Leave Script Callback ---
2639typedef void (*CallCompletedCallback)();
2640
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00002641// --- Failed Access Check Callback ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002642typedef void (*FailedAccessCheckCallback)(Local<Object> target,
2643 AccessType type,
2644 Local<Value> data);
2645
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00002646// --- AllowCodeGenerationFromStrings callbacks ---
2647
2648/**
2649 * Callback to check if code generation from strings is allowed. See
2650 * Context::AllowCodeGenerationFromStrings.
2651 */
2652typedef bool (*AllowCodeGenerationFromStringsCallback)(Local<Context> context);
2653
2654// --- Garbage Collection Callbacks ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002655
2656/**
kmillikin@chromium.org5d8f0e62010-03-24 08:21:20 +00002657 * Applications can register callback functions which will be called
2658 * before and after a garbage collection. Allocations are not
2659 * allowed in the callback functions, you therefore cannot manipulate
v8.team.kasperl727e9952008-09-02 14:56:44 +00002660 * objects (set or delete properties for example) since it is possible
2661 * such operations will result in the allocation of objects.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002662 */
kmillikin@chromium.org5d8f0e62010-03-24 08:21:20 +00002663enum GCType {
2664 kGCTypeScavenge = 1 << 0,
2665 kGCTypeMarkSweepCompact = 1 << 1,
2666 kGCTypeAll = kGCTypeScavenge | kGCTypeMarkSweepCompact
2667};
2668
2669enum GCCallbackFlags {
2670 kNoGCCallbackFlags = 0,
2671 kGCCallbackFlagCompacted = 1 << 0
2672};
2673
2674typedef void (*GCPrologueCallback)(GCType type, GCCallbackFlags flags);
2675typedef void (*GCEpilogueCallback)(GCType type, GCCallbackFlags flags);
2676
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002677typedef void (*GCCallback)();
2678
2679
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002680/**
ager@chromium.org3811b432009-10-28 14:53:37 +00002681 * Collection of V8 heap information.
2682 *
2683 * Instances of this class can be passed to v8::V8::HeapStatistics to
2684 * get heap statistics from V8.
2685 */
2686class V8EXPORT HeapStatistics {
2687 public:
2688 HeapStatistics();
2689 size_t total_heap_size() { return total_heap_size_; }
ager@chromium.org01fe7df2010-11-10 11:59:11 +00002690 size_t total_heap_size_executable() { return total_heap_size_executable_; }
ager@chromium.org3811b432009-10-28 14:53:37 +00002691 size_t used_heap_size() { return used_heap_size_; }
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00002692 size_t heap_size_limit() { return heap_size_limit_; }
ager@chromium.org3811b432009-10-28 14:53:37 +00002693
2694 private:
2695 void set_total_heap_size(size_t size) { total_heap_size_ = size; }
ager@chromium.org01fe7df2010-11-10 11:59:11 +00002696 void set_total_heap_size_executable(size_t size) {
2697 total_heap_size_executable_ = size;
2698 }
ager@chromium.org3811b432009-10-28 14:53:37 +00002699 void set_used_heap_size(size_t size) { used_heap_size_ = size; }
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00002700 void set_heap_size_limit(size_t size) { heap_size_limit_ = size; }
ager@chromium.org3811b432009-10-28 14:53:37 +00002701
2702 size_t total_heap_size_;
ager@chromium.org01fe7df2010-11-10 11:59:11 +00002703 size_t total_heap_size_executable_;
ager@chromium.org3811b432009-10-28 14:53:37 +00002704 size_t used_heap_size_;
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00002705 size_t heap_size_limit_;
ager@chromium.org3811b432009-10-28 14:53:37 +00002706
2707 friend class V8;
2708};
2709
2710
whesse@chromium.orgb08986c2011-03-14 16:13:42 +00002711class RetainedObjectInfo;
2712
ager@chromium.org3811b432009-10-28 14:53:37 +00002713/**
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00002714 * Isolate represents an isolated instance of the V8 engine. V8
2715 * isolates have completely separate states. Objects from one isolate
2716 * must not be used in other isolates. When V8 is initialized a
2717 * default isolate is implicitly created and entered. The embedder
2718 * can create additional isolates and use them in parallel in multiple
2719 * threads. An isolate can be entered by at most one thread at any
2720 * given time. The Locker/Unlocker API can be used to synchronize.
2721 */
2722class V8EXPORT Isolate {
2723 public:
2724 /**
2725 * Stack-allocated class which sets the isolate for all operations
2726 * executed within a local scope.
2727 */
2728 class V8EXPORT Scope {
2729 public:
2730 explicit Scope(Isolate* isolate) : isolate_(isolate) {
2731 isolate->Enter();
2732 }
2733
2734 ~Scope() { isolate_->Exit(); }
2735
2736 private:
2737 Isolate* const isolate_;
2738
2739 // Prevent copying of Scope objects.
2740 Scope(const Scope&);
2741 Scope& operator=(const Scope&);
2742 };
2743
2744 /**
2745 * Creates a new isolate. Does not change the currently entered
2746 * isolate.
2747 *
2748 * When an isolate is no longer used its resources should be freed
2749 * by calling Dispose(). Using the delete operator is not allowed.
2750 */
2751 static Isolate* New();
2752
2753 /**
2754 * Returns the entered isolate for the current thread or NULL in
2755 * case there is no current isolate.
2756 */
2757 static Isolate* GetCurrent();
2758
2759 /**
2760 * Methods below this point require holding a lock (using Locker) in
2761 * a multi-threaded environment.
2762 */
2763
2764 /**
2765 * Sets this isolate as the entered one for the current thread.
2766 * Saves the previously entered one (if any), so that it can be
2767 * restored when exiting. Re-entering an isolate is allowed.
2768 */
2769 void Enter();
2770
2771 /**
2772 * Exits this isolate by restoring the previously entered one in the
2773 * current thread. The isolate may still stay the same, if it was
2774 * entered more than once.
2775 *
2776 * Requires: this == Isolate::GetCurrent().
2777 */
2778 void Exit();
2779
2780 /**
2781 * Disposes the isolate. The isolate must not be entered by any
2782 * thread to be disposable.
2783 */
2784 void Dispose();
2785
ager@chromium.orgea91cc52011-05-23 06:06:11 +00002786 /**
2787 * Associate embedder-specific data with the isolate
2788 */
2789 void SetData(void* data);
2790
2791 /**
2792 * Retrive embedder-specific data from the isolate.
2793 * Returns NULL if SetData has never been called.
2794 */
2795 void* GetData();
2796
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00002797 private:
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00002798 Isolate();
2799 Isolate(const Isolate&);
2800 ~Isolate();
2801 Isolate& operator=(const Isolate&);
2802 void* operator new(size_t size);
2803 void operator delete(void*, size_t);
2804};
2805
2806
sgjesse@chromium.org8e8294a2011-05-02 14:30:53 +00002807class StartupData {
2808 public:
2809 enum CompressionAlgorithm {
2810 kUncompressed,
2811 kBZip2
2812 };
2813
2814 const char* data;
2815 int compressed_size;
2816 int raw_size;
2817};
2818
jkummerow@chromium.orge297f592011-06-08 10:05:15 +00002819
2820/**
2821 * A helper class for driving V8 startup data decompression. It is based on
2822 * "CompressedStartupData" API functions from the V8 class. It isn't mandatory
2823 * for an embedder to use this class, instead, API functions can be used
2824 * directly.
2825 *
2826 * For an example of the class usage, see the "shell.cc" sample application.
2827 */
2828class V8EXPORT StartupDataDecompressor { // NOLINT
2829 public:
2830 StartupDataDecompressor();
2831 virtual ~StartupDataDecompressor();
2832 int Decompress();
2833
2834 protected:
2835 virtual int DecompressData(char* raw_data,
2836 int* raw_data_size,
2837 const char* compressed_data,
2838 int compressed_data_size) = 0;
2839
2840 private:
2841 char** raw_data;
2842};
2843
svenpanne@chromium.org84bcc552011-07-18 09:50:57 +00002844
2845/**
2846 * EntropySource is used as a callback function when v8 needs a source
2847 * of entropy.
2848 */
2849typedef bool (*EntropySource)(unsigned char* buffer, size_t length);
2850
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00002851/**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002852 * Container class for static utility functions.
2853 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002854class V8EXPORT V8 {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002855 public:
v8.team.kasperl727e9952008-09-02 14:56:44 +00002856 /** Set the callback to invoke in case of fatal errors. */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002857 static void SetFatalErrorHandler(FatalErrorCallback that);
2858
v8.team.kasperl727e9952008-09-02 14:56:44 +00002859 /**
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00002860 * Set the callback to invoke to check if code generation from
2861 * strings should be allowed.
2862 */
2863 static void SetAllowCodeGenerationFromStringsCallback(
2864 AllowCodeGenerationFromStringsCallback that);
2865
2866 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002867 * Ignore out-of-memory exceptions.
2868 *
2869 * V8 running out of memory is treated as a fatal error by default.
2870 * This means that the fatal error handler is called and that V8 is
2871 * terminated.
2872 *
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00002873 * IgnoreOutOfMemoryException can be used to not treat an
v8.team.kasperl727e9952008-09-02 14:56:44 +00002874 * out-of-memory situation as a fatal error. This way, the contexts
2875 * that did not cause the out of memory problem might be able to
2876 * continue execution.
2877 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002878 static void IgnoreOutOfMemoryException();
2879
v8.team.kasperl727e9952008-09-02 14:56:44 +00002880 /**
ager@chromium.org9258b6b2008-09-11 09:11:10 +00002881 * Check if V8 is dead and therefore unusable. This is the case after
v8.team.kasperl727e9952008-09-02 14:56:44 +00002882 * fatal errors such as out-of-memory situations.
2883 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002884 static bool IsDead();
2885
2886 /**
sgjesse@chromium.org8e8294a2011-05-02 14:30:53 +00002887 * The following 4 functions are to be used when V8 is built with
2888 * the 'compress_startup_data' flag enabled. In this case, the
2889 * embedder must decompress startup data prior to initializing V8.
2890 *
2891 * This is how interaction with V8 should look like:
2892 * int compressed_data_count = v8::V8::GetCompressedStartupDataCount();
2893 * v8::StartupData* compressed_data =
2894 * new v8::StartupData[compressed_data_count];
2895 * v8::V8::GetCompressedStartupData(compressed_data);
2896 * ... decompress data (compressed_data can be updated in-place) ...
2897 * v8::V8::SetDecompressedStartupData(compressed_data);
2898 * ... now V8 can be initialized
2899 * ... make sure the decompressed data stays valid until V8 shutdown
jkummerow@chromium.orge297f592011-06-08 10:05:15 +00002900 *
2901 * A helper class StartupDataDecompressor is provided. It implements
2902 * the protocol of the interaction described above, and can be used in
2903 * most cases instead of calling these API functions directly.
sgjesse@chromium.org8e8294a2011-05-02 14:30:53 +00002904 */
2905 static StartupData::CompressionAlgorithm GetCompressedStartupDataAlgorithm();
2906 static int GetCompressedStartupDataCount();
2907 static void GetCompressedStartupData(StartupData* compressed_data);
2908 static void SetDecompressedStartupData(StartupData* decompressed_data);
2909
2910 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002911 * Adds a message listener.
2912 *
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00002913 * The same message listener can be added more than once and in that
v8.team.kasperl727e9952008-09-02 14:56:44 +00002914 * case it will be called more than once for each message.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002915 */
2916 static bool AddMessageListener(MessageCallback that,
2917 Handle<Value> data = Handle<Value>());
2918
2919 /**
2920 * Remove all message listeners from the specified callback function.
2921 */
2922 static void RemoveMessageListeners(MessageCallback that);
2923
2924 /**
ager@chromium.org6a2b0aa2010-07-13 20:58:03 +00002925 * Tells V8 to capture current stack trace when uncaught exception occurs
2926 * and report it to the message listeners. The option is off by default.
2927 */
2928 static void SetCaptureStackTraceForUncaughtExceptions(
2929 bool capture,
2930 int frame_limit = 10,
2931 StackTrace::StackTraceOptions options = StackTrace::kOverview);
2932
2933 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002934 * Sets V8 flags from a string.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002935 */
2936 static void SetFlagsFromString(const char* str, int length);
2937
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +00002938 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002939 * Sets V8 flags from the command line.
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +00002940 */
2941 static void SetFlagsFromCommandLine(int* argc,
2942 char** argv,
2943 bool remove_flags);
2944
kasper.lund7276f142008-07-30 08:49:36 +00002945 /** Get the version string. */
2946 static const char* GetVersion();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002947
2948 /**
2949 * Enables the host application to provide a mechanism for recording
2950 * statistics counters.
2951 */
2952 static void SetCounterFunction(CounterLookupCallback);
2953
2954 /**
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002955 * Enables the host application to provide a mechanism for recording
2956 * histograms. The CreateHistogram function returns a
2957 * histogram which will later be passed to the AddHistogramSample
2958 * function.
2959 */
2960 static void SetCreateHistogramFunction(CreateHistogramCallback);
2961 static void SetAddHistogramSampleFunction(AddHistogramSampleCallback);
2962
2963 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002964 * Enables the computation of a sliding window of states. The sliding
2965 * window information is recorded in statistics counters.
2966 */
2967 static void EnableSlidingStateWindow();
2968
2969 /** Callback function for reporting failed access checks.*/
2970 static void SetFailedAccessCheckCallbackFunction(FailedAccessCheckCallback);
2971
2972 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002973 * Enables the host application to receive a notification before a
kmillikin@chromium.org5d8f0e62010-03-24 08:21:20 +00002974 * garbage collection. Allocations are not allowed in the
2975 * callback function, you therefore cannot manipulate objects (set
2976 * or delete properties for example) since it is possible such
2977 * operations will result in the allocation of objects. It is possible
2978 * to specify the GCType filter for your callback. But it is not possible to
2979 * register the same callback function two times with different
2980 * GCType filters.
2981 */
2982 static void AddGCPrologueCallback(
2983 GCPrologueCallback callback, GCType gc_type_filter = kGCTypeAll);
2984
2985 /**
2986 * This function removes callback which was installed by
2987 * AddGCPrologueCallback function.
2988 */
2989 static void RemoveGCPrologueCallback(GCPrologueCallback callback);
2990
2991 /**
2992 * The function is deprecated. Please use AddGCPrologueCallback instead.
2993 * Enables the host application to receive a notification before a
2994 * garbage collection. Allocations are not allowed in the
v8.team.kasperl727e9952008-09-02 14:56:44 +00002995 * callback function, you therefore cannot manipulate objects (set
2996 * or delete properties for example) since it is possible such
2997 * operations will result in the allocation of objects.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002998 */
2999 static void SetGlobalGCPrologueCallback(GCCallback);
3000
3001 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00003002 * Enables the host application to receive a notification after a
kmillikin@chromium.org5d8f0e62010-03-24 08:21:20 +00003003 * garbage collection. Allocations are not allowed in the
3004 * callback function, you therefore cannot manipulate objects (set
3005 * or delete properties for example) since it is possible such
3006 * operations will result in the allocation of objects. It is possible
3007 * to specify the GCType filter for your callback. But it is not possible to
3008 * register the same callback function two times with different
3009 * GCType filters.
3010 */
3011 static void AddGCEpilogueCallback(
3012 GCEpilogueCallback callback, GCType gc_type_filter = kGCTypeAll);
3013
3014 /**
3015 * This function removes callback which was installed by
3016 * AddGCEpilogueCallback function.
3017 */
3018 static void RemoveGCEpilogueCallback(GCEpilogueCallback callback);
3019
3020 /**
3021 * The function is deprecated. Please use AddGCEpilogueCallback instead.
3022 * Enables the host application to receive a notification after a
v8.team.kasperl727e9952008-09-02 14:56:44 +00003023 * major garbage collection. Allocations are not allowed in the
3024 * callback function, you therefore cannot manipulate objects (set
3025 * or delete properties for example) since it is possible such
3026 * operations will result in the allocation of objects.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003027 */
3028 static void SetGlobalGCEpilogueCallback(GCCallback);
3029
3030 /**
kmillikin@chromium.org3cdd9e12010-09-06 11:39:48 +00003031 * Enables the host application to provide a mechanism to be notified
3032 * and perform custom logging when V8 Allocates Executable Memory.
3033 */
3034 static void AddMemoryAllocationCallback(MemoryAllocationCallback callback,
3035 ObjectSpace space,
3036 AllocationAction action);
3037
3038 /**
rossberg@chromium.orgfab14982012-01-05 15:02:15 +00003039 * Removes callback that was installed by AddMemoryAllocationCallback.
kmillikin@chromium.org3cdd9e12010-09-06 11:39:48 +00003040 */
3041 static void RemoveMemoryAllocationCallback(MemoryAllocationCallback callback);
3042
3043 /**
rossberg@chromium.orgfab14982012-01-05 15:02:15 +00003044 * Adds a callback to notify the host application when a script finished
3045 * running. If a script re-enters the runtime during executing, the
3046 * CallCompletedCallback is only invoked when the outer-most script
3047 * execution ends. Executing scripts inside the callback do not trigger
3048 * further callbacks.
3049 */
3050 static void AddCallCompletedCallback(CallCompletedCallback callback);
3051
3052 /**
3053 * Removes callback that was installed by AddCallCompletedCallback.
3054 */
3055 static void RemoveCallCompletedCallback(CallCompletedCallback callback);
3056
3057 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00003058 * Allows the host application to group objects together. If one
3059 * object in the group is alive, all objects in the group are alive.
3060 * After each garbage collection, object groups are removed. It is
3061 * intended to be used in the before-garbage-collection callback
ager@chromium.org8bb60582008-12-11 12:02:20 +00003062 * function, for instance to simulate DOM tree connections among JS
v8.team.kasperl727e9952008-09-02 14:56:44 +00003063 * wrapper objects.
whesse@chromium.orgb08986c2011-03-14 16:13:42 +00003064 * See v8-profiler.h for RetainedObjectInfo interface description.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003065 */
whesse@chromium.orgb08986c2011-03-14 16:13:42 +00003066 static void AddObjectGroup(Persistent<Value>* objects,
3067 size_t length,
3068 RetainedObjectInfo* info = NULL);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003069
3070 /**
ricow@chromium.orgbadaffc2011-03-17 12:15:27 +00003071 * Allows the host application to declare implicit references between
3072 * the objects: if |parent| is alive, all |children| are alive too.
3073 * After each garbage collection, all implicit references
3074 * are removed. It is intended to be used in the before-garbage-collection
3075 * callback function.
3076 */
3077 static void AddImplicitReferences(Persistent<Object> parent,
3078 Persistent<Value>* children,
3079 size_t length);
3080
3081 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00003082 * Initializes from snapshot if possible. Otherwise, attempts to
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00003083 * initialize from scratch. This function is called implicitly if
3084 * you use the API without calling it first.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003085 */
3086 static bool Initialize();
3087
kasper.lund7276f142008-07-30 08:49:36 +00003088 /**
svenpanne@chromium.org84bcc552011-07-18 09:50:57 +00003089 * Allows the host application to provide a callback which can be used
3090 * as a source of entropy for random number generators.
3091 */
3092 static void SetEntropySource(EntropySource source);
3093
3094 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00003095 * Adjusts the amount of registered external memory. Used to give
3096 * V8 an indication of the amount of externally allocated memory
3097 * that is kept alive by JavaScript objects. V8 uses this to decide
3098 * when to perform global garbage collections. Registering
3099 * externally allocated memory will trigger global garbage
3100 * collections more often than otherwise in an attempt to garbage
3101 * collect the JavaScript objects keeping the externally allocated
3102 * memory alive.
3103 *
3104 * \param change_in_bytes the change in externally allocated memory
3105 * that is kept alive by JavaScript objects.
3106 * \returns the adjusted value.
kasper.lund7276f142008-07-30 08:49:36 +00003107 */
3108 static int AdjustAmountOfExternalAllocatedMemory(int change_in_bytes);
3109
iposva@chromium.org245aa852009-02-10 00:49:54 +00003110 /**
3111 * Suspends recording of tick samples in the profiler.
3112 * When the V8 profiling mode is enabled (usually via command line
3113 * switches) this function suspends recording of tick samples.
3114 * Profiling ticks are discarded until ResumeProfiler() is called.
3115 *
3116 * See also the --prof and --prof_auto command line switches to
3117 * enable V8 profiling.
3118 */
3119 static void PauseProfiler();
3120
3121 /**
3122 * Resumes recording of tick samples in the profiler.
3123 * See also PauseProfiler().
3124 */
3125 static void ResumeProfiler();
3126
ager@chromium.org41826e72009-03-30 13:30:57 +00003127 /**
kasperl@chromium.org71affb52009-05-26 05:44:31 +00003128 * Return whether profiler is currently paused.
3129 */
3130 static bool IsProfilerPaused();
3131
3132 /**
sgjesse@chromium.orgc81c8942009-08-21 10:54:26 +00003133 * Retrieve the V8 thread id of the calling thread.
3134 *
3135 * The thread id for a thread should only be retrieved after the V8
3136 * lock has been acquired with a Locker object with that thread.
3137 */
3138 static int GetCurrentThreadId();
3139
3140 /**
3141 * Forcefully terminate execution of a JavaScript thread. This can
3142 * be used to terminate long-running scripts.
3143 *
3144 * TerminateExecution should only be called when then V8 lock has
3145 * been acquired with a Locker object. Therefore, in order to be
3146 * able to terminate long-running threads, preemption must be
3147 * enabled to allow the user of TerminateExecution to acquire the
3148 * lock.
3149 *
3150 * The termination is achieved by throwing an exception that is
3151 * uncatchable by JavaScript exception handlers. Termination
3152 * exceptions act as if they were caught by a C++ TryCatch exception
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00003153 * handler. If forceful termination is used, any C++ TryCatch
sgjesse@chromium.orgc81c8942009-08-21 10:54:26 +00003154 * exception handler that catches an exception should check if that
3155 * exception is a termination exception and immediately return if
3156 * that is the case. Returning immediately in that case will
3157 * continue the propagation of the termination exception if needed.
3158 *
3159 * The thread id passed to TerminateExecution must have been
3160 * obtained by calling GetCurrentThreadId on the thread in question.
3161 *
3162 * \param thread_id The thread id of the thread to terminate.
3163 */
3164 static void TerminateExecution(int thread_id);
3165
3166 /**
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003167 * Forcefully terminate the current thread of JavaScript execution
3168 * in the given isolate. If no isolate is provided, the default
3169 * isolate is used.
sgjesse@chromium.orgc81c8942009-08-21 10:54:26 +00003170 *
3171 * This method can be used by any thread even if that thread has not
3172 * acquired the V8 lock with a Locker object.
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003173 *
3174 * \param isolate The isolate in which to terminate the current JS execution.
sgjesse@chromium.orgc81c8942009-08-21 10:54:26 +00003175 */
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003176 static void TerminateExecution(Isolate* isolate = NULL);
ager@chromium.org9085a012009-05-11 19:22:57 +00003177
3178 /**
sgjesse@chromium.org2ab99522010-03-10 09:03:43 +00003179 * Is V8 terminating JavaScript execution.
3180 *
3181 * Returns true if JavaScript execution is currently terminating
3182 * because of a call to TerminateExecution. In that case there are
3183 * still JavaScript frames on the stack and the termination
3184 * exception is still active.
svenpanne@chromium.org6d786c92011-06-15 10:58:27 +00003185 *
3186 * \param isolate The isolate in which to check.
sgjesse@chromium.org2ab99522010-03-10 09:03:43 +00003187 */
svenpanne@chromium.org6d786c92011-06-15 10:58:27 +00003188 static bool IsExecutionTerminating(Isolate* isolate = NULL);
sgjesse@chromium.org2ab99522010-03-10 09:03:43 +00003189
3190 /**
ager@chromium.org41826e72009-03-30 13:30:57 +00003191 * Releases any resources used by v8 and stops any utility threads
3192 * that may be running. Note that disposing v8 is permanent, it
3193 * cannot be reinitialized.
3194 *
3195 * It should generally not be necessary to dispose v8 before exiting
3196 * a process, this should happen automatically. It is only necessary
3197 * to use if the process needs the resources taken up by v8.
3198 */
3199 static bool Dispose();
3200
ager@chromium.org3811b432009-10-28 14:53:37 +00003201 /**
3202 * Get statistics about the heap memory usage.
3203 */
3204 static void GetHeapStatistics(HeapStatistics* heap_statistics);
ager@chromium.orgadd848f2009-08-13 12:44:13 +00003205
3206 /**
3207 * Optional notification that the embedder is idle.
3208 * V8 uses the notification to reduce memory footprint.
ager@chromium.orgab99eea2009-08-25 07:05:41 +00003209 * This call can be used repeatedly if the embedder remains idle.
ager@chromium.orgab99eea2009-08-25 07:05:41 +00003210 * Returns true if the embedder should stop calling IdleNotification
3211 * until real work has been done. This indicates that V8 has done
3212 * as much cleanup as it will be able to do.
svenpanne@chromium.orgecb9dd62011-12-01 08:22:35 +00003213 *
3214 * The hint argument specifies the amount of work to be done in the function
3215 * on scale from 1 to 1000. There is no guarantee that the actual work will
3216 * match the hint.
ager@chromium.orgadd848f2009-08-13 12:44:13 +00003217 */
svenpanne@chromium.orgecb9dd62011-12-01 08:22:35 +00003218 static bool IdleNotification(int hint = 1000);
ager@chromium.orgadd848f2009-08-13 12:44:13 +00003219
sgjesse@chromium.orgc81c8942009-08-21 10:54:26 +00003220 /**
3221 * Optional notification that the system is running low on memory.
3222 * V8 uses these notifications to attempt to free memory.
3223 */
3224 static void LowMemoryNotification();
3225
kasperl@chromium.org8b2bb262010-03-01 09:46:28 +00003226 /**
3227 * Optional notification that a context has been disposed. V8 uses
ager@chromium.orgce5e87b2010-03-10 10:24:18 +00003228 * these notifications to guide the GC heuristic. Returns the number
3229 * of context disposals - including this one - since the last time
3230 * V8 had a chance to clean up.
kasperl@chromium.org8b2bb262010-03-01 09:46:28 +00003231 */
ager@chromium.orgce5e87b2010-03-10 10:24:18 +00003232 static int ContextDisposedNotification();
kasperl@chromium.org8b2bb262010-03-01 09:46:28 +00003233
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003234 private:
3235 V8();
3236
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003237 static internal::Object** GlobalizeReference(internal::Object** handle);
3238 static void DisposeGlobal(internal::Object** global_handle);
3239 static void MakeWeak(internal::Object** global_handle,
3240 void* data,
3241 WeakReferenceCallback);
3242 static void ClearWeak(internal::Object** global_handle);
kmillikin@chromium.orgc53e10d2011-05-18 09:12:58 +00003243 static void MarkIndependent(internal::Object** global_handle);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003244 static bool IsGlobalNearDeath(internal::Object** global_handle);
3245 static bool IsGlobalWeak(internal::Object** global_handle);
whesse@chromium.orgb08986c2011-03-14 16:13:42 +00003246 static void SetWrapperClassId(internal::Object** global_handle,
3247 uint16_t class_id);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003248
3249 template <class T> friend class Handle;
3250 template <class T> friend class Local;
3251 template <class T> friend class Persistent;
3252 friend class Context;
3253};
3254
3255
3256/**
3257 * An external exception handler.
3258 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00003259class V8EXPORT TryCatch {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003260 public:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003261 /**
3262 * Creates a new try/catch block and registers it with v8.
3263 */
3264 TryCatch();
3265
3266 /**
3267 * Unregisters and deletes this try/catch block.
3268 */
3269 ~TryCatch();
3270
3271 /**
3272 * Returns true if an exception has been caught by this try/catch block.
3273 */
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00003274 bool HasCaught() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003275
3276 /**
sgjesse@chromium.orgc81c8942009-08-21 10:54:26 +00003277 * For certain types of exceptions, it makes no sense to continue
3278 * execution.
3279 *
3280 * Currently, the only type of exception that can be caught by a
3281 * TryCatch handler and for which it does not make sense to continue
3282 * is termination exception. Such exceptions are thrown when the
3283 * TerminateExecution methods are called to terminate a long-running
3284 * script.
3285 *
3286 * If CanContinue returns false, the correct action is to perform
3287 * any C++ cleanup needed and then return.
3288 */
3289 bool CanContinue() const;
3290
3291 /**
christian.plesner.hansen@gmail.comb9ce6372009-11-03 11:38:18 +00003292 * Throws the exception caught by this TryCatch in a way that avoids
3293 * it being caught again by this same TryCatch. As with ThrowException
3294 * it is illegal to execute any JavaScript operations after calling
3295 * ReThrow; the caller must return immediately to where the exception
3296 * is caught.
3297 */
3298 Handle<Value> ReThrow();
3299
3300 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003301 * Returns the exception caught by this try/catch block. If no exception has
3302 * been caught an empty handle is returned.
3303 *
3304 * The returned handle is valid until this TryCatch block has been destroyed.
3305 */
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00003306 Local<Value> Exception() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003307
3308 /**
sgjesse@chromium.org911335c2009-08-19 12:59:44 +00003309 * Returns the .stack property of the thrown object. If no .stack
3310 * property is present an empty handle is returned.
3311 */
3312 Local<Value> StackTrace() const;
3313
3314 /**
ager@chromium.org9258b6b2008-09-11 09:11:10 +00003315 * Returns the message associated with this exception. If there is
3316 * no message associated an empty handle is returned.
3317 *
3318 * The returned handle is valid until this TryCatch block has been
3319 * destroyed.
3320 */
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00003321 Local<v8::Message> Message() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +00003322
3323 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003324 * Clears any exceptions that may have been caught by this try/catch block.
3325 * After this method has been called, HasCaught() will return false.
3326 *
3327 * It is not necessary to clear a try/catch block before using it again; if
3328 * another exception is thrown the previously caught exception will just be
3329 * overwritten. However, it is often a good idea since it makes it easier
3330 * to determine which operation threw a given exception.
3331 */
3332 void Reset();
3333
v8.team.kasperl727e9952008-09-02 14:56:44 +00003334 /**
3335 * Set verbosity of the external exception handler.
3336 *
3337 * By default, exceptions that are caught by an external exception
3338 * handler are not reported. Call SetVerbose with true on an
3339 * external exception handler to have exceptions caught by the
3340 * handler reported as if they were not caught.
3341 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003342 void SetVerbose(bool value);
3343
ager@chromium.org9258b6b2008-09-11 09:11:10 +00003344 /**
3345 * Set whether or not this TryCatch should capture a Message object
3346 * which holds source information about where the exception
3347 * occurred. True by default.
3348 */
3349 void SetCaptureMessage(bool value);
3350
ager@chromium.orgc4c92722009-11-18 14:12:51 +00003351 private:
jkummerow@chromium.orge297f592011-06-08 10:05:15 +00003352 v8::internal::Isolate* isolate_;
ager@chromium.orgc4c92722009-11-18 14:12:51 +00003353 void* next_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003354 void* exception_;
ager@chromium.org9258b6b2008-09-11 09:11:10 +00003355 void* message_;
christian.plesner.hansen@gmail.comb9ce6372009-11-03 11:38:18 +00003356 bool is_verbose_ : 1;
3357 bool can_continue_ : 1;
3358 bool capture_message_ : 1;
3359 bool rethrow_ : 1;
ager@chromium.orgc4c92722009-11-18 14:12:51 +00003360
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003361 friend class v8::internal::Isolate;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003362};
3363
3364
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00003365// --- Context ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003366
3367
3368/**
3369 * Ignore
3370 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00003371class V8EXPORT ExtensionConfiguration {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003372 public:
3373 ExtensionConfiguration(int name_count, const char* names[])
3374 : name_count_(name_count), names_(names) { }
3375 private:
3376 friend class ImplementationUtilities;
3377 int name_count_;
3378 const char** names_;
3379};
3380
3381
3382/**
3383 * A sandboxed execution context with its own set of built-in objects
3384 * and functions.
3385 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00003386class V8EXPORT Context {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003387 public:
whesse@chromium.org7a392b32011-01-31 11:30:36 +00003388 /**
3389 * Returns the global proxy object or global object itself for
3390 * detached contexts.
3391 *
3392 * Global proxy object is a thin wrapper whose prototype points to
3393 * actual context's global object with the properties like Object, etc.
3394 * This is done that way for security reasons (for more details see
3395 * https://wiki.mozilla.org/Gecko:SplitWindow).
3396 *
3397 * Please note that changes to global proxy object prototype most probably
3398 * would break VM---v8 expects only global object as a prototype of
3399 * global proxy object.
3400 *
3401 * If DetachGlobal() has been invoked, Global() would return actual global
3402 * object until global is reattached with ReattachGlobal().
3403 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003404 Local<Object> Global();
3405
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00003406 /**
3407 * Detaches the global object from its context before
3408 * the global object can be reused to create a new context.
3409 */
3410 void DetachGlobal();
3411
sgjesse@chromium.orgdf7a2842010-03-25 14:34:15 +00003412 /**
3413 * Reattaches a global object to a context. This can be used to
3414 * restore the connection between a global object and a context
3415 * after DetachGlobal has been called.
3416 *
3417 * \param global_object The global object to reattach to the
3418 * context. For this to work, the global object must be the global
3419 * object that was associated with this context before a call to
3420 * DetachGlobal.
3421 */
3422 void ReattachGlobal(Handle<Object> global_object);
3423
kmillikin@chromium.org9155e252010-05-26 13:27:57 +00003424 /** Creates a new context.
3425 *
3426 * Returns a persistent handle to the newly allocated context. This
3427 * persistent handle has to be disposed when the context is no
3428 * longer used so the context can be garbage collected.
lrn@chromium.org5d00b602011-01-05 09:51:43 +00003429 *
3430 * \param extensions An optional extension configuration containing
3431 * the extensions to be installed in the newly created context.
3432 *
3433 * \param global_template An optional object template from which the
3434 * global object for the newly created context will be created.
3435 *
3436 * \param global_object An optional global object to be reused for
3437 * the newly created context. This global object must have been
3438 * created by a previous call to Context::New with the same global
3439 * template. The state of the global object will be completely reset
3440 * and only object identify will remain.
kmillikin@chromium.org9155e252010-05-26 13:27:57 +00003441 */
v8.team.kasperl727e9952008-09-02 14:56:44 +00003442 static Persistent<Context> New(
kmillikin@chromium.org5d8f0e62010-03-24 08:21:20 +00003443 ExtensionConfiguration* extensions = NULL,
v8.team.kasperl727e9952008-09-02 14:56:44 +00003444 Handle<ObjectTemplate> global_template = Handle<ObjectTemplate>(),
3445 Handle<Value> global_object = Handle<Value>());
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003446
kasper.lund44510672008-07-25 07:37:58 +00003447 /** Returns the last entered context. */
3448 static Local<Context> GetEntered();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003449
kasper.lund44510672008-07-25 07:37:58 +00003450 /** Returns the context that is on the top of the stack. */
3451 static Local<Context> GetCurrent();
3452
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003453 /**
ager@chromium.org1bf0cd02009-05-20 11:34:19 +00003454 * Returns the context of the calling JavaScript code. That is the
3455 * context of the top-most JavaScript frame. If there are no
3456 * JavaScript frames an empty handle is returned.
3457 */
3458 static Local<Context> GetCalling();
3459
3460 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003461 * Sets the security token for the context. To access an object in
3462 * another context, the security tokens must match.
3463 */
3464 void SetSecurityToken(Handle<Value> token);
3465
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00003466 /** Restores the security token to the default value. */
3467 void UseDefaultSecurityToken();
3468
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003469 /** Returns the security token of this context.*/
3470 Handle<Value> GetSecurityToken();
3471
v8.team.kasperl727e9952008-09-02 14:56:44 +00003472 /**
3473 * Enter this context. After entering a context, all code compiled
3474 * and run is compiled and run in this context. If another context
3475 * is already entered, this old context is saved so it can be
3476 * restored when the new context is exited.
3477 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003478 void Enter();
v8.team.kasperl727e9952008-09-02 14:56:44 +00003479
3480 /**
3481 * Exit this context. Exiting the current context restores the
3482 * context that was in place when entering the current context.
3483 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003484 void Exit();
3485
v8.team.kasperl727e9952008-09-02 14:56:44 +00003486 /** Returns true if the context has experienced an out of memory situation. */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003487 bool HasOutOfMemoryException();
3488
v8.team.kasperl727e9952008-09-02 14:56:44 +00003489 /** Returns true if V8 has a current context. */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003490 static bool InContext();
3491
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003492 /**
ager@chromium.org9085a012009-05-11 19:22:57 +00003493 * Associate an additional data object with the context. This is mainly used
3494 * with the debugger to provide additional information on the context through
3495 * the debugger API.
3496 */
sgjesse@chromium.org499aaa52009-11-30 08:07:20 +00003497 void SetData(Handle<String> data);
ager@chromium.org9085a012009-05-11 19:22:57 +00003498 Local<Value> GetData();
3499
3500 /**
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00003501 * Control whether code generation from strings is allowed. Calling
3502 * this method with false will disable 'eval' and the 'Function'
3503 * constructor for code running in this context. If 'eval' or the
3504 * 'Function' constructor are used an exception will be thrown.
3505 *
3506 * If code generation from strings is not allowed the
3507 * V8::AllowCodeGenerationFromStrings callback will be invoked if
3508 * set before blocking the call to 'eval' or the 'Function'
3509 * constructor. If that callback returns true, the call will be
3510 * allowed, otherwise an exception will be thrown. If no callback is
3511 * set an exception will be thrown.
3512 */
3513 void AllowCodeGenerationFromStrings(bool allow);
3514
3515 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003516 * Stack-allocated class which sets the execution context for all
3517 * operations executed within a local scope.
3518 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00003519 class Scope {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003520 public:
karlklose@chromium.org44bc7082011-04-11 12:33:05 +00003521 explicit inline Scope(Handle<Context> context) : context_(context) {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003522 context_->Enter();
3523 }
3524 inline ~Scope() { context_->Exit(); }
3525 private:
3526 Handle<Context> context_;
3527 };
3528
3529 private:
3530 friend class Value;
3531 friend class Script;
3532 friend class Object;
3533 friend class Function;
3534};
3535
3536
3537/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00003538 * Multiple threads in V8 are allowed, but only one thread at a time
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003539 * is allowed to use any given V8 isolate. See Isolate class
3540 * comments. The definition of 'using V8 isolate' includes
3541 * accessing handles or holding onto object pointers obtained
3542 * from V8 handles while in the particular V8 isolate. It is up
3543 * to the user of V8 to ensure (perhaps with locking) that this
3544 * constraint is not violated.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003545 *
lrn@chromium.org1c092762011-05-09 09:42:16 +00003546 * v8::Locker is a scoped lock object. While it's
3547 * active (i.e. between its construction and destruction) the current thread is
erik.corry@gmail.comc3b670f2011-10-05 21:44:48 +00003548 * allowed to use the locked isolate. V8 guarantees that an isolate can be
3549 * locked by at most one thread at any time. In other words, the scope of a
3550 * v8::Locker is a critical section.
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003551 *
lrn@chromium.org1c092762011-05-09 09:42:16 +00003552 * Sample usage:
3553* \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003554 * ...
3555 * {
lrn@chromium.org1c092762011-05-09 09:42:16 +00003556 * v8::Locker locker(isolate);
3557 * v8::Isolate::Scope isolate_scope(isolate);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003558 * ...
lrn@chromium.org1c092762011-05-09 09:42:16 +00003559 * // Code using V8 and isolate goes here.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003560 * ...
3561 * } // Destructor called here
v8.team.kasperl727e9952008-09-02 14:56:44 +00003562 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003563 *
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00003564 * If you wish to stop using V8 in a thread A you can do this either
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003565 * by destroying the v8::Locker object as above or by constructing a
3566 * v8::Unlocker object:
3567 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00003568 * \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003569 * {
lrn@chromium.org1c092762011-05-09 09:42:16 +00003570 * isolate->Exit();
3571 * v8::Unlocker unlocker(isolate);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003572 * ...
3573 * // Code not using V8 goes here while V8 can run in another thread.
3574 * ...
3575 * } // Destructor called here.
lrn@chromium.org1c092762011-05-09 09:42:16 +00003576 * isolate->Enter();
v8.team.kasperl727e9952008-09-02 14:56:44 +00003577 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003578 *
3579 * The Unlocker object is intended for use in a long-running callback
3580 * from V8, where you want to release the V8 lock for other threads to
3581 * use.
3582 *
3583 * The v8::Locker is a recursive lock. That is, you can lock more than
3584 * once in a given thread. This can be useful if you have code that can
3585 * be called either from code that holds the lock or from code that does
3586 * not. The Unlocker is not recursive so you can not have several
3587 * Unlockers on the stack at once, and you can not use an Unlocker in a
3588 * thread that is not inside a Locker's scope.
3589 *
3590 * An unlocker will unlock several lockers if it has to and reinstate
3591 * the correct depth of locking on its destruction. eg.:
3592 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00003593 * \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003594 * // V8 not locked.
3595 * {
lrn@chromium.org1c092762011-05-09 09:42:16 +00003596 * v8::Locker locker(isolate);
3597 * Isolate::Scope isolate_scope(isolate);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003598 * // V8 locked.
3599 * {
lrn@chromium.org1c092762011-05-09 09:42:16 +00003600 * v8::Locker another_locker(isolate);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003601 * // V8 still locked (2 levels).
3602 * {
lrn@chromium.org1c092762011-05-09 09:42:16 +00003603 * isolate->Exit();
3604 * v8::Unlocker unlocker(isolate);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003605 * // V8 not locked.
3606 * }
lrn@chromium.org1c092762011-05-09 09:42:16 +00003607 * isolate->Enter();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003608 * // V8 locked again (2 levels).
3609 * }
3610 * // V8 still locked (1 level).
3611 * }
3612 * // V8 Now no longer locked.
v8.team.kasperl727e9952008-09-02 14:56:44 +00003613 * \endcode
lrn@chromium.org1c092762011-05-09 09:42:16 +00003614 *
fschneider@chromium.org1805e212011-09-05 10:49:12 +00003615 *
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003616 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00003617class V8EXPORT Unlocker {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003618 public:
lrn@chromium.org1c092762011-05-09 09:42:16 +00003619 /**
3620 * Initialize Unlocker for a given Isolate. NULL means default isolate.
3621 */
3622 explicit Unlocker(Isolate* isolate = NULL);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003623 ~Unlocker();
lrn@chromium.org1c092762011-05-09 09:42:16 +00003624 private:
3625 internal::Isolate* isolate_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003626};
3627
3628
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00003629class V8EXPORT Locker {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003630 public:
lrn@chromium.org1c092762011-05-09 09:42:16 +00003631 /**
3632 * Initialize Locker for a given Isolate. NULL means default isolate.
3633 */
3634 explicit Locker(Isolate* isolate = NULL);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003635 ~Locker();
v8.team.kasperl727e9952008-09-02 14:56:44 +00003636
3637 /**
3638 * Start preemption.
3639 *
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00003640 * When preemption is started, a timer is fired every n milliseconds
v8.team.kasperl727e9952008-09-02 14:56:44 +00003641 * that will switch between multiple threads that are in contention
3642 * for the V8 lock.
3643 */
3644 static void StartPreemption(int every_n_ms);
3645
3646 /**
3647 * Stop preemption.
3648 */
3649 static void StopPreemption();
3650
ager@chromium.org9258b6b2008-09-11 09:11:10 +00003651 /**
erik.corry@gmail.comc3b670f2011-10-05 21:44:48 +00003652 * Returns whether or not the locker for a given isolate, or default isolate
3653 * if NULL is given, is locked by the current thread.
ager@chromium.org9258b6b2008-09-11 09:11:10 +00003654 */
lrn@chromium.org1c092762011-05-09 09:42:16 +00003655 static bool IsLocked(Isolate* isolate = NULL);
ager@chromium.org9258b6b2008-09-11 09:11:10 +00003656
ager@chromium.orgddb913d2009-01-27 10:01:48 +00003657 /**
3658 * Returns whether v8::Locker is being used by this V8 instance.
3659 */
kmillikin@chromium.org7c2628c2011-08-10 11:27:35 +00003660 static bool IsActive();
ager@chromium.orgddb913d2009-01-27 10:01:48 +00003661
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003662 private:
3663 bool has_lock_;
3664 bool top_level_;
lrn@chromium.org1c092762011-05-09 09:42:16 +00003665 internal::Isolate* isolate_;
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00003666
ager@chromium.orgddb913d2009-01-27 10:01:48 +00003667 static bool active_;
3668
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00003669 // Disallow copying and assigning.
3670 Locker(const Locker&);
3671 void operator=(const Locker&);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003672};
3673
3674
erik.corry@gmail.comd88afa22010-09-15 12:33:05 +00003675/**
3676 * An interface for exporting data from V8, using "push" model.
3677 */
whesse@chromium.orgf0ac72d2010-11-08 12:47:26 +00003678class V8EXPORT OutputStream { // NOLINT
3679 public:
erik.corry@gmail.comd88afa22010-09-15 12:33:05 +00003680 enum OutputEncoding {
3681 kAscii = 0 // 7-bit ASCII.
3682 };
3683 enum WriteResult {
3684 kContinue = 0,
3685 kAbort = 1
3686 };
3687 virtual ~OutputStream() {}
3688 /** Notify about the end of stream. */
3689 virtual void EndOfStream() = 0;
3690 /** Get preferred output chunk size. Called only once. */
3691 virtual int GetChunkSize() { return 1024; }
3692 /** Get preferred output encoding. Called only once. */
3693 virtual OutputEncoding GetOutputEncoding() { return kAscii; }
3694 /**
3695 * Writes the next chunk of snapshot data into the stream. Writing
3696 * can be stopped by returning kAbort as function result. EndOfStream
3697 * will not be called in case writing was aborted.
3698 */
3699 virtual WriteResult WriteAsciiChunk(char* data, int size) = 0;
3700};
3701
3702
ager@chromium.org5f0c45f2010-12-17 08:51:21 +00003703/**
3704 * An interface for reporting progress and controlling long-running
3705 * activities.
3706 */
3707class V8EXPORT ActivityControl { // NOLINT
3708 public:
3709 enum ControlOption {
3710 kContinue = 0,
3711 kAbort = 1
3712 };
3713 virtual ~ActivityControl() {}
3714 /**
3715 * Notify about current progress. The activity can be stopped by
3716 * returning kAbort as the callback result.
3717 */
3718 virtual ControlOption ReportProgressValue(int done, int total) = 0;
3719};
3720
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003721
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00003722// --- Implementation ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003723
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003724
3725namespace internal {
3726
mstarzinger@chromium.org1b3afd12011-11-29 14:28:56 +00003727const int kApiPointerSize = sizeof(void*); // NOLINT
3728const int kApiIntSize = sizeof(int); // NOLINT
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003729
3730// Tag information for HeapObject.
3731const int kHeapObjectTag = 1;
3732const int kHeapObjectTagSize = 2;
3733const intptr_t kHeapObjectTagMask = (1 << kHeapObjectTagSize) - 1;
3734
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003735// Tag information for Smi.
3736const int kSmiTag = 0;
3737const int kSmiTagSize = 1;
3738const intptr_t kSmiTagMask = (1 << kSmiTagSize) - 1;
3739
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003740template <size_t ptr_size> struct SmiTagging;
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003741
3742// Smi constants for 32-bit systems.
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003743template <> struct SmiTagging<4> {
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003744 static const int kSmiShiftSize = 0;
3745 static const int kSmiValueSize = 31;
3746 static inline int SmiToInt(internal::Object* value) {
3747 int shift_bits = kSmiTagSize + kSmiShiftSize;
3748 // Throw away top 32 bits and shift down (requires >> to be sign extending).
3749 return static_cast<int>(reinterpret_cast<intptr_t>(value)) >> shift_bits;
3750 }
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003751
3752 // For 32-bit systems any 2 bytes aligned pointer can be encoded as smi
3753 // with a plain reinterpret_cast.
vegorov@chromium.org0a4e9012011-01-24 12:33:13 +00003754 static const uintptr_t kEncodablePointerMask = 0x1;
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003755 static const int kPointerToSmiShift = 0;
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003756};
3757
3758// Smi constants for 64-bit systems.
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003759template <> struct SmiTagging<8> {
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003760 static const int kSmiShiftSize = 31;
3761 static const int kSmiValueSize = 32;
3762 static inline int SmiToInt(internal::Object* value) {
3763 int shift_bits = kSmiTagSize + kSmiShiftSize;
3764 // Shift down and throw away top 32 bits.
3765 return static_cast<int>(reinterpret_cast<intptr_t>(value) >> shift_bits);
3766 }
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003767
3768 // To maximize the range of pointers that can be encoded
3769 // in the available 32 bits, we require them to be 8 bytes aligned.
3770 // This gives 2 ^ (32 + 3) = 32G address space covered.
3771 // It might be not enough to cover stack allocated objects on some platforms.
3772 static const int kPointerAlignment = 3;
3773
vegorov@chromium.org0a4e9012011-01-24 12:33:13 +00003774 static const uintptr_t kEncodablePointerMask =
3775 ~(uintptr_t(0xffffffff) << kPointerAlignment);
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003776
3777 static const int kPointerToSmiShift =
3778 kSmiTagSize + kSmiShiftSize - kPointerAlignment;
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003779};
3780
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003781typedef SmiTagging<kApiPointerSize> PlatformSmiTagging;
3782const int kSmiShiftSize = PlatformSmiTagging::kSmiShiftSize;
3783const int kSmiValueSize = PlatformSmiTagging::kSmiValueSize;
vegorov@chromium.org0a4e9012011-01-24 12:33:13 +00003784const uintptr_t kEncodablePointerMask =
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003785 PlatformSmiTagging::kEncodablePointerMask;
3786const int kPointerToSmiShift = PlatformSmiTagging::kPointerToSmiShift;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003787
sgjesse@chromium.orgac6aa172009-12-04 12:29:05 +00003788template <size_t ptr_size> struct InternalConstants;
3789
3790// Internal constants for 32-bit systems.
3791template <> struct InternalConstants<4> {
erik.corry@gmail.com4a6c3272010-11-18 12:04:40 +00003792 static const int kStringResourceOffset = 3 * kApiPointerSize;
sgjesse@chromium.orgac6aa172009-12-04 12:29:05 +00003793};
3794
3795// Internal constants for 64-bit systems.
3796template <> struct InternalConstants<8> {
erik.corry@gmail.com4a6c3272010-11-18 12:04:40 +00003797 static const int kStringResourceOffset = 3 * kApiPointerSize;
sgjesse@chromium.orgac6aa172009-12-04 12:29:05 +00003798};
3799
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003800/**
3801 * This class exports constants and functionality from within v8 that
3802 * is necessary to implement inline functions in the v8 api. Don't
3803 * depend on functions and constants defined here.
3804 */
3805class Internals {
3806 public:
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003807 // These values match non-compiler-dependent values defined within
3808 // the implementation of v8.
3809 static const int kHeapObjectMapOffset = 0;
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003810 static const int kMapInstanceTypeOffset = 1 * kApiPointerSize + kApiIntSize;
sgjesse@chromium.orgac6aa172009-12-04 12:29:05 +00003811 static const int kStringResourceOffset =
erik.corry@gmail.com4a6c3272010-11-18 12:04:40 +00003812 InternalConstants<kApiPointerSize>::kStringResourceOffset;
sgjesse@chromium.orgac6aa172009-12-04 12:29:05 +00003813
ager@chromium.orgea91cc52011-05-23 06:06:11 +00003814 static const int kForeignAddressOffset = kApiPointerSize;
erik.corry@gmail.com4a6c3272010-11-18 12:04:40 +00003815 static const int kJSObjectHeaderSize = 3 * kApiPointerSize;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003816 static const int kFullStringRepresentationMask = 0x07;
sgjesse@chromium.org82dbbab2010-06-02 08:57:44 +00003817 static const int kExternalTwoByteRepresentationTag = 0x02;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003818
erik.corry@gmail.comc3b670f2011-10-05 21:44:48 +00003819 static const int kJSObjectType = 0xa6;
ricow@chromium.org5ad5ace2010-06-23 09:06:43 +00003820 static const int kFirstNonstringType = 0x80;
ager@chromium.orgea91cc52011-05-23 06:06:11 +00003821 static const int kForeignType = 0x85;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003822
3823 static inline bool HasHeapObjectTag(internal::Object* value) {
3824 return ((reinterpret_cast<intptr_t>(value) & kHeapObjectTagMask) ==
3825 kHeapObjectTag);
3826 }
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00003827
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003828 static inline bool HasSmiTag(internal::Object* value) {
3829 return ((reinterpret_cast<intptr_t>(value) & kSmiTagMask) == kSmiTag);
3830 }
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00003831
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003832 static inline int SmiValue(internal::Object* value) {
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003833 return PlatformSmiTagging::SmiToInt(value);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003834 }
3835
3836 static inline int GetInstanceType(internal::Object* obj) {
3837 typedef internal::Object O;
3838 O* map = ReadField<O*>(obj, kHeapObjectMapOffset);
3839 return ReadField<uint8_t>(map, kMapInstanceTypeOffset);
3840 }
3841
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003842 static inline void* GetExternalPointerFromSmi(internal::Object* value) {
vegorov@chromium.org0a4e9012011-01-24 12:33:13 +00003843 const uintptr_t address = reinterpret_cast<uintptr_t>(value);
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003844 return reinterpret_cast<void*>(address >> kPointerToSmiShift);
3845 }
3846
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003847 static inline void* GetExternalPointer(internal::Object* obj) {
3848 if (HasSmiTag(obj)) {
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003849 return GetExternalPointerFromSmi(obj);
ager@chromium.orgea91cc52011-05-23 06:06:11 +00003850 } else if (GetInstanceType(obj) == kForeignType) {
3851 return ReadField<void*>(obj, kForeignAddressOffset);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003852 } else {
3853 return NULL;
3854 }
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003855 }
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00003856
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003857 static inline bool IsExternalTwoByteString(int instance_type) {
3858 int representation = (instance_type & kFullStringRepresentationMask);
3859 return representation == kExternalTwoByteRepresentationTag;
3860 }
3861
3862 template <typename T>
3863 static inline T ReadField(Object* ptr, int offset) {
3864 uint8_t* addr = reinterpret_cast<uint8_t*>(ptr) + offset - kHeapObjectTag;
3865 return *reinterpret_cast<T*>(addr);
3866 }
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003867
3868 static inline bool CanCastToHeapObject(void* o) { return false; }
3869 static inline bool CanCastToHeapObject(Context* o) { return true; }
3870 static inline bool CanCastToHeapObject(String* o) { return true; }
3871 static inline bool CanCastToHeapObject(Object* o) { return true; }
3872 static inline bool CanCastToHeapObject(Message* o) { return true; }
3873 static inline bool CanCastToHeapObject(StackTrace* o) { return true; }
3874 static inline bool CanCastToHeapObject(StackFrame* o) { return true; }
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003875};
3876
whesse@chromium.orgf0ac72d2010-11-08 12:47:26 +00003877} // namespace internal
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003878
3879
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003880template <class T>
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003881Local<T>::Local() : Handle<T>() { }
3882
3883
3884template <class T>
3885Local<T> Local<T>::New(Handle<T> that) {
3886 if (that.IsEmpty()) return Local<T>();
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003887 T* that_ptr = *that;
3888 internal::Object** p = reinterpret_cast<internal::Object**>(that_ptr);
3889 if (internal::Internals::CanCastToHeapObject(that_ptr)) {
3890 return Local<T>(reinterpret_cast<T*>(HandleScope::CreateHandle(
3891 reinterpret_cast<internal::HeapObject*>(*p))));
3892 }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003893 return Local<T>(reinterpret_cast<T*>(HandleScope::CreateHandle(*p)));
3894}
3895
3896
3897template <class T>
3898Persistent<T> Persistent<T>::New(Handle<T> that) {
3899 if (that.IsEmpty()) return Persistent<T>();
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003900 internal::Object** p = reinterpret_cast<internal::Object**>(*that);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003901 return Persistent<T>(reinterpret_cast<T*>(V8::GlobalizeReference(p)));
3902}
3903
3904
3905template <class T>
ager@chromium.org32912102009-01-16 10:38:43 +00003906bool Persistent<T>::IsNearDeath() const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003907 if (this->IsEmpty()) return false;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003908 return V8::IsGlobalNearDeath(reinterpret_cast<internal::Object**>(**this));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003909}
3910
3911
3912template <class T>
ager@chromium.org32912102009-01-16 10:38:43 +00003913bool Persistent<T>::IsWeak() const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003914 if (this->IsEmpty()) return false;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003915 return V8::IsGlobalWeak(reinterpret_cast<internal::Object**>(**this));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003916}
3917
3918
3919template <class T>
3920void Persistent<T>::Dispose() {
3921 if (this->IsEmpty()) return;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003922 V8::DisposeGlobal(reinterpret_cast<internal::Object**>(**this));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003923}
3924
3925
3926template <class T>
3927Persistent<T>::Persistent() : Handle<T>() { }
3928
3929template <class T>
3930void Persistent<T>::MakeWeak(void* parameters, WeakReferenceCallback callback) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003931 V8::MakeWeak(reinterpret_cast<internal::Object**>(**this),
3932 parameters,
3933 callback);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003934}
3935
3936template <class T>
3937void Persistent<T>::ClearWeak() {
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003938 V8::ClearWeak(reinterpret_cast<internal::Object**>(**this));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003939}
3940
whesse@chromium.orgb08986c2011-03-14 16:13:42 +00003941template <class T>
kmillikin@chromium.orgc53e10d2011-05-18 09:12:58 +00003942void Persistent<T>::MarkIndependent() {
3943 V8::MarkIndependent(reinterpret_cast<internal::Object**>(**this));
3944}
3945
3946template <class T>
whesse@chromium.orgb08986c2011-03-14 16:13:42 +00003947void Persistent<T>::SetWrapperClassId(uint16_t class_id) {
3948 V8::SetWrapperClassId(reinterpret_cast<internal::Object**>(**this), class_id);
3949}
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00003950
fschneider@chromium.orge03fb642010-11-01 12:34:09 +00003951Arguments::Arguments(internal::Object** implicit_args,
3952 internal::Object** values, int length,
3953 bool is_construct_call)
3954 : implicit_args_(implicit_args),
3955 values_(values),
3956 length_(length),
3957 is_construct_call_(is_construct_call) { }
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00003958
3959
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003960Local<Value> Arguments::operator[](int i) const {
3961 if (i < 0 || length_ <= i) return Local<Value>(*Undefined());
3962 return Local<Value>(reinterpret_cast<Value*>(values_ - i));
3963}
3964
3965
3966Local<Function> Arguments::Callee() const {
fschneider@chromium.orge03fb642010-11-01 12:34:09 +00003967 return Local<Function>(reinterpret_cast<Function*>(
3968 &implicit_args_[kCalleeIndex]));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003969}
3970
3971
3972Local<Object> Arguments::This() const {
3973 return Local<Object>(reinterpret_cast<Object*>(values_ + 1));
3974}
3975
3976
3977Local<Object> Arguments::Holder() const {
fschneider@chromium.orge03fb642010-11-01 12:34:09 +00003978 return Local<Object>(reinterpret_cast<Object*>(
3979 &implicit_args_[kHolderIndex]));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003980}
3981
3982
3983Local<Value> Arguments::Data() const {
fschneider@chromium.orge03fb642010-11-01 12:34:09 +00003984 return Local<Value>(reinterpret_cast<Value*>(&implicit_args_[kDataIndex]));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003985}
3986
3987
3988bool Arguments::IsConstructCall() const {
3989 return is_construct_call_;
3990}
3991
3992
3993int Arguments::Length() const {
3994 return length_;
3995}
3996
3997
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003998template <class T>
3999Local<T> HandleScope::Close(Handle<T> value) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004000 internal::Object** before = reinterpret_cast<internal::Object**>(*value);
4001 internal::Object** after = RawClose(before);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00004002 return Local<T>(reinterpret_cast<T*>(after));
4003}
4004
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00004005Handle<Value> ScriptOrigin::ResourceName() const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00004006 return resource_name_;
4007}
4008
4009
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00004010Handle<Integer> ScriptOrigin::ResourceLineOffset() const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00004011 return resource_line_offset_;
4012}
4013
4014
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00004015Handle<Integer> ScriptOrigin::ResourceColumnOffset() const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00004016 return resource_column_offset_;
4017}
4018
4019
4020Handle<Boolean> Boolean::New(bool value) {
4021 return value ? True() : False();
4022}
4023
4024
4025void Template::Set(const char* name, v8::Handle<Data> value) {
4026 Set(v8::String::New(name), value);
4027}
4028
4029
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004030Local<Value> Object::GetInternalField(int index) {
4031#ifndef V8_ENABLE_CHECKS
4032 Local<Value> quick_result = UncheckedGetInternalField(index);
4033 if (!quick_result.IsEmpty()) return quick_result;
4034#endif
4035 return CheckedGetInternalField(index);
4036}
4037
4038
4039Local<Value> Object::UncheckedGetInternalField(int index) {
4040 typedef internal::Object O;
4041 typedef internal::Internals I;
4042 O* obj = *reinterpret_cast<O**>(this);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00004043 if (I::GetInstanceType(obj) == I::kJSObjectType) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004044 // If the object is a plain JSObject, which is the common case,
4045 // we know where to find the internal fields and can return the
4046 // value directly.
erik.corry@gmail.com4a6c3272010-11-18 12:04:40 +00004047 int offset = I::kJSObjectHeaderSize + (internal::kApiPointerSize * index);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004048 O* value = I::ReadField<O*>(obj, offset);
4049 O** result = HandleScope::CreateHandle(value);
4050 return Local<Value>(reinterpret_cast<Value*>(result));
4051 } else {
4052 return Local<Value>();
4053 }
4054}
4055
4056
4057void* External::Unwrap(Handle<v8::Value> obj) {
4058#ifdef V8_ENABLE_CHECKS
4059 return FullUnwrap(obj);
4060#else
4061 return QuickUnwrap(obj);
4062#endif
4063}
4064
4065
4066void* External::QuickUnwrap(Handle<v8::Value> wrapper) {
4067 typedef internal::Object O;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004068 O* obj = *reinterpret_cast<O**>(const_cast<v8::Value*>(*wrapper));
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00004069 return internal::Internals::GetExternalPointer(obj);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004070}
4071
4072
4073void* Object::GetPointerFromInternalField(int index) {
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00004074 typedef internal::Object O;
4075 typedef internal::Internals I;
4076
4077 O* obj = *reinterpret_cast<O**>(this);
4078
4079 if (I::GetInstanceType(obj) == I::kJSObjectType) {
4080 // If the object is a plain JSObject, which is the common case,
4081 // we know where to find the internal fields and can return the
4082 // value directly.
erik.corry@gmail.com4a6c3272010-11-18 12:04:40 +00004083 int offset = I::kJSObjectHeaderSize + (internal::kApiPointerSize * index);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00004084 O* value = I::ReadField<O*>(obj, offset);
4085 return I::GetExternalPointer(value);
4086 }
4087
4088 return SlowGetPointerFromInternalField(index);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004089}
4090
4091
4092String* String::Cast(v8::Value* value) {
4093#ifdef V8_ENABLE_CHECKS
4094 CheckCast(value);
4095#endif
4096 return static_cast<String*>(value);
4097}
4098
4099
4100String::ExternalStringResource* String::GetExternalStringResource() const {
4101 typedef internal::Object O;
4102 typedef internal::Internals I;
4103 O* obj = *reinterpret_cast<O**>(const_cast<String*>(this));
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004104 String::ExternalStringResource* result;
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00004105 if (I::IsExternalTwoByteString(I::GetInstanceType(obj))) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004106 void* value = I::ReadField<void*>(obj, I::kStringResourceOffset);
4107 result = reinterpret_cast<String::ExternalStringResource*>(value);
4108 } else {
4109 result = NULL;
4110 }
4111#ifdef V8_ENABLE_CHECKS
4112 VerifyExternalStringResource(result);
4113#endif
4114 return result;
4115}
4116
4117
4118bool Value::IsString() const {
4119#ifdef V8_ENABLE_CHECKS
4120 return FullIsString();
4121#else
4122 return QuickIsString();
4123#endif
4124}
4125
4126bool Value::QuickIsString() const {
4127 typedef internal::Object O;
4128 typedef internal::Internals I;
4129 O* obj = *reinterpret_cast<O**>(const_cast<Value*>(this));
4130 if (!I::HasHeapObjectTag(obj)) return false;
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00004131 return (I::GetInstanceType(obj) < I::kFirstNonstringType);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004132}
4133
4134
4135Number* Number::Cast(v8::Value* value) {
4136#ifdef V8_ENABLE_CHECKS
4137 CheckCast(value);
4138#endif
4139 return static_cast<Number*>(value);
4140}
4141
4142
4143Integer* Integer::Cast(v8::Value* value) {
4144#ifdef V8_ENABLE_CHECKS
4145 CheckCast(value);
4146#endif
4147 return static_cast<Integer*>(value);
4148}
4149
4150
4151Date* Date::Cast(v8::Value* value) {
4152#ifdef V8_ENABLE_CHECKS
4153 CheckCast(value);
4154#endif
4155 return static_cast<Date*>(value);
4156}
4157
4158
svenpanne@chromium.org84bcc552011-07-18 09:50:57 +00004159StringObject* StringObject::Cast(v8::Value* value) {
4160#ifdef V8_ENABLE_CHECKS
4161 CheckCast(value);
4162#endif
4163 return static_cast<StringObject*>(value);
4164}
4165
4166
4167NumberObject* NumberObject::Cast(v8::Value* value) {
4168#ifdef V8_ENABLE_CHECKS
4169 CheckCast(value);
4170#endif
4171 return static_cast<NumberObject*>(value);
4172}
4173
4174
4175BooleanObject* BooleanObject::Cast(v8::Value* value) {
4176#ifdef V8_ENABLE_CHECKS
4177 CheckCast(value);
4178#endif
4179 return static_cast<BooleanObject*>(value);
4180}
4181
4182
ager@chromium.orgb61a0d12010-10-13 08:35:23 +00004183RegExp* RegExp::Cast(v8::Value* value) {
4184#ifdef V8_ENABLE_CHECKS
4185 CheckCast(value);
4186#endif
4187 return static_cast<RegExp*>(value);
4188}
4189
4190
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004191Object* Object::Cast(v8::Value* value) {
4192#ifdef V8_ENABLE_CHECKS
4193 CheckCast(value);
4194#endif
4195 return static_cast<Object*>(value);
4196}
4197
4198
4199Array* Array::Cast(v8::Value* value) {
4200#ifdef V8_ENABLE_CHECKS
4201 CheckCast(value);
4202#endif
4203 return static_cast<Array*>(value);
4204}
4205
4206
4207Function* Function::Cast(v8::Value* value) {
4208#ifdef V8_ENABLE_CHECKS
4209 CheckCast(value);
4210#endif
4211 return static_cast<Function*>(value);
4212}
4213
4214
4215External* External::Cast(v8::Value* value) {
4216#ifdef V8_ENABLE_CHECKS
4217 CheckCast(value);
4218#endif
4219 return static_cast<External*>(value);
4220}
4221
4222
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00004223Local<Value> AccessorInfo::Data() const {
ager@chromium.orgb26c50a2010-03-26 09:27:16 +00004224 return Local<Value>(reinterpret_cast<Value*>(&args_[-2]));
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00004225}
4226
4227
4228Local<Object> AccessorInfo::This() const {
4229 return Local<Object>(reinterpret_cast<Object*>(&args_[0]));
4230}
4231
4232
4233Local<Object> AccessorInfo::Holder() const {
4234 return Local<Object>(reinterpret_cast<Object*>(&args_[-1]));
4235}
4236
4237
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00004238/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00004239 * \example shell.cc
4240 * A simple shell that takes a list of expressions on the
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00004241 * command-line and executes them.
4242 */
4243
4244
4245/**
4246 * \example process.cc
4247 */
4248
4249
4250} // namespace v8
4251
4252
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00004253#undef V8EXPORT
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00004254#undef TYPE_CHECK
4255
4256
ager@chromium.org9258b6b2008-09-11 09:11:10 +00004257#endif // V8_H_