blob: 4b7f6e735fe7cc98d758dcc8e28d3c21625bd4cd [file] [log] [blame]
Ben Murdoch257744e2011-11-30 15:57:28 +00001// Copyright 2011 the V8 project authors. All rights reserved.
Steve Blocka7e24c12009-10-30 11:49:00 +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
28/** \mainpage V8 API Reference Guide
29 *
30 * V8 is Google's open source JavaScript engine.
31 *
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/
36 */
37
38#ifndef V8_H_
39#define V8_H_
40
Teng-Hui Zhu3e5fa292010-11-09 16:16:48 -080041#include "v8stdint.h"
Steve Blocka7e24c12009-10-30 11:49:00 +000042
43#ifdef _WIN32
Steve Blocka7e24c12009-10-30 11:49:00 +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.
Steve Blocka7e24c12009-10-30 11:49:00 +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
53#endif
54
55#ifdef BUILDING_V8_SHARED
56#define V8EXPORT __declspec(dllexport)
Steve Blocka7e24c12009-10-30 11:49:00 +000057#elif USING_V8_SHARED
58#define V8EXPORT __declspec(dllimport)
Steve Blocka7e24c12009-10-30 11:49:00 +000059#else
60#define V8EXPORT
Steve Blocka7e24c12009-10-30 11:49:00 +000061#endif // BUILDING_V8_SHARED
62
63#else // _WIN32
64
Steve Blocka7e24c12009-10-30 11:49:00 +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)
69#define V8EXPORT __attribute__ ((visibility("default")))
Steve Blocka7e24c12009-10-30 11:49:00 +000070#else // defined(__GNUC__) && (__GNUC__ >= 4)
71#define V8EXPORT
Steve Blocka7e24c12009-10-30 11:49:00 +000072#endif // defined(__GNUC__) && (__GNUC__ >= 4)
73
74#endif // _WIN32
75
76/**
77 * The v8 JavaScript engine.
78 */
79namespace v8 {
80
81class Context;
82class String;
Ben Murdoch3fb3ca82011-12-02 17:19:32 +000083class StringObject;
Steve Blocka7e24c12009-10-30 11:49:00 +000084class Value;
85class Utils;
86class Number;
Ben Murdoch3fb3ca82011-12-02 17:19:32 +000087class NumberObject;
Steve Blocka7e24c12009-10-30 11:49:00 +000088class Object;
89class Array;
90class Int32;
91class Uint32;
92class External;
93class Primitive;
94class Boolean;
Ben Murdoch3fb3ca82011-12-02 17:19:32 +000095class BooleanObject;
Steve Blocka7e24c12009-10-30 11:49:00 +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;
Leon Clarkef7060e22010-06-03 12:02:55 +0100107class AccessorInfo;
Kristian Monsen25f61362010-05-21 11:50:48 +0100108class StackTrace;
109class StackFrame;
Steve Blocka7e24c12009-10-30 11:49:00 +0000110
111namespace internal {
112
Steve Blocka7e24c12009-10-30 11:49:00 +0000113class Arguments;
Steve Blockd0582a62009-12-15 09:54:21 +0000114class Object;
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +0100115class Heap;
Steve Block44f0eee2011-05-26 01:26:41 +0100116class HeapObject;
117class Isolate;
Steve Blocka7e24c12009-10-30 11:49:00 +0000118}
119
120
Ben Murdoch257744e2011-11-30 15:57:28 +0000121// --- Weak Handles ---
Steve Blocka7e24c12009-10-30 11:49:00 +0000122
123
124/**
125 * A weak reference callback function.
126 *
Kristian Monsen50ef84f2010-07-29 15:18:00 +0100127 * 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 *
Steve Blocka7e24c12009-10-30 11:49:00 +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 */
133typedef void (*WeakReferenceCallback)(Persistent<Value> object,
134 void* parameter);
135
136
Ben Murdoch257744e2011-11-30 15:57:28 +0000137// --- Handles ---
Steve Blocka7e24c12009-10-30 11:49:00 +0000138
Kristian Monsen50ef84f2010-07-29 15:18:00 +0100139#define TYPE_CHECK(T, S) \
140 while (false) { \
141 *(static_cast<T* volatile*>(0)) = static_cast<S*>(0); \
Steve Blocka7e24c12009-10-30 11:49:00 +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
Ben Murdoch257744e2011-11-30 15:57:28 +0000165 * a Handle<Object>); the value will still be governed by a handle
Steve Blocka7e24c12009-10-30 11:49:00 +0000166 * behind the scenes and the same rules apply to these values as to
167 * their handles.
168 */
Steve Block8defd9f2010-07-08 12:39:36 +0100169template <class T> class Handle {
Steve Blocka7e24c12009-10-30 11:49:00 +0000170 public:
Steve Blocka7e24c12009-10-30 11:49:00 +0000171 /**
172 * Creates an empty handle.
173 */
Ben Murdoch69a99ed2011-11-30 16:03:39 +0000174 inline Handle() : val_(0) {}
Steve Blocka7e24c12009-10-30 11:49:00 +0000175
176 /**
177 * Creates a new handle for the specified value.
178 */
Ben Murdoch69a99ed2011-11-30 16:03:39 +0000179 inline explicit Handle(T* val) : val_(val) {}
Steve Blocka7e24c12009-10-30 11:49:00 +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
184 * to assign between handles. However, if you try to assign between
185 * incompatible handles, for instance from a Handle<String> to a
Ben Murdoch257744e2011-11-30 15:57:28 +0000186 * Handle<Number> it will cause a compile-time error. Assigning
Steve Blocka7e24c12009-10-30 11:49:00 +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 */
Steve Block8defd9f2010-07-08 12:39:36 +0100204 inline bool IsEmpty() const { return val_ == 0; }
Steve Blocka7e24c12009-10-30 11:49:00 +0000205
Steve Blocka7e24c12009-10-30 11:49:00 +0000206 /**
207 * Sets the handle to be empty. IsEmpty() will then return true.
208 */
Ben Murdoch69a99ed2011-11-30 16:03:39 +0000209 inline void Clear() { val_ = 0; }
210
211 inline T* operator->() const { return val_; }
212
213 inline T* operator*() const { return val_; }
Steve Blocka7e24c12009-10-30 11:49:00 +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 */
Steve Block8defd9f2010-07-08 12:39:36 +0100221 template <class S> inline bool operator==(Handle<S> that) const {
Steve Blocka7e24c12009-10-30 11:49:00 +0000222 internal::Object** a = reinterpret_cast<internal::Object**>(**this);
223 internal::Object** b = reinterpret_cast<internal::Object**>(*that);
224 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 */
Steve Block8defd9f2010-07-08 12:39:36 +0100235 template <class S> inline bool operator!=(Handle<S> that) const {
Steve Blocka7e24c12009-10-30 11:49:00 +0000236 return !operator==(that);
237 }
238
239 template <class S> static inline Handle<T> Cast(Handle<S> that) {
240#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.
243 if (that.IsEmpty()) return Handle<T>();
244#endif
245 return Handle<T>(T::Cast(*that));
246 }
247
Steve Block6ded16b2010-05-10 14:33:55 +0100248 template <class S> inline Handle<S> As() {
249 return Handle<S>::Cast(*this);
250 }
251
Steve Blocka7e24c12009-10-30 11:49:00 +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 */
Steve Block8defd9f2010-07-08 12:39:36 +0100264template <class T> class Local : public Handle<T> {
Steve Blocka7e24c12009-10-30 11:49:00 +0000265 public:
266 inline Local();
267 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) {
278#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.
281 if (that.IsEmpty()) return Local<T>();
282#endif
283 return Local<T>(T::Cast(*that));
284 }
285
Steve Block6ded16b2010-05-10 14:33:55 +0100286 template <class S> inline Local<S> As() {
287 return Local<S>::Cast(*this);
288 }
289
Steve Blocka7e24c12009-10-30 11:49:00 +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 */
294 inline static Local<T> New(Handle<T> that);
295};
296
297
298/**
299 * An object reference that is independent of any handle scope. Where
300 * a Local handle only lives as long as the HandleScope in which it was
301 * 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 */
Steve Block8defd9f2010-07-08 12:39:36 +0100315template <class T> class Persistent : public Handle<T> {
Steve Blocka7e24c12009-10-30 11:49:00 +0000316 public:
Steve Blocka7e24c12009-10-30 11:49:00 +0000317 /**
318 * Creates an empty persistent handle that doesn't point to any
319 * storage cell.
320 */
321 inline Persistent();
322
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
327 * handles. However, attempting to assign between incompatible
328 * persistent handles, for instance from a Persistent<String> to a
Ben Murdoch257744e2011-11-30 15:57:28 +0000329 * Persistent<Number> will cause a compile-time error. Assigning
Steve Blocka7e24c12009-10-30 11:49:00 +0000330 * between compatible persistent handles, for instance assigning a
331 * Persistent<String> to a variable declared as Persistent<Value>,
332 * is allowed as String is a subclass of Value.
333 */
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
346 /**
347 * "Casts" a plain handle which is known to be a persistent handle
348 * to a persistent handle.
349 */
350 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) {
354#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.
357 if (that.IsEmpty()) return Persistent<T>();
358#endif
359 return Persistent<T>(T::Cast(*that));
360 }
361
Steve Block6ded16b2010-05-10 14:33:55 +0100362 template <class S> inline Persistent<S> As() {
363 return Persistent<S>::Cast(*this);
364 }
365
Steve Blocka7e24c12009-10-30 11:49:00 +0000366 /**
367 * Creates a new persistent handle for an existing local or
368 * persistent handle.
369 */
370 inline static Persistent<T> New(Handle<T> that);
371
372 /**
373 * Releases the storage cell referenced by this persistent handle.
374 * Does not remove the reference to the cell from any handles.
Ben Murdoch257744e2011-11-30 15:57:28 +0000375 * This handle's reference, and any other references to the storage
Steve Blocka7e24c12009-10-30 11:49:00 +0000376 * cell remain and IsEmpty will still return false.
377 */
378 inline void Dispose();
379
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 */
386 inline void MakeWeak(void* parameters, WeakReferenceCallback callback);
387
388 /** Clears the weak reference to this object.*/
389 inline void ClearWeak();
390
391 /**
Ben Murdoch257744e2011-11-30 15:57:28 +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 /**
Steve Blocka7e24c12009-10-30 11:49:00 +0000401 *Checks if the handle holds the only reference to an object.
402 */
403 inline bool IsNearDeath() const;
404
405 /**
406 * Returns true if the handle's reference is weak.
407 */
408 inline bool IsWeak() const;
409
Steve Block44f0eee2011-05-26 01:26:41 +0100410 /**
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
Steve Blocka7e24c12009-10-30 11:49:00 +0000416 private:
417 friend class ImplementationUtilities;
418 friend class ObjectTemplate;
419};
420
421
422 /**
423 * 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
428 * place in the new handle scope until it is deleted. After that,
429 * 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 */
436class V8EXPORT HandleScope {
437 public:
438 HandleScope();
439
440 ~HandleScope();
441
442 /**
443 * 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 */
456 static internal::Object** CreateHandle(internal::Object* value);
Steve Block44f0eee2011-05-26 01:26:41 +0100457 // Faster version, uses HeapObject to obtain the current Isolate.
458 static internal::Object** CreateHandle(internal::HeapObject* value);
Steve Blocka7e24c12009-10-30 11:49:00 +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
Steve Blockd0582a62009-12-15 09:54:21 +0000468 // This Data class is accessible internally as HandleScopeData through a
469 // typedef in the ImplementationUtilities class.
Steve Blocka7e24c12009-10-30 11:49:00 +0000470 class V8EXPORT Data {
471 public:
Steve Blocka7e24c12009-10-30 11:49:00 +0000472 internal::Object** next;
473 internal::Object** limit;
John Reck59135872010-11-02 12:39:01 -0700474 int level;
Steve Blocka7e24c12009-10-30 11:49:00 +0000475 inline void Initialize() {
Steve Blocka7e24c12009-10-30 11:49:00 +0000476 next = limit = NULL;
John Reck59135872010-11-02 12:39:01 -0700477 level = 0;
Steve Blocka7e24c12009-10-30 11:49:00 +0000478 }
479 };
Teng-Hui Zhu3e5fa292010-11-09 16:16:48 -0800480
John Reck59135872010-11-02 12:39:01 -0700481 void Leave();
Steve Blocka7e24c12009-10-30 11:49:00 +0000482
Steve Block44f0eee2011-05-26 01:26:41 +0100483 internal::Isolate* isolate_;
John Reck59135872010-11-02 12:39:01 -0700484 internal::Object** prev_next_;
485 internal::Object** prev_limit_;
Steve Blocka7e24c12009-10-30 11:49:00 +0000486
487 // 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.
489 bool is_closed_;
490 internal::Object** RawClose(internal::Object** value);
491
492 friend class ImplementationUtilities;
493};
494
495
Ben Murdoch257744e2011-11-30 15:57:28 +0000496// --- Special objects ---
Steve Blocka7e24c12009-10-30 11:49:00 +0000497
498
499/**
500 * The superclass of values and API object templates.
501 */
502class V8EXPORT Data {
503 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
511 * compiling it, and can be stored between compilations. When script
512 * data is given to the compile method compilation will be faster.
513 */
514class V8EXPORT ScriptData { // NOLINT
515 public:
516 virtual ~ScriptData() { }
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +0100517
Leon Clarkef7060e22010-06-03 12:02:55 +0100518 /**
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 */
Steve Blocka7e24c12009-10-30 11:49:00 +0000524 static ScriptData* PreCompile(const char* input, int length);
Steve Blocka7e24c12009-10-30 11:49:00 +0000525
Leon Clarkef7060e22010-06-03 12:02:55 +0100526 /**
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +0100527 * 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 /**
Leon Clarkef7060e22010-06-03 12:02:55 +0100537 * 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 */
Steve Blocka7e24c12009-10-30 11:49:00 +0000548 virtual int Length() = 0;
Leon Clarkef7060e22010-06-03 12:02:55 +0100549
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 */
Leon Clarkee46be812010-01-19 14:06:41 +0000559 virtual bool HasError() = 0;
Steve Blocka7e24c12009-10-30 11:49:00 +0000560};
561
562
563/**
564 * The origin, within a file, of a script.
565 */
Steve Block8defd9f2010-07-08 12:39:36 +0100566class ScriptOrigin {
Steve Blocka7e24c12009-10-30 11:49:00 +0000567 public:
Steve Block8defd9f2010-07-08 12:39:36 +0100568 inline ScriptOrigin(
569 Handle<Value> resource_name,
570 Handle<Integer> resource_line_offset = Handle<Integer>(),
571 Handle<Integer> resource_column_offset = Handle<Integer>())
Steve Blocka7e24c12009-10-30 11:49:00 +0000572 : resource_name_(resource_name),
573 resource_line_offset_(resource_line_offset),
574 resource_column_offset_(resource_column_offset) { }
575 inline Handle<Value> ResourceName() const;
576 inline Handle<Integer> ResourceLineOffset() const;
577 inline Handle<Integer> ResourceColumnOffset() const;
578 private:
579 Handle<Value> resource_name_;
580 Handle<Integer> resource_line_offset_;
581 Handle<Integer> resource_column_offset_;
582};
583
584
585/**
586 * A compiled JavaScript script.
587 */
588class V8EXPORT Script {
589 public:
Steve Blocka7e24c12009-10-30 11:49:00 +0000590 /**
Andrei Popescu402d9372010-02-26 13:31:12 +0000591 * Compiles the specified script (context-independent).
Steve Blocka7e24c12009-10-30 11:49:00 +0000592 *
Andrei Popescu402d9372010-02-26 13:31:12 +0000593 * \param source Script source code.
Steve Block6ded16b2010-05-10 14:33:55 +0100594 * \param origin Script origin, owned by caller, no references are kept
Andrei Popescu402d9372010-02-26 13:31:12 +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
Steve Block6ded16b2010-05-10 14:33:55 +0100600 * this has same effect as calling SetData(), but allows data to be
Andrei Popescu402d9372010-02-26 13:31:12 +0000601 * available to compile event handlers.
602 * \return Compiled script object (context independent; when run it
603 * will use the currently entered context).
Steve Blocka7e24c12009-10-30 11:49:00 +0000604 */
Andrei Popescu402d9372010-02-26 13:31:12 +0000605 static Local<Script> New(Handle<String> source,
606 ScriptOrigin* origin = NULL,
607 ScriptData* pre_data = NULL,
608 Handle<String> script_data = Handle<String>());
Steve Blocka7e24c12009-10-30 11:49:00 +0000609
610 /**
611 * Compiles the specified script using the specified file name
612 * object (typically a string) as the script's origin.
613 *
Andrei Popescu402d9372010-02-26 13:31:12 +0000614 * \param source Script source code.
Steve Block6ded16b2010-05-10 14:33:55 +0100615 * \param file_name file name object (typically a string) to be used
Andrei Popescu402d9372010-02-26 13:31:12 +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.
Steve Block6ded16b2010-05-10 14:33:55 +0100627 * \param origin Script origin, owned by caller, no references are kept
Andrei Popescu402d9372010-02-26 13:31:12 +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.
Steve Blocka7e24c12009-10-30 11:49:00 +0000638 */
639 static Local<Script> Compile(Handle<String> source,
Andrei Popescu402d9372010-02-26 13:31:12 +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>());
Steve Blocka7e24c12009-10-30 11:49:00 +0000660
661 /**
662 * 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.
667 */
668 Local<Value> Run();
669
670 /**
671 * Returns the script id value.
672 */
673 Local<Value> Id();
674
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 */
Steve Blockd0582a62009-12-15 09:54:21 +0000680 void SetData(Handle<String> data);
Steve Blocka7e24c12009-10-30 11:49:00 +0000681};
682
683
684/**
685 * An error message.
686 */
687class V8EXPORT Message {
688 public:
689 Local<String> Get() const;
690 Local<String> GetSourceLine() const;
691
692 /**
693 * Returns the resource name for the script from where the function causing
694 * the error originates.
695 */
696 Handle<Value> GetScriptResourceName() const;
697
698 /**
699 * Returns the resource data for the script from where the function causing
700 * the error originates.
701 */
702 Handle<Value> GetScriptData() const;
703
704 /**
Ben Murdoch3bec4d22010-07-22 14:51:16 +0100705 * 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 /**
Steve Blocka7e24c12009-10-30 11:49:00 +0000712 * Returns the number, 1-based, of the line where the error occurred.
713 */
714 int GetLineNumber() const;
715
716 /**
717 * Returns the index within the script of the first character where
718 * the error occurred.
719 */
720 int GetStartPosition() const;
721
722 /**
723 * Returns the index within the script of the last character where
724 * the error occurred.
725 */
726 int GetEndPosition() const;
727
728 /**
729 * Returns the index within the line of the first character where
730 * the error occurred.
731 */
732 int GetStartColumn() const;
733
734 /**
735 * Returns the index within the line of the last character where
736 * the error occurred.
737 */
738 int GetEndColumn() const;
739
740 // TODO(1245381): Print to a string instead of on a FILE.
741 static void PrintCurrentStackTrace(FILE* out);
Kristian Monsen25f61362010-05-21 11:50:48 +0100742
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,
Ben Murdochf87a2032010-10-22 12:50:53 +0100766 kScriptNameOrSourceURL = 1 << 6,
Kristian Monsen25f61362010-05-21 11:50:48 +0100767 kOverview = kLineNumber | kColumnOffset | kScriptName | kFunctionName,
Ben Murdochf87a2032010-10-22 12:50:53 +0100768 kDetailed = kOverview | kIsEval | kIsConstructor | kScriptNameOrSourceURL
Kristian Monsen25f61362010-05-21 11:50:48 +0100769 };
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 /**
Ben Murdoch257744e2011-11-30 15:57:28 +0000787 * Grab a snapshot of the current JavaScript execution stack.
Kristian Monsen25f61362010-05-21 11:50:48 +0100788 *
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 /**
Ben Murdochf87a2032010-10-22 12:50:53 +0100828 * 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 /**
Kristian Monsen25f61362010-05-21 11:50:48 +0100835 * 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 /**
Ben Murdoch257744e2011-11-30 15:57:28 +0000846 * Returns whether or not the associated function is called as a
Kristian Monsen25f61362010-05-21 11:50:48 +0100847 * constructor via "new".
848 */
849 bool IsConstructor() const;
Steve Blocka7e24c12009-10-30 11:49:00 +0000850};
851
852
Ben Murdoch257744e2011-11-30 15:57:28 +0000853// --- Value ---
Steve Blocka7e24c12009-10-30 11:49:00 +0000854
855
856/**
857 * The superclass of all JavaScript values and objects.
858 */
Steve Block8defd9f2010-07-08 12:39:36 +0100859class Value : public Data {
Steve Blocka7e24c12009-10-30 11:49:00 +0000860 public:
Steve Blocka7e24c12009-10-30 11:49:00 +0000861 /**
862 * Returns true if this value is the undefined value. See ECMA-262
863 * 4.3.10.
864 */
Steve Block8defd9f2010-07-08 12:39:36 +0100865 V8EXPORT bool IsUndefined() const;
Steve Blocka7e24c12009-10-30 11:49:00 +0000866
867 /**
868 * Returns true if this value is the null value. See ECMA-262
869 * 4.3.11.
870 */
Steve Block8defd9f2010-07-08 12:39:36 +0100871 V8EXPORT bool IsNull() const;
Steve Blocka7e24c12009-10-30 11:49:00 +0000872
873 /**
874 * Returns true if this value is true.
875 */
Steve Block8defd9f2010-07-08 12:39:36 +0100876 V8EXPORT bool IsTrue() const;
Steve Blocka7e24c12009-10-30 11:49:00 +0000877
878 /**
879 * Returns true if this value is false.
880 */
Steve Block8defd9f2010-07-08 12:39:36 +0100881 V8EXPORT bool IsFalse() const;
Steve Blocka7e24c12009-10-30 11:49:00 +0000882
883 /**
884 * Returns true if this value is an instance of the String type.
885 * See ECMA-262 8.4.
886 */
887 inline bool IsString() const;
888
889 /**
890 * Returns true if this value is a function.
891 */
Steve Block8defd9f2010-07-08 12:39:36 +0100892 V8EXPORT bool IsFunction() const;
Steve Blocka7e24c12009-10-30 11:49:00 +0000893
894 /**
895 * Returns true if this value is an array.
896 */
Steve Block8defd9f2010-07-08 12:39:36 +0100897 V8EXPORT bool IsArray() const;
Steve Blocka7e24c12009-10-30 11:49:00 +0000898
899 /**
900 * Returns true if this value is an object.
901 */
Steve Block8defd9f2010-07-08 12:39:36 +0100902 V8EXPORT bool IsObject() const;
Steve Blocka7e24c12009-10-30 11:49:00 +0000903
904 /**
905 * Returns true if this value is boolean.
906 */
Steve Block8defd9f2010-07-08 12:39:36 +0100907 V8EXPORT bool IsBoolean() const;
Steve Blocka7e24c12009-10-30 11:49:00 +0000908
909 /**
910 * Returns true if this value is a number.
911 */
Steve Block8defd9f2010-07-08 12:39:36 +0100912 V8EXPORT bool IsNumber() const;
Steve Blocka7e24c12009-10-30 11:49:00 +0000913
914 /**
915 * Returns true if this value is external.
916 */
Steve Block8defd9f2010-07-08 12:39:36 +0100917 V8EXPORT bool IsExternal() const;
Steve Blocka7e24c12009-10-30 11:49:00 +0000918
919 /**
920 * Returns true if this value is a 32-bit signed integer.
921 */
Steve Block8defd9f2010-07-08 12:39:36 +0100922 V8EXPORT bool IsInt32() const;
Steve Blocka7e24c12009-10-30 11:49:00 +0000923
924 /**
Steve Block6ded16b2010-05-10 14:33:55 +0100925 * Returns true if this value is a 32-bit unsigned integer.
926 */
Steve Block8defd9f2010-07-08 12:39:36 +0100927 V8EXPORT bool IsUint32() const;
Steve Block6ded16b2010-05-10 14:33:55 +0100928
929 /**
Steve Blocka7e24c12009-10-30 11:49:00 +0000930 * Returns true if this value is a Date.
931 */
Steve Block8defd9f2010-07-08 12:39:36 +0100932 V8EXPORT bool IsDate() const;
Steve Blocka7e24c12009-10-30 11:49:00 +0000933
Iain Merrick75681382010-08-19 15:07:18 +0100934 /**
Ben Murdoch3fb3ca82011-12-02 17:19:32 +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 /**
Iain Merrick75681382010-08-19 15:07:18 +0100955 * Returns true if this value is a RegExp.
956 */
957 V8EXPORT bool IsRegExp() const;
958
Steve Block8defd9f2010-07-08 12:39:36 +0100959 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;
Steve Blocka7e24c12009-10-30 11:49:00 +0000967
968 /**
969 * Attempts to convert a string to an array index.
970 * Returns an empty handle if the conversion fails.
971 */
Steve Block8defd9f2010-07-08 12:39:36 +0100972 V8EXPORT Local<Uint32> ToArrayIndex() const;
Steve Blocka7e24c12009-10-30 11:49:00 +0000973
Steve Block8defd9f2010-07-08 12:39:36 +0100974 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;
Steve Blocka7e24c12009-10-30 11:49:00 +0000979
980 /** JS == */
Steve Block8defd9f2010-07-08 12:39:36 +0100981 V8EXPORT bool Equals(Handle<Value> that) const;
982 V8EXPORT bool StrictEquals(Handle<Value> that) const;
Steve Block3ce2e202009-11-05 08:53:23 +0000983
Steve Blocka7e24c12009-10-30 11:49:00 +0000984 private:
985 inline bool QuickIsString() const;
Steve Block8defd9f2010-07-08 12:39:36 +0100986 V8EXPORT bool FullIsString() const;
Steve Blocka7e24c12009-10-30 11:49:00 +0000987};
988
989
990/**
991 * The superclass of primitive values. See ECMA-262 4.3.2.
992 */
Steve Block8defd9f2010-07-08 12:39:36 +0100993class Primitive : public Value { };
Steve Blocka7e24c12009-10-30 11:49:00 +0000994
995
996/**
997 * A primitive boolean value (ECMA-262, 4.3.14). Either the true
998 * or false value.
999 */
Steve Block8defd9f2010-07-08 12:39:36 +01001000class Boolean : public Primitive {
Steve Blocka7e24c12009-10-30 11:49:00 +00001001 public:
Steve Block8defd9f2010-07-08 12:39:36 +01001002 V8EXPORT bool Value() const;
Steve Blocka7e24c12009-10-30 11:49:00 +00001003 static inline Handle<Boolean> New(bool value);
1004};
1005
1006
1007/**
1008 * A JavaScript string value (ECMA-262, 4.3.17).
1009 */
Steve Block8defd9f2010-07-08 12:39:36 +01001010class String : public Primitive {
Steve Blocka7e24c12009-10-30 11:49:00 +00001011 public:
Steve Blocka7e24c12009-10-30 11:49:00 +00001012 /**
1013 * Returns the number of characters in this string.
1014 */
Steve Block8defd9f2010-07-08 12:39:36 +01001015 V8EXPORT int Length() const;
Steve Blocka7e24c12009-10-30 11:49:00 +00001016
1017 /**
1018 * Returns the number of bytes in the UTF-8 encoded
1019 * representation of this string.
1020 */
Steve Block8defd9f2010-07-08 12:39:36 +01001021 V8EXPORT int Utf8Length() const;
Steve Blocka7e24c12009-10-30 11:49:00 +00001022
1023 /**
1024 * 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 *
Ben Murdochb0fe1622011-05-05 13:52:32 +01001030 * WriteUtf8 will not write partial UTF-8 sequences, preferring to stop
1031 * before the end of the buffer.
1032 *
Steve Blocka7e24c12009-10-30 11:49:00 +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.
Ben Murdochb0fe1622011-05-05 13:52:32 +01001039 * \param length The number of characters to copy from the string. For
1040 * WriteUtf8 the number of bytes in the buffer.
Steve Block6ded16b2010-05-10 14:33:55 +01001041 * \param nchars_ref The number of characters written, can be NULL.
Ben Murdoch69a99ed2011-11-30 16:03:39 +00001042 * \param options Various options that might affect performance of this or
Steve Block6ded16b2010-05-10 14:33:55 +01001043 * subsequent operations.
Ben Murdochb0fe1622011-05-05 13:52:32 +01001044 * \return The number of characters copied to the buffer excluding the null
1045 * terminator. For WriteUtf8: The number of bytes copied to the buffer
Ben Murdoch69a99ed2011-11-30 16:03:39 +00001046 * including the null terminator (if written).
Steve Blocka7e24c12009-10-30 11:49:00 +00001047 */
Ben Murdoch69a99ed2011-11-30 16:03:39 +00001048 enum WriteOptions {
1049 NO_OPTIONS = 0,
1050 HINT_MANY_WRITES_EXPECTED = 1,
1051 NO_NULL_TERMINATION = 2
Steve Block6ded16b2010-05-10 14:33:55 +01001052 };
1053
Ben Murdoch589d6972011-11-30 16:04:58 +00001054 // 16-bit character codes.
Steve Block8defd9f2010-07-08 12:39:36 +01001055 V8EXPORT int Write(uint16_t* buffer,
1056 int start = 0,
1057 int length = -1,
Ben Murdoch589d6972011-11-30 16:04:58 +00001058 int options = NO_OPTIONS) const;
1059 // ASCII characters.
Steve Block8defd9f2010-07-08 12:39:36 +01001060 V8EXPORT int WriteAscii(char* buffer,
1061 int start = 0,
1062 int length = -1,
Ben Murdoch589d6972011-11-30 16:04:58 +00001063 int options = NO_OPTIONS) const;
1064 // UTF-8 encoded characters.
Steve Block8defd9f2010-07-08 12:39:36 +01001065 V8EXPORT int WriteUtf8(char* buffer,
1066 int length = -1,
1067 int* nchars_ref = NULL,
Ben Murdoch589d6972011-11-30 16:04:58 +00001068 int options = NO_OPTIONS) const;
Steve Blocka7e24c12009-10-30 11:49:00 +00001069
1070 /**
1071 * A zero length string.
1072 */
Steve Block8defd9f2010-07-08 12:39:36 +01001073 V8EXPORT static v8::Local<v8::String> Empty();
Steve Blocka7e24c12009-10-30 11:49:00 +00001074
1075 /**
1076 * Returns true if the string is external
1077 */
Steve Block8defd9f2010-07-08 12:39:36 +01001078 V8EXPORT bool IsExternal() const;
Steve Blocka7e24c12009-10-30 11:49:00 +00001079
1080 /**
Ben Murdoch589d6972011-11-30 16:04:58 +00001081 * Returns true if the string is both external and ASCII
Steve Blocka7e24c12009-10-30 11:49:00 +00001082 */
Steve Block8defd9f2010-07-08 12:39:36 +01001083 V8EXPORT bool IsExternalAscii() const;
Leon Clarkee46be812010-01-19 14:06:41 +00001084
Teng-Hui Zhu3e5fa292010-11-09 16:16:48 -08001085 class V8EXPORT ExternalStringResourceBase { // NOLINT
Leon Clarkee46be812010-01-19 14:06:41 +00001086 public:
1087 virtual ~ExternalStringResourceBase() {}
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001088
Leon Clarkee46be812010-01-19 14:06:41 +00001089 protected:
1090 ExternalStringResourceBase() {}
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001091
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
Leon Clarkee46be812010-01-19 14:06:41 +00001100 private:
1101 // Disallow copying and assigning.
1102 ExternalStringResourceBase(const ExternalStringResourceBase&);
1103 void operator=(const ExternalStringResourceBase&);
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001104
1105 friend class v8::internal::Heap;
Leon Clarkee46be812010-01-19 14:06:41 +00001106 };
1107
Steve Blocka7e24c12009-10-30 11:49:00 +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
1112 * buffer. Note that the string data must be immutable.
1113 */
Leon Clarkee46be812010-01-19 14:06:41 +00001114 class V8EXPORT ExternalStringResource
1115 : public ExternalStringResourceBase {
Steve Blocka7e24c12009-10-30 11:49:00 +00001116 public:
1117 /**
1118 * Override the destructor to manage the life cycle of the underlying
1119 * buffer.
1120 */
1121 virtual ~ExternalStringResource() {}
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001122
1123 /**
1124 * The string data from the underlying buffer.
1125 */
Steve Blocka7e24c12009-10-30 11:49:00 +00001126 virtual const uint16_t* data() const = 0;
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001127
1128 /**
1129 * The length of the string. That is, the number of two-byte characters.
1130 */
Steve Blocka7e24c12009-10-30 11:49:00 +00001131 virtual size_t length() const = 0;
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001132
Steve Blocka7e24c12009-10-30 11:49:00 +00001133 protected:
1134 ExternalStringResource() {}
Steve Blocka7e24c12009-10-30 11:49:00 +00001135 };
1136
1137 /**
Ben Murdoch589d6972011-11-30 16:04:58 +00001138 * An ExternalAsciiStringResource is a wrapper around an ASCII
Steve Blocka7e24c12009-10-30 11:49:00 +00001139 * string buffer that resides outside V8's heap. Implement an
1140 * ExternalAsciiStringResource to manage the life cycle of the
1141 * underlying buffer. Note that the string data must be immutable
Ben Murdoch589d6972011-11-30 16:04:58 +00001142 * and that the data must be strict (7-bit) ASCII, not Latin-1 or
Steve Blocka7e24c12009-10-30 11:49:00 +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.
1146 */
1147
Leon Clarkee46be812010-01-19 14:06:41 +00001148 class V8EXPORT ExternalAsciiStringResource
1149 : public ExternalStringResourceBase {
Steve Blocka7e24c12009-10-30 11:49:00 +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;
Ben Murdoch589d6972011-11-30 16:04:58 +00001158 /** The number of ASCII characters in the string.*/
Steve Blocka7e24c12009-10-30 11:49:00 +00001159 virtual size_t length() const = 0;
1160 protected:
1161 ExternalAsciiStringResource() {}
Steve Blocka7e24c12009-10-30 11:49:00 +00001162 };
1163
1164 /**
1165 * Get the ExternalStringResource for an external string. Returns
1166 * NULL if IsExternal() doesn't return true.
1167 */
1168 inline ExternalStringResource* GetExternalStringResource() const;
1169
1170 /**
Ben Murdoch589d6972011-11-30 16:04:58 +00001171 * Get the ExternalAsciiStringResource for an external ASCII string.
Steve Blocka7e24c12009-10-30 11:49:00 +00001172 * Returns NULL if IsExternalAscii() doesn't return true.
1173 */
Steve Block8defd9f2010-07-08 12:39:36 +01001174 V8EXPORT ExternalAsciiStringResource* GetExternalAsciiStringResource() const;
Steve Blocka7e24c12009-10-30 11:49:00 +00001175
1176 static inline String* Cast(v8::Value* obj);
1177
1178 /**
Ben Murdoch589d6972011-11-30 16:04:58 +00001179 * Allocates a new string from either UTF-8 encoded or ASCII data.
Steve Blocka7e24c12009-10-30 11:49:00 +00001180 * The second parameter 'length' gives the buffer length.
Ben Murdoch589d6972011-11-30 16:04:58 +00001181 * If the data is UTF-8 encoded, the caller must
Steve Blocka7e24c12009-10-30 11:49:00 +00001182 * be careful to supply the length parameter.
1183 * If it is not given, the function calls
1184 * 'strlen' to determine the buffer length, it might be
1185 * wrong if 'data' contains a null character.
1186 */
Steve Block8defd9f2010-07-08 12:39:36 +01001187 V8EXPORT static Local<String> New(const char* data, int length = -1);
Steve Blocka7e24c12009-10-30 11:49:00 +00001188
Ben Murdoch589d6972011-11-30 16:04:58 +00001189 /** Allocates a new string from 16-bit character codes.*/
Steve Block8defd9f2010-07-08 12:39:36 +01001190 V8EXPORT static Local<String> New(const uint16_t* data, int length = -1);
Steve Blocka7e24c12009-10-30 11:49:00 +00001191
1192 /** Creates a symbol. Returns one if it exists already.*/
Steve Block8defd9f2010-07-08 12:39:36 +01001193 V8EXPORT static Local<String> NewSymbol(const char* data, int length = -1);
Steve Blocka7e24c12009-10-30 11:49:00 +00001194
1195 /**
Steve Block3ce2e202009-11-05 08:53:23 +00001196 * Creates a new string by concatenating the left and the right strings
1197 * passed in as parameters.
1198 */
Steve Block8defd9f2010-07-08 12:39:36 +01001199 V8EXPORT static Local<String> Concat(Handle<String> left,
1200 Handle<String>right);
Steve Block3ce2e202009-11-05 08:53:23 +00001201
1202 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00001203 * Creates a new external string using the data defined in the given
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001204 * resource. When the external string is no longer live on V8's heap the
1205 * resource will be disposed by calling its Dispose method. The caller of
1206 * this function should not otherwise delete or modify the resource. Neither
1207 * should the underlying buffer be deallocated or modified except through the
1208 * destructor of the external string resource.
Steve Blocka7e24c12009-10-30 11:49:00 +00001209 */
Steve Block8defd9f2010-07-08 12:39:36 +01001210 V8EXPORT static Local<String> NewExternal(ExternalStringResource* resource);
Steve Blocka7e24c12009-10-30 11:49:00 +00001211
1212 /**
1213 * Associate an external string resource with this string by transforming it
1214 * in place so that existing references to this string in the JavaScript heap
1215 * will use the external string resource. The external string resource's
Ben Murdoch257744e2011-11-30 15:57:28 +00001216 * character contents need to be equivalent to this string.
Steve Blocka7e24c12009-10-30 11:49:00 +00001217 * Returns true if the string has been changed to be an external string.
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001218 * The string is not modified if the operation fails. See NewExternal for
1219 * information on the lifetime of the resource.
Steve Blocka7e24c12009-10-30 11:49:00 +00001220 */
Steve Block8defd9f2010-07-08 12:39:36 +01001221 V8EXPORT bool MakeExternal(ExternalStringResource* resource);
Steve Blocka7e24c12009-10-30 11:49:00 +00001222
1223 /**
Ben Murdoch589d6972011-11-30 16:04:58 +00001224 * Creates a new external string using the ASCII data defined in the given
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001225 * resource. When the external string is no longer live on V8's heap the
1226 * resource will be disposed by calling its Dispose method. The caller of
1227 * this function should not otherwise delete or modify the resource. Neither
1228 * should the underlying buffer be deallocated or modified except through the
1229 * destructor of the external string resource.
Steve Blocka7e24c12009-10-30 11:49:00 +00001230 */
Steve Block8defd9f2010-07-08 12:39:36 +01001231 V8EXPORT static Local<String> NewExternal(
1232 ExternalAsciiStringResource* resource);
Steve Blocka7e24c12009-10-30 11:49:00 +00001233
1234 /**
1235 * Associate an external string resource with this string by transforming it
1236 * in place so that existing references to this string in the JavaScript heap
1237 * will use the external string resource. The external string resource's
Ben Murdoch257744e2011-11-30 15:57:28 +00001238 * character contents need to be equivalent to this string.
Steve Blocka7e24c12009-10-30 11:49:00 +00001239 * Returns true if the string has been changed to be an external string.
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001240 * The string is not modified if the operation fails. See NewExternal for
1241 * information on the lifetime of the resource.
Steve Blocka7e24c12009-10-30 11:49:00 +00001242 */
Steve Block8defd9f2010-07-08 12:39:36 +01001243 V8EXPORT bool MakeExternal(ExternalAsciiStringResource* resource);
Steve Blocka7e24c12009-10-30 11:49:00 +00001244
1245 /**
1246 * Returns true if this string can be made external.
1247 */
Steve Block8defd9f2010-07-08 12:39:36 +01001248 V8EXPORT bool CanMakeExternal();
Steve Blocka7e24c12009-10-30 11:49:00 +00001249
Ben Murdoch589d6972011-11-30 16:04:58 +00001250 /** Creates an undetectable string from the supplied ASCII or UTF-8 data.*/
Steve Block8defd9f2010-07-08 12:39:36 +01001251 V8EXPORT static Local<String> NewUndetectable(const char* data,
1252 int length = -1);
Steve Blocka7e24c12009-10-30 11:49:00 +00001253
Ben Murdoch589d6972011-11-30 16:04:58 +00001254 /** Creates an undetectable string from the supplied 16-bit character codes.*/
Steve Block8defd9f2010-07-08 12:39:36 +01001255 V8EXPORT static Local<String> NewUndetectable(const uint16_t* data,
1256 int length = -1);
Steve Blocka7e24c12009-10-30 11:49:00 +00001257
1258 /**
Ben Murdoch589d6972011-11-30 16:04:58 +00001259 * Converts an object to a UTF-8-encoded character array. Useful if
Steve Blocka7e24c12009-10-30 11:49:00 +00001260 * you want to print the object. If conversion to a string fails
Ben Murdoch589d6972011-11-30 16:04:58 +00001261 * (e.g. due to an exception in the toString() method of the object)
Steve Blocka7e24c12009-10-30 11:49:00 +00001262 * then the length() method returns 0 and the * operator returns
1263 * NULL.
1264 */
1265 class V8EXPORT Utf8Value {
1266 public:
1267 explicit Utf8Value(Handle<v8::Value> obj);
1268 ~Utf8Value();
1269 char* operator*() { return str_; }
1270 const char* operator*() const { return str_; }
1271 int length() const { return length_; }
1272 private:
1273 char* str_;
1274 int length_;
1275
1276 // Disallow copying and assigning.
1277 Utf8Value(const Utf8Value&);
1278 void operator=(const Utf8Value&);
1279 };
1280
1281 /**
Ben Murdoch589d6972011-11-30 16:04:58 +00001282 * Converts an object to an ASCII string.
Steve Blocka7e24c12009-10-30 11:49:00 +00001283 * Useful if you want to print the object.
1284 * If conversion to a string fails (eg. due to an exception in the toString()
1285 * method of the object) then the length() method returns 0 and the * operator
1286 * returns NULL.
1287 */
1288 class V8EXPORT AsciiValue {
1289 public:
1290 explicit AsciiValue(Handle<v8::Value> obj);
1291 ~AsciiValue();
1292 char* operator*() { return str_; }
1293 const char* operator*() const { return str_; }
1294 int length() const { return length_; }
1295 private:
1296 char* str_;
1297 int length_;
1298
1299 // Disallow copying and assigning.
1300 AsciiValue(const AsciiValue&);
1301 void operator=(const AsciiValue&);
1302 };
1303
1304 /**
1305 * Converts an object to a two-byte string.
1306 * If conversion to a string fails (eg. due to an exception in the toString()
1307 * method of the object) then the length() method returns 0 and the * operator
1308 * returns NULL.
1309 */
1310 class V8EXPORT Value {
1311 public:
1312 explicit Value(Handle<v8::Value> obj);
1313 ~Value();
1314 uint16_t* operator*() { return str_; }
1315 const uint16_t* operator*() const { return str_; }
1316 int length() const { return length_; }
1317 private:
1318 uint16_t* str_;
1319 int length_;
1320
1321 // Disallow copying and assigning.
1322 Value(const Value&);
1323 void operator=(const Value&);
1324 };
Steve Block3ce2e202009-11-05 08:53:23 +00001325
Steve Blocka7e24c12009-10-30 11:49:00 +00001326 private:
Steve Block8defd9f2010-07-08 12:39:36 +01001327 V8EXPORT void VerifyExternalStringResource(ExternalStringResource* val) const;
1328 V8EXPORT static void CheckCast(v8::Value* obj);
Steve Blocka7e24c12009-10-30 11:49:00 +00001329};
1330
1331
1332/**
1333 * A JavaScript number value (ECMA-262, 4.3.20)
1334 */
Steve Block8defd9f2010-07-08 12:39:36 +01001335class Number : public Primitive {
Steve Blocka7e24c12009-10-30 11:49:00 +00001336 public:
Steve Block8defd9f2010-07-08 12:39:36 +01001337 V8EXPORT double Value() const;
1338 V8EXPORT static Local<Number> New(double value);
Steve Blocka7e24c12009-10-30 11:49:00 +00001339 static inline Number* Cast(v8::Value* obj);
1340 private:
Steve Block8defd9f2010-07-08 12:39:36 +01001341 V8EXPORT Number();
Ben Murdoch69a99ed2011-11-30 16:03:39 +00001342 V8EXPORT static void CheckCast(v8::Value* obj);
Steve Blocka7e24c12009-10-30 11:49:00 +00001343};
1344
1345
1346/**
1347 * A JavaScript value representing a signed integer.
1348 */
Steve Block8defd9f2010-07-08 12:39:36 +01001349class Integer : public Number {
Steve Blocka7e24c12009-10-30 11:49:00 +00001350 public:
Steve Block8defd9f2010-07-08 12:39:36 +01001351 V8EXPORT static Local<Integer> New(int32_t value);
1352 V8EXPORT static Local<Integer> NewFromUnsigned(uint32_t value);
1353 V8EXPORT int64_t Value() const;
Steve Blocka7e24c12009-10-30 11:49:00 +00001354 static inline Integer* Cast(v8::Value* obj);
1355 private:
Steve Block8defd9f2010-07-08 12:39:36 +01001356 V8EXPORT Integer();
1357 V8EXPORT static void CheckCast(v8::Value* obj);
Steve Blocka7e24c12009-10-30 11:49:00 +00001358};
1359
1360
1361/**
1362 * A JavaScript value representing a 32-bit signed integer.
1363 */
Steve Block8defd9f2010-07-08 12:39:36 +01001364class Int32 : public Integer {
Steve Blocka7e24c12009-10-30 11:49:00 +00001365 public:
Steve Block8defd9f2010-07-08 12:39:36 +01001366 V8EXPORT int32_t Value() const;
Steve Blocka7e24c12009-10-30 11:49:00 +00001367 private:
Steve Block8defd9f2010-07-08 12:39:36 +01001368 V8EXPORT Int32();
Steve Blocka7e24c12009-10-30 11:49:00 +00001369};
1370
1371
1372/**
1373 * A JavaScript value representing a 32-bit unsigned integer.
1374 */
Steve Block8defd9f2010-07-08 12:39:36 +01001375class Uint32 : public Integer {
Steve Blocka7e24c12009-10-30 11:49:00 +00001376 public:
Steve Block8defd9f2010-07-08 12:39:36 +01001377 V8EXPORT uint32_t Value() const;
Steve Blocka7e24c12009-10-30 11:49:00 +00001378 private:
Steve Block8defd9f2010-07-08 12:39:36 +01001379 V8EXPORT Uint32();
Steve Blocka7e24c12009-10-30 11:49:00 +00001380};
1381
1382
Steve Blocka7e24c12009-10-30 11:49:00 +00001383enum PropertyAttribute {
1384 None = 0,
1385 ReadOnly = 1 << 0,
1386 DontEnum = 1 << 1,
1387 DontDelete = 1 << 2
1388};
1389
Steve Block3ce2e202009-11-05 08:53:23 +00001390enum ExternalArrayType {
1391 kExternalByteArray = 1,
1392 kExternalUnsignedByteArray,
1393 kExternalShortArray,
1394 kExternalUnsignedShortArray,
1395 kExternalIntArray,
1396 kExternalUnsignedIntArray,
Steve Block44f0eee2011-05-26 01:26:41 +01001397 kExternalFloatArray,
Ben Murdoch257744e2011-11-30 15:57:28 +00001398 kExternalDoubleArray,
Steve Block44f0eee2011-05-26 01:26:41 +01001399 kExternalPixelArray
Steve Block3ce2e202009-11-05 08:53:23 +00001400};
1401
Steve Blocka7e24c12009-10-30 11:49:00 +00001402/**
Leon Clarkef7060e22010-06-03 12:02:55 +01001403 * Accessor[Getter|Setter] are used as callback functions when
1404 * setting|getting a particular property. See Object and ObjectTemplate's
1405 * method SetAccessor.
1406 */
1407typedef Handle<Value> (*AccessorGetter)(Local<String> property,
1408 const AccessorInfo& info);
1409
1410
1411typedef void (*AccessorSetter)(Local<String> property,
1412 Local<Value> value,
1413 const AccessorInfo& info);
1414
1415
1416/**
1417 * Access control specifications.
1418 *
1419 * Some accessors should be accessible across contexts. These
1420 * accessors have an explicit access control parameter which specifies
1421 * the kind of cross-context access that should be allowed.
1422 *
1423 * Additionally, for security, accessors can prohibit overwriting by
1424 * accessors defined in JavaScript. For objects that have such
1425 * accessors either locally or in their prototype chain it is not
1426 * possible to overwrite the accessor by using __defineGetter__ or
1427 * __defineSetter__ from JavaScript code.
1428 */
1429enum AccessControl {
1430 DEFAULT = 0,
1431 ALL_CAN_READ = 1,
1432 ALL_CAN_WRITE = 1 << 1,
1433 PROHIBITS_OVERWRITING = 1 << 2
1434};
1435
1436
1437/**
Steve Blocka7e24c12009-10-30 11:49:00 +00001438 * A JavaScript object (ECMA-262, 4.3.3)
1439 */
Steve Block8defd9f2010-07-08 12:39:36 +01001440class Object : public Value {
Steve Blocka7e24c12009-10-30 11:49:00 +00001441 public:
Steve Block8defd9f2010-07-08 12:39:36 +01001442 V8EXPORT bool Set(Handle<Value> key,
1443 Handle<Value> value,
1444 PropertyAttribute attribs = None);
Steve Blocka7e24c12009-10-30 11:49:00 +00001445
Steve Block8defd9f2010-07-08 12:39:36 +01001446 V8EXPORT bool Set(uint32_t index,
1447 Handle<Value> value);
Steve Block6ded16b2010-05-10 14:33:55 +01001448
Steve Blocka7e24c12009-10-30 11:49:00 +00001449 // Sets a local property on this object bypassing interceptors and
1450 // overriding accessors or read-only properties.
1451 //
1452 // Note that if the object has an interceptor the property will be set
1453 // locally, but since the interceptor takes precedence the local property
1454 // will only be returned if the interceptor doesn't return a value.
1455 //
1456 // Note also that this only works for named properties.
Steve Block8defd9f2010-07-08 12:39:36 +01001457 V8EXPORT bool ForceSet(Handle<Value> key,
1458 Handle<Value> value,
1459 PropertyAttribute attribs = None);
Steve Blocka7e24c12009-10-30 11:49:00 +00001460
Steve Block8defd9f2010-07-08 12:39:36 +01001461 V8EXPORT Local<Value> Get(Handle<Value> key);
Steve Blocka7e24c12009-10-30 11:49:00 +00001462
Steve Block8defd9f2010-07-08 12:39:36 +01001463 V8EXPORT Local<Value> Get(uint32_t index);
Steve Block6ded16b2010-05-10 14:33:55 +01001464
Ben Murdoch3fb3ca82011-12-02 17:19:32 +00001465 /**
1466 * Gets the property attributes of a property which can be None or
1467 * any combination of ReadOnly, DontEnum and DontDelete. Returns
1468 * None when the property doesn't exist.
1469 */
1470 V8EXPORT PropertyAttribute GetPropertyAttributes(Handle<Value> key);
1471
Steve Blocka7e24c12009-10-30 11:49:00 +00001472 // TODO(1245389): Replace the type-specific versions of these
1473 // functions with generic ones that accept a Handle<Value> key.
Steve Block8defd9f2010-07-08 12:39:36 +01001474 V8EXPORT bool Has(Handle<String> key);
Steve Blocka7e24c12009-10-30 11:49:00 +00001475
Steve Block8defd9f2010-07-08 12:39:36 +01001476 V8EXPORT bool Delete(Handle<String> key);
Steve Blocka7e24c12009-10-30 11:49:00 +00001477
1478 // Delete a property on this object bypassing interceptors and
1479 // ignoring dont-delete attributes.
Steve Block8defd9f2010-07-08 12:39:36 +01001480 V8EXPORT bool ForceDelete(Handle<Value> key);
Steve Blocka7e24c12009-10-30 11:49:00 +00001481
Steve Block8defd9f2010-07-08 12:39:36 +01001482 V8EXPORT bool Has(uint32_t index);
Steve Blocka7e24c12009-10-30 11:49:00 +00001483
Steve Block8defd9f2010-07-08 12:39:36 +01001484 V8EXPORT bool Delete(uint32_t index);
Steve Blocka7e24c12009-10-30 11:49:00 +00001485
Steve Block8defd9f2010-07-08 12:39:36 +01001486 V8EXPORT bool SetAccessor(Handle<String> name,
1487 AccessorGetter getter,
1488 AccessorSetter setter = 0,
1489 Handle<Value> data = Handle<Value>(),
1490 AccessControl settings = DEFAULT,
1491 PropertyAttribute attribute = None);
Leon Clarkef7060e22010-06-03 12:02:55 +01001492
Steve Blocka7e24c12009-10-30 11:49:00 +00001493 /**
1494 * Returns an array containing the names of the enumerable properties
1495 * of this object, including properties from prototype objects. The
1496 * array returned by this method contains the same values as would
1497 * be enumerated by a for-in statement over this object.
1498 */
Steve Block8defd9f2010-07-08 12:39:36 +01001499 V8EXPORT Local<Array> GetPropertyNames();
Steve Blocka7e24c12009-10-30 11:49:00 +00001500
1501 /**
Ben Murdoch3fb3ca82011-12-02 17:19:32 +00001502 * This function has the same functionality as GetPropertyNames but
1503 * the returned array doesn't contain the names of properties from
1504 * prototype objects.
1505 */
1506 V8EXPORT Local<Array> GetOwnPropertyNames();
1507
1508 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00001509 * Get the prototype object. This does not skip objects marked to
1510 * be skipped by __proto__ and it does not consult the security
1511 * handler.
1512 */
Steve Block8defd9f2010-07-08 12:39:36 +01001513 V8EXPORT Local<Value> GetPrototype();
Steve Blocka7e24c12009-10-30 11:49:00 +00001514
1515 /**
Andrei Popescu402d9372010-02-26 13:31:12 +00001516 * Set the prototype object. This does not skip objects marked to
1517 * be skipped by __proto__ and it does not consult the security
1518 * handler.
1519 */
Steve Block8defd9f2010-07-08 12:39:36 +01001520 V8EXPORT bool SetPrototype(Handle<Value> prototype);
Andrei Popescu402d9372010-02-26 13:31:12 +00001521
1522 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00001523 * Finds an instance of the given function template in the prototype
1524 * chain.
1525 */
Steve Block8defd9f2010-07-08 12:39:36 +01001526 V8EXPORT Local<Object> FindInstanceInPrototypeChain(
1527 Handle<FunctionTemplate> tmpl);
Steve Blocka7e24c12009-10-30 11:49:00 +00001528
1529 /**
1530 * Call builtin Object.prototype.toString on this object.
1531 * This is different from Value::ToString() that may call
1532 * user-defined toString function. This one does not.
1533 */
Steve Block8defd9f2010-07-08 12:39:36 +01001534 V8EXPORT Local<String> ObjectProtoToString();
Steve Blocka7e24c12009-10-30 11:49:00 +00001535
Shimeng (Simon) Wang8a31eba2010-12-06 19:01:33 -08001536 /**
1537 * Returns the name of the function invoked as a constructor for this object.
1538 */
1539 V8EXPORT Local<String> GetConstructorName();
1540
Steve Blocka7e24c12009-10-30 11:49:00 +00001541 /** Gets the number of internal fields for this Object. */
Steve Block8defd9f2010-07-08 12:39:36 +01001542 V8EXPORT int InternalFieldCount();
Steve Blocka7e24c12009-10-30 11:49:00 +00001543 /** Gets the value in an internal field. */
1544 inline Local<Value> GetInternalField(int index);
1545 /** Sets the value in an internal field. */
Steve Block8defd9f2010-07-08 12:39:36 +01001546 V8EXPORT void SetInternalField(int index, Handle<Value> value);
Steve Blocka7e24c12009-10-30 11:49:00 +00001547
1548 /** Gets a native pointer from an internal field. */
1549 inline void* GetPointerFromInternalField(int index);
Steve Block3ce2e202009-11-05 08:53:23 +00001550
Steve Blocka7e24c12009-10-30 11:49:00 +00001551 /** Sets a native pointer in an internal field. */
Steve Block8defd9f2010-07-08 12:39:36 +01001552 V8EXPORT void SetPointerInInternalField(int index, void* value);
Steve Blocka7e24c12009-10-30 11:49:00 +00001553
1554 // Testers for local properties.
Ben Murdoch257744e2011-11-30 15:57:28 +00001555 V8EXPORT bool HasOwnProperty(Handle<String> key);
Steve Block8defd9f2010-07-08 12:39:36 +01001556 V8EXPORT bool HasRealNamedProperty(Handle<String> key);
1557 V8EXPORT bool HasRealIndexedProperty(uint32_t index);
1558 V8EXPORT bool HasRealNamedCallbackProperty(Handle<String> key);
Steve Blocka7e24c12009-10-30 11:49:00 +00001559
1560 /**
1561 * If result.IsEmpty() no real property was located in the prototype chain.
1562 * This means interceptors in the prototype chain are not called.
1563 */
Steve Block8defd9f2010-07-08 12:39:36 +01001564 V8EXPORT Local<Value> GetRealNamedPropertyInPrototypeChain(
1565 Handle<String> key);
Steve Blocka7e24c12009-10-30 11:49:00 +00001566
1567 /**
1568 * If result.IsEmpty() no real property was located on the object or
1569 * in the prototype chain.
1570 * This means interceptors in the prototype chain are not called.
1571 */
Steve Block8defd9f2010-07-08 12:39:36 +01001572 V8EXPORT Local<Value> GetRealNamedProperty(Handle<String> key);
Steve Blocka7e24c12009-10-30 11:49:00 +00001573
1574 /** Tests for a named lookup interceptor.*/
Steve Block8defd9f2010-07-08 12:39:36 +01001575 V8EXPORT bool HasNamedLookupInterceptor();
Steve Blocka7e24c12009-10-30 11:49:00 +00001576
1577 /** Tests for an index lookup interceptor.*/
Steve Block8defd9f2010-07-08 12:39:36 +01001578 V8EXPORT bool HasIndexedLookupInterceptor();
Steve Blocka7e24c12009-10-30 11:49:00 +00001579
1580 /**
1581 * Turns on access check on the object if the object is an instance of
1582 * a template that has access check callbacks. If an object has no
1583 * access check info, the object cannot be accessed by anyone.
1584 */
Steve Block8defd9f2010-07-08 12:39:36 +01001585 V8EXPORT void TurnOnAccessCheck();
Steve Blocka7e24c12009-10-30 11:49:00 +00001586
1587 /**
Ben Murdoch257744e2011-11-30 15:57:28 +00001588 * Returns the identity hash for this object. The current implementation
1589 * uses a hidden property on the object to store the identity hash.
Steve Blocka7e24c12009-10-30 11:49:00 +00001590 *
1591 * The return value will never be 0. Also, it is not guaranteed to be
1592 * unique.
1593 */
Steve Block8defd9f2010-07-08 12:39:36 +01001594 V8EXPORT int GetIdentityHash();
Steve Blocka7e24c12009-10-30 11:49:00 +00001595
1596 /**
1597 * Access hidden properties on JavaScript objects. These properties are
1598 * hidden from the executing JavaScript and only accessible through the V8
1599 * C++ API. Hidden properties introduced by V8 internally (for example the
1600 * identity hash) are prefixed with "v8::".
1601 */
Steve Block8defd9f2010-07-08 12:39:36 +01001602 V8EXPORT bool SetHiddenValue(Handle<String> key, Handle<Value> value);
1603 V8EXPORT Local<Value> GetHiddenValue(Handle<String> key);
1604 V8EXPORT bool DeleteHiddenValue(Handle<String> key);
Steve Block3ce2e202009-11-05 08:53:23 +00001605
Steve Blocka7e24c12009-10-30 11:49:00 +00001606 /**
1607 * Returns true if this is an instance of an api function (one
1608 * created from a function created from a function template) and has
1609 * been modified since it was created. Note that this method is
1610 * conservative and may return true for objects that haven't actually
1611 * been modified.
1612 */
Steve Block8defd9f2010-07-08 12:39:36 +01001613 V8EXPORT bool IsDirty();
Steve Blocka7e24c12009-10-30 11:49:00 +00001614
1615 /**
1616 * Clone this object with a fast but shallow copy. Values will point
1617 * to the same values as the original object.
1618 */
Steve Block8defd9f2010-07-08 12:39:36 +01001619 V8EXPORT Local<Object> Clone();
Steve Blocka7e24c12009-10-30 11:49:00 +00001620
1621 /**
Ben Murdoch8b112d22011-06-08 16:22:53 +01001622 * Returns the context in which the object was created.
1623 */
1624 V8EXPORT Local<Context> CreationContext();
1625
1626 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00001627 * Set the backing store of the indexed properties to be managed by the
1628 * embedding layer. Access to the indexed properties will follow the rules
1629 * spelled out in CanvasPixelArray.
1630 * Note: The embedding program still owns the data and needs to ensure that
1631 * the backing store is preserved while V8 has a reference.
1632 */
Steve Block8defd9f2010-07-08 12:39:36 +01001633 V8EXPORT void SetIndexedPropertiesToPixelData(uint8_t* data, int length);
Steve Block9fac8402011-05-12 15:51:54 +01001634 V8EXPORT bool HasIndexedPropertiesInPixelData();
1635 V8EXPORT uint8_t* GetIndexedPropertiesPixelData();
1636 V8EXPORT int GetIndexedPropertiesPixelDataLength();
Steve Blocka7e24c12009-10-30 11:49:00 +00001637
Steve Block3ce2e202009-11-05 08:53:23 +00001638 /**
1639 * Set the backing store of the indexed properties to be managed by the
1640 * embedding layer. Access to the indexed properties will follow the rules
1641 * spelled out for the CanvasArray subtypes in the WebGL specification.
1642 * Note: The embedding program still owns the data and needs to ensure that
1643 * the backing store is preserved while V8 has a reference.
1644 */
Steve Block8defd9f2010-07-08 12:39:36 +01001645 V8EXPORT void SetIndexedPropertiesToExternalArrayData(
1646 void* data,
1647 ExternalArrayType array_type,
1648 int number_of_elements);
Steve Block9fac8402011-05-12 15:51:54 +01001649 V8EXPORT bool HasIndexedPropertiesInExternalArrayData();
1650 V8EXPORT void* GetIndexedPropertiesExternalArrayData();
1651 V8EXPORT ExternalArrayType GetIndexedPropertiesExternalArrayDataType();
1652 V8EXPORT int GetIndexedPropertiesExternalArrayDataLength();
Steve Block3ce2e202009-11-05 08:53:23 +00001653
Ben Murdoch257744e2011-11-30 15:57:28 +00001654 /**
1655 * Checks whether a callback is set by the
1656 * ObjectTemplate::SetCallAsFunctionHandler method.
1657 * When an Object is callable this method returns true.
1658 */
1659 V8EXPORT bool IsCallable();
1660
1661 /**
Ben Murdoch589d6972011-11-30 16:04:58 +00001662 * Call an Object as a function if a callback is set by the
Ben Murdoch257744e2011-11-30 15:57:28 +00001663 * ObjectTemplate::SetCallAsFunctionHandler method.
1664 */
1665 V8EXPORT Local<Value> CallAsFunction(Handle<Object> recv,
1666 int argc,
1667 Handle<Value> argv[]);
1668
1669 /**
1670 * Call an Object as a constructor if a callback is set by the
1671 * ObjectTemplate::SetCallAsFunctionHandler method.
1672 * Note: This method behaves like the Function::NewInstance method.
1673 */
1674 V8EXPORT Local<Value> CallAsConstructor(int argc,
1675 Handle<Value> argv[]);
1676
Steve Block8defd9f2010-07-08 12:39:36 +01001677 V8EXPORT static Local<Object> New();
Steve Blocka7e24c12009-10-30 11:49:00 +00001678 static inline Object* Cast(Value* obj);
Ben Murdoch3fb3ca82011-12-02 17:19:32 +00001679
Steve Blocka7e24c12009-10-30 11:49:00 +00001680 private:
Steve Block8defd9f2010-07-08 12:39:36 +01001681 V8EXPORT Object();
1682 V8EXPORT static void CheckCast(Value* obj);
1683 V8EXPORT Local<Value> CheckedGetInternalField(int index);
1684 V8EXPORT void* SlowGetPointerFromInternalField(int index);
Steve Blocka7e24c12009-10-30 11:49:00 +00001685
1686 /**
1687 * If quick access to the internal field is possible this method
Steve Block3ce2e202009-11-05 08:53:23 +00001688 * returns the value. Otherwise an empty handle is returned.
Steve Blocka7e24c12009-10-30 11:49:00 +00001689 */
1690 inline Local<Value> UncheckedGetInternalField(int index);
1691};
1692
1693
1694/**
1695 * An instance of the built-in array constructor (ECMA-262, 15.4.2).
1696 */
Steve Block8defd9f2010-07-08 12:39:36 +01001697class Array : public Object {
Steve Blocka7e24c12009-10-30 11:49:00 +00001698 public:
Steve Block8defd9f2010-07-08 12:39:36 +01001699 V8EXPORT uint32_t Length() const;
Steve Blocka7e24c12009-10-30 11:49:00 +00001700
1701 /**
1702 * Clones an element at index |index|. Returns an empty
1703 * handle if cloning fails (for any reason).
1704 */
Steve Block8defd9f2010-07-08 12:39:36 +01001705 V8EXPORT Local<Object> CloneElementAt(uint32_t index);
Steve Blocka7e24c12009-10-30 11:49:00 +00001706
Steve Block44f0eee2011-05-26 01:26:41 +01001707 /**
1708 * Creates a JavaScript array with the given length. If the length
1709 * is negative the returned array will have length 0.
1710 */
Steve Block8defd9f2010-07-08 12:39:36 +01001711 V8EXPORT static Local<Array> New(int length = 0);
Steve Block44f0eee2011-05-26 01:26:41 +01001712
Steve Blocka7e24c12009-10-30 11:49:00 +00001713 static inline Array* Cast(Value* obj);
1714 private:
Steve Block8defd9f2010-07-08 12:39:36 +01001715 V8EXPORT Array();
Ben Murdoch69a99ed2011-11-30 16:03:39 +00001716 V8EXPORT static void CheckCast(Value* obj);
Steve Blocka7e24c12009-10-30 11:49:00 +00001717};
1718
1719
1720/**
1721 * A JavaScript function object (ECMA-262, 15.3).
1722 */
Steve Block8defd9f2010-07-08 12:39:36 +01001723class Function : public Object {
Steve Blocka7e24c12009-10-30 11:49:00 +00001724 public:
Steve Block8defd9f2010-07-08 12:39:36 +01001725 V8EXPORT Local<Object> NewInstance() const;
1726 V8EXPORT Local<Object> NewInstance(int argc, Handle<Value> argv[]) const;
1727 V8EXPORT Local<Value> Call(Handle<Object> recv,
1728 int argc,
1729 Handle<Value> argv[]);
1730 V8EXPORT void SetName(Handle<String> name);
1731 V8EXPORT Handle<Value> GetName() const;
Andrei Popescu402d9372010-02-26 13:31:12 +00001732
1733 /**
1734 * Returns zero based line number of function body and
1735 * kLineOffsetNotFound if no information available.
1736 */
Steve Block8defd9f2010-07-08 12:39:36 +01001737 V8EXPORT int GetScriptLineNumber() const;
1738 V8EXPORT ScriptOrigin GetScriptOrigin() const;
Steve Blocka7e24c12009-10-30 11:49:00 +00001739 static inline Function* Cast(Value* obj);
Steve Block8defd9f2010-07-08 12:39:36 +01001740 V8EXPORT static const int kLineOffsetNotFound;
Steve Blocka7e24c12009-10-30 11:49:00 +00001741 private:
Steve Block8defd9f2010-07-08 12:39:36 +01001742 V8EXPORT Function();
1743 V8EXPORT static void CheckCast(Value* obj);
Steve Blocka7e24c12009-10-30 11:49:00 +00001744};
1745
1746
1747/**
Ben Murdoch257744e2011-11-30 15:57:28 +00001748 * An instance of the built-in Date constructor (ECMA-262, 15.9).
1749 */
1750class Date : public Object {
1751 public:
1752 V8EXPORT static Local<Value> New(double time);
1753
1754 /**
1755 * A specialization of Value::NumberValue that is more efficient
1756 * because we know the structure of this object.
1757 */
1758 V8EXPORT double NumberValue() const;
1759
1760 static inline Date* Cast(v8::Value* obj);
1761
1762 /**
1763 * Notification that the embedder has changed the time zone,
1764 * daylight savings time, or other date / time configuration
1765 * parameters. V8 keeps a cache of various values used for
1766 * date / time computation. This notification will reset
1767 * those cached values for the current context so that date /
1768 * time configuration changes would be reflected in the Date
1769 * object.
1770 *
1771 * This API should not be called more than needed as it will
1772 * negatively impact the performance of date operations.
1773 */
1774 V8EXPORT static void DateTimeConfigurationChangeNotification();
1775
1776 private:
1777 V8EXPORT static void CheckCast(v8::Value* obj);
1778};
1779
1780
1781/**
Ben Murdoch3fb3ca82011-12-02 17:19:32 +00001782 * A Number object (ECMA-262, 4.3.21).
1783 */
1784class NumberObject : public Object {
1785 public:
1786 V8EXPORT static Local<Value> New(double value);
1787
1788 /**
1789 * Returns the Number held by the object.
1790 */
1791 V8EXPORT double NumberValue() const;
1792
1793 static inline NumberObject* Cast(v8::Value* obj);
1794
1795 private:
1796 V8EXPORT static void CheckCast(v8::Value* obj);
1797};
1798
1799
1800/**
1801 * A Boolean object (ECMA-262, 4.3.15).
1802 */
1803class BooleanObject : public Object {
1804 public:
1805 V8EXPORT static Local<Value> New(bool value);
1806
1807 /**
1808 * Returns the Boolean held by the object.
1809 */
1810 V8EXPORT bool BooleanValue() const;
1811
1812 static inline BooleanObject* Cast(v8::Value* obj);
1813
1814 private:
1815 V8EXPORT static void CheckCast(v8::Value* obj);
1816};
1817
1818
1819/**
1820 * A String object (ECMA-262, 4.3.18).
1821 */
1822class StringObject : public Object {
1823 public:
1824 V8EXPORT static Local<Value> New(Handle<String> value);
1825
1826 /**
1827 * Returns the String held by the object.
1828 */
1829 V8EXPORT Local<String> StringValue() const;
1830
1831 static inline StringObject* Cast(v8::Value* obj);
1832
1833 private:
1834 V8EXPORT static void CheckCast(v8::Value* obj);
1835};
1836
1837
1838/**
Ben Murdoch257744e2011-11-30 15:57:28 +00001839 * An instance of the built-in RegExp constructor (ECMA-262, 15.10).
1840 */
1841class RegExp : public Object {
1842 public:
1843 /**
1844 * Regular expression flag bits. They can be or'ed to enable a set
1845 * of flags.
1846 */
1847 enum Flags {
1848 kNone = 0,
1849 kGlobal = 1,
1850 kIgnoreCase = 2,
1851 kMultiline = 4
1852 };
1853
1854 /**
1855 * Creates a regular expression from the given pattern string and
1856 * the flags bit field. May throw a JavaScript exception as
1857 * described in ECMA-262, 15.10.4.1.
1858 *
1859 * For example,
1860 * RegExp::New(v8::String::New("foo"),
1861 * static_cast<RegExp::Flags>(kGlobal | kMultiline))
1862 * is equivalent to evaluating "/foo/gm".
1863 */
1864 V8EXPORT static Local<RegExp> New(Handle<String> pattern,
1865 Flags flags);
1866
1867 /**
1868 * Returns the value of the source property: a string representing
1869 * the regular expression.
1870 */
1871 V8EXPORT Local<String> GetSource() const;
1872
1873 /**
1874 * Returns the flags bit field.
1875 */
1876 V8EXPORT Flags GetFlags() const;
1877
1878 static inline RegExp* Cast(v8::Value* obj);
1879
1880 private:
1881 V8EXPORT static void CheckCast(v8::Value* obj);
1882};
1883
1884
1885/**
Steve Blocka7e24c12009-10-30 11:49:00 +00001886 * A JavaScript value that wraps a C++ void*. This type of value is
1887 * mainly used to associate C++ data structures with JavaScript
1888 * objects.
1889 *
1890 * The Wrap function V8 will return the most optimal Value object wrapping the
1891 * C++ void*. The type of the value is not guaranteed to be an External object
1892 * and no assumptions about its type should be made. To access the wrapped
1893 * value Unwrap should be used, all other operations on that object will lead
1894 * to unpredictable results.
1895 */
Steve Block8defd9f2010-07-08 12:39:36 +01001896class External : public Value {
Steve Blocka7e24c12009-10-30 11:49:00 +00001897 public:
Steve Block8defd9f2010-07-08 12:39:36 +01001898 V8EXPORT static Local<Value> Wrap(void* data);
Steve Blocka7e24c12009-10-30 11:49:00 +00001899 static inline void* Unwrap(Handle<Value> obj);
1900
Steve Block8defd9f2010-07-08 12:39:36 +01001901 V8EXPORT static Local<External> New(void* value);
Steve Blocka7e24c12009-10-30 11:49:00 +00001902 static inline External* Cast(Value* obj);
Steve Block8defd9f2010-07-08 12:39:36 +01001903 V8EXPORT void* Value() const;
Steve Blocka7e24c12009-10-30 11:49:00 +00001904 private:
Steve Block8defd9f2010-07-08 12:39:36 +01001905 V8EXPORT External();
1906 V8EXPORT static void CheckCast(v8::Value* obj);
Steve Blocka7e24c12009-10-30 11:49:00 +00001907 static inline void* QuickUnwrap(Handle<v8::Value> obj);
Steve Block8defd9f2010-07-08 12:39:36 +01001908 V8EXPORT static void* FullUnwrap(Handle<v8::Value> obj);
Steve Blocka7e24c12009-10-30 11:49:00 +00001909};
1910
1911
Ben Murdoch257744e2011-11-30 15:57:28 +00001912// --- Templates ---
Steve Blocka7e24c12009-10-30 11:49:00 +00001913
1914
1915/**
1916 * The superclass of object and function templates.
1917 */
1918class V8EXPORT Template : public Data {
1919 public:
1920 /** Adds a property to each instance created by this template.*/
1921 void Set(Handle<String> name, Handle<Data> value,
1922 PropertyAttribute attributes = None);
1923 inline void Set(const char* name, Handle<Data> value);
1924 private:
1925 Template();
1926
1927 friend class ObjectTemplate;
1928 friend class FunctionTemplate;
1929};
1930
1931
1932/**
1933 * The argument information given to function call callbacks. This
1934 * class provides access to information about the context of the call,
1935 * including the receiver, the number and values of arguments, and
1936 * the holder of the function.
1937 */
Steve Block8defd9f2010-07-08 12:39:36 +01001938class Arguments {
Steve Blocka7e24c12009-10-30 11:49:00 +00001939 public:
1940 inline int Length() const;
1941 inline Local<Value> operator[](int i) const;
1942 inline Local<Function> Callee() const;
1943 inline Local<Object> This() const;
1944 inline Local<Object> Holder() const;
1945 inline bool IsConstructCall() const;
1946 inline Local<Value> Data() const;
1947 private:
Teng-Hui Zhu3e5fa292010-11-09 16:16:48 -08001948 static const int kDataIndex = 0;
1949 static const int kCalleeIndex = -1;
1950 static const int kHolderIndex = -2;
1951
Steve Blocka7e24c12009-10-30 11:49:00 +00001952 friend class ImplementationUtilities;
Teng-Hui Zhu3e5fa292010-11-09 16:16:48 -08001953 inline Arguments(internal::Object** implicit_args,
1954 internal::Object** values,
1955 int length,
1956 bool is_construct_call);
1957 internal::Object** implicit_args_;
1958 internal::Object** values_;
Steve Blocka7e24c12009-10-30 11:49:00 +00001959 int length_;
Teng-Hui Zhu3e5fa292010-11-09 16:16:48 -08001960 bool is_construct_call_;
Steve Blocka7e24c12009-10-30 11:49:00 +00001961};
1962
1963
1964/**
1965 * The information passed to an accessor callback about the context
1966 * of the property access.
1967 */
1968class V8EXPORT AccessorInfo {
1969 public:
1970 inline AccessorInfo(internal::Object** args)
1971 : args_(args) { }
1972 inline Local<Value> Data() const;
1973 inline Local<Object> This() const;
1974 inline Local<Object> Holder() const;
1975 private:
1976 internal::Object** args_;
1977};
1978
1979
1980typedef Handle<Value> (*InvocationCallback)(const Arguments& args);
1981
Steve Blocka7e24c12009-10-30 11:49:00 +00001982/**
Steve Blocka7e24c12009-10-30 11:49:00 +00001983 * NamedProperty[Getter|Setter] are used as interceptors on object.
1984 * See ObjectTemplate::SetNamedPropertyHandler.
1985 */
1986typedef Handle<Value> (*NamedPropertyGetter)(Local<String> property,
1987 const AccessorInfo& info);
1988
1989
1990/**
1991 * Returns the value if the setter intercepts the request.
1992 * Otherwise, returns an empty handle.
1993 */
1994typedef Handle<Value> (*NamedPropertySetter)(Local<String> property,
1995 Local<Value> value,
1996 const AccessorInfo& info);
1997
Steve Blocka7e24c12009-10-30 11:49:00 +00001998/**
1999 * Returns a non-empty handle if the interceptor intercepts the request.
Kristian Monsen9dcf7e22010-06-28 14:14:28 +01002000 * The result is an integer encoding property attributes (like v8::None,
2001 * v8::DontEnum, etc.)
Steve Blocka7e24c12009-10-30 11:49:00 +00002002 */
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01002003typedef Handle<Integer> (*NamedPropertyQuery)(Local<String> property,
2004 const AccessorInfo& info);
Steve Blocka7e24c12009-10-30 11:49:00 +00002005
2006
2007/**
2008 * Returns a non-empty handle if the deleter intercepts the request.
2009 * The return value is true if the property could be deleted and false
2010 * otherwise.
2011 */
2012typedef Handle<Boolean> (*NamedPropertyDeleter)(Local<String> property,
2013 const AccessorInfo& info);
2014
2015/**
2016 * Returns an array containing the names of the properties the named
2017 * property getter intercepts.
2018 */
2019typedef Handle<Array> (*NamedPropertyEnumerator)(const AccessorInfo& info);
2020
2021
2022/**
2023 * Returns the value of the property if the getter intercepts the
2024 * request. Otherwise, returns an empty handle.
2025 */
2026typedef Handle<Value> (*IndexedPropertyGetter)(uint32_t index,
2027 const AccessorInfo& info);
2028
2029
2030/**
2031 * Returns the value if the setter intercepts the request.
2032 * Otherwise, returns an empty handle.
2033 */
2034typedef Handle<Value> (*IndexedPropertySetter)(uint32_t index,
2035 Local<Value> value,
2036 const AccessorInfo& info);
2037
2038
2039/**
2040 * Returns a non-empty handle if the interceptor intercepts the request.
Iain Merrick75681382010-08-19 15:07:18 +01002041 * The result is an integer encoding property attributes.
Steve Blocka7e24c12009-10-30 11:49:00 +00002042 */
Iain Merrick75681382010-08-19 15:07:18 +01002043typedef Handle<Integer> (*IndexedPropertyQuery)(uint32_t index,
Steve Blocka7e24c12009-10-30 11:49:00 +00002044 const AccessorInfo& info);
2045
2046/**
2047 * Returns a non-empty handle if the deleter intercepts the request.
2048 * The return value is true if the property could be deleted and false
2049 * otherwise.
2050 */
2051typedef Handle<Boolean> (*IndexedPropertyDeleter)(uint32_t index,
2052 const AccessorInfo& info);
2053
2054/**
2055 * Returns an array containing the indices of the properties the
2056 * indexed property getter intercepts.
2057 */
2058typedef Handle<Array> (*IndexedPropertyEnumerator)(const AccessorInfo& info);
2059
2060
2061/**
Steve Blocka7e24c12009-10-30 11:49:00 +00002062 * Access type specification.
2063 */
2064enum AccessType {
2065 ACCESS_GET,
2066 ACCESS_SET,
2067 ACCESS_HAS,
2068 ACCESS_DELETE,
2069 ACCESS_KEYS
2070};
2071
2072
2073/**
2074 * Returns true if cross-context access should be allowed to the named
2075 * property with the given key on the host object.
2076 */
2077typedef bool (*NamedSecurityCallback)(Local<Object> host,
2078 Local<Value> key,
2079 AccessType type,
2080 Local<Value> data);
2081
2082
2083/**
2084 * Returns true if cross-context access should be allowed to the indexed
2085 * property with the given index on the host object.
2086 */
2087typedef bool (*IndexedSecurityCallback)(Local<Object> host,
2088 uint32_t index,
2089 AccessType type,
2090 Local<Value> data);
2091
2092
2093/**
2094 * A FunctionTemplate is used to create functions at runtime. There
2095 * can only be one function created from a FunctionTemplate in a
2096 * context. The lifetime of the created function is equal to the
2097 * lifetime of the context. So in case the embedder needs to create
2098 * temporary functions that can be collected using Scripts is
2099 * preferred.
2100 *
2101 * A FunctionTemplate can have properties, these properties are added to the
2102 * function object when it is created.
2103 *
2104 * A FunctionTemplate has a corresponding instance template which is
2105 * used to create object instances when the function is used as a
2106 * constructor. Properties added to the instance template are added to
2107 * each object instance.
2108 *
2109 * A FunctionTemplate can have a prototype template. The prototype template
2110 * is used to create the prototype object of the function.
2111 *
2112 * The following example shows how to use a FunctionTemplate:
2113 *
2114 * \code
2115 * v8::Local<v8::FunctionTemplate> t = v8::FunctionTemplate::New();
2116 * t->Set("func_property", v8::Number::New(1));
2117 *
2118 * v8::Local<v8::Template> proto_t = t->PrototypeTemplate();
2119 * proto_t->Set("proto_method", v8::FunctionTemplate::New(InvokeCallback));
2120 * proto_t->Set("proto_const", v8::Number::New(2));
2121 *
2122 * v8::Local<v8::ObjectTemplate> instance_t = t->InstanceTemplate();
2123 * instance_t->SetAccessor("instance_accessor", InstanceAccessorCallback);
2124 * instance_t->SetNamedPropertyHandler(PropertyHandlerCallback, ...);
2125 * instance_t->Set("instance_property", Number::New(3));
2126 *
2127 * v8::Local<v8::Function> function = t->GetFunction();
2128 * v8::Local<v8::Object> instance = function->NewInstance();
2129 * \endcode
2130 *
2131 * Let's use "function" as the JS variable name of the function object
2132 * and "instance" for the instance object created above. The function
2133 * and the instance will have the following properties:
2134 *
2135 * \code
2136 * func_property in function == true;
2137 * function.func_property == 1;
2138 *
2139 * function.prototype.proto_method() invokes 'InvokeCallback'
2140 * function.prototype.proto_const == 2;
2141 *
2142 * instance instanceof function == true;
2143 * instance.instance_accessor calls 'InstanceAccessorCallback'
2144 * instance.instance_property == 3;
2145 * \endcode
2146 *
2147 * A FunctionTemplate can inherit from another one by calling the
2148 * FunctionTemplate::Inherit method. The following graph illustrates
2149 * the semantics of inheritance:
2150 *
2151 * \code
2152 * FunctionTemplate Parent -> Parent() . prototype -> { }
2153 * ^ ^
2154 * | Inherit(Parent) | .__proto__
2155 * | |
2156 * FunctionTemplate Child -> Child() . prototype -> { }
2157 * \endcode
2158 *
2159 * A FunctionTemplate 'Child' inherits from 'Parent', the prototype
2160 * object of the Child() function has __proto__ pointing to the
2161 * Parent() function's prototype object. An instance of the Child
2162 * function has all properties on Parent's instance templates.
2163 *
2164 * Let Parent be the FunctionTemplate initialized in the previous
2165 * section and create a Child FunctionTemplate by:
2166 *
2167 * \code
2168 * Local<FunctionTemplate> parent = t;
2169 * Local<FunctionTemplate> child = FunctionTemplate::New();
2170 * child->Inherit(parent);
2171 *
2172 * Local<Function> child_function = child->GetFunction();
2173 * Local<Object> child_instance = child_function->NewInstance();
2174 * \endcode
2175 *
2176 * The Child function and Child instance will have the following
2177 * properties:
2178 *
2179 * \code
2180 * child_func.prototype.__proto__ == function.prototype;
2181 * child_instance.instance_accessor calls 'InstanceAccessorCallback'
2182 * child_instance.instance_property == 3;
2183 * \endcode
2184 */
2185class V8EXPORT FunctionTemplate : public Template {
2186 public:
2187 /** Creates a function template.*/
2188 static Local<FunctionTemplate> New(
2189 InvocationCallback callback = 0,
2190 Handle<Value> data = Handle<Value>(),
2191 Handle<Signature> signature = Handle<Signature>());
2192 /** Returns the unique function instance in the current execution context.*/
2193 Local<Function> GetFunction();
2194
2195 /**
2196 * Set the call-handler callback for a FunctionTemplate. This
2197 * callback is called whenever the function created from this
2198 * FunctionTemplate is called.
2199 */
2200 void SetCallHandler(InvocationCallback callback,
2201 Handle<Value> data = Handle<Value>());
2202
2203 /** Get the InstanceTemplate. */
2204 Local<ObjectTemplate> InstanceTemplate();
2205
2206 /** Causes the function template to inherit from a parent function template.*/
2207 void Inherit(Handle<FunctionTemplate> parent);
2208
2209 /**
2210 * A PrototypeTemplate is the template used to create the prototype object
2211 * of the function created by this template.
2212 */
2213 Local<ObjectTemplate> PrototypeTemplate();
2214
2215
2216 /**
2217 * Set the class name of the FunctionTemplate. This is used for
2218 * printing objects created with the function created from the
2219 * FunctionTemplate as its constructor.
2220 */
2221 void SetClassName(Handle<String> name);
2222
2223 /**
2224 * Determines whether the __proto__ accessor ignores instances of
2225 * the function template. If instances of the function template are
2226 * ignored, __proto__ skips all instances and instead returns the
2227 * next object in the prototype chain.
2228 *
2229 * Call with a value of true to make the __proto__ accessor ignore
2230 * instances of the function template. Call with a value of false
2231 * to make the __proto__ accessor not ignore instances of the
2232 * function template. By default, instances of a function template
2233 * are not ignored.
2234 */
2235 void SetHiddenPrototype(bool value);
2236
2237 /**
Ben Murdoch69a99ed2011-11-30 16:03:39 +00002238 * Sets the ReadOnly flag in the attributes of the 'prototype' property
2239 * of functions created from this FunctionTemplate to true.
Ben Murdoch3fb3ca82011-12-02 17:19:32 +00002240 */
Ben Murdoch69a99ed2011-11-30 16:03:39 +00002241 void ReadOnlyPrototype();
Ben Murdoch3fb3ca82011-12-02 17:19:32 +00002242
2243 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00002244 * Returns true if the given object is an instance of this function
2245 * template.
2246 */
2247 bool HasInstance(Handle<Value> object);
2248
2249 private:
2250 FunctionTemplate();
2251 void AddInstancePropertyAccessor(Handle<String> name,
2252 AccessorGetter getter,
2253 AccessorSetter setter,
2254 Handle<Value> data,
2255 AccessControl settings,
2256 PropertyAttribute attributes);
2257 void SetNamedInstancePropertyHandler(NamedPropertyGetter getter,
2258 NamedPropertySetter setter,
2259 NamedPropertyQuery query,
2260 NamedPropertyDeleter remover,
2261 NamedPropertyEnumerator enumerator,
Kristian Monsen9dcf7e22010-06-28 14:14:28 +01002262 Handle<Value> data);
Steve Blocka7e24c12009-10-30 11:49:00 +00002263 void SetIndexedInstancePropertyHandler(IndexedPropertyGetter getter,
2264 IndexedPropertySetter setter,
2265 IndexedPropertyQuery query,
2266 IndexedPropertyDeleter remover,
2267 IndexedPropertyEnumerator enumerator,
2268 Handle<Value> data);
2269 void SetInstanceCallAsFunctionHandler(InvocationCallback callback,
2270 Handle<Value> data);
2271
2272 friend class Context;
2273 friend class ObjectTemplate;
2274};
2275
2276
2277/**
2278 * An ObjectTemplate is used to create objects at runtime.
2279 *
2280 * Properties added to an ObjectTemplate are added to each object
2281 * created from the ObjectTemplate.
2282 */
2283class V8EXPORT ObjectTemplate : public Template {
2284 public:
2285 /** Creates an ObjectTemplate. */
2286 static Local<ObjectTemplate> New();
2287
2288 /** Creates a new instance of this template.*/
2289 Local<Object> NewInstance();
2290
2291 /**
2292 * Sets an accessor on the object template.
2293 *
2294 * Whenever the property with the given name is accessed on objects
2295 * created from this ObjectTemplate the getter and setter callbacks
2296 * are called instead of getting and setting the property directly
2297 * on the JavaScript object.
2298 *
2299 * \param name The name of the property for which an accessor is added.
2300 * \param getter The callback to invoke when getting the property.
2301 * \param setter The callback to invoke when setting the property.
2302 * \param data A piece of data that will be passed to the getter and setter
2303 * callbacks whenever they are invoked.
2304 * \param settings Access control settings for the accessor. This is a bit
2305 * field consisting of one of more of
2306 * DEFAULT = 0, ALL_CAN_READ = 1, or ALL_CAN_WRITE = 2.
2307 * The default is to not allow cross-context access.
2308 * ALL_CAN_READ means that all cross-context reads are allowed.
2309 * ALL_CAN_WRITE means that all cross-context writes are allowed.
2310 * The combination ALL_CAN_READ | ALL_CAN_WRITE can be used to allow all
2311 * cross-context access.
2312 * \param attribute The attributes of the property for which an accessor
2313 * is added.
2314 */
2315 void SetAccessor(Handle<String> name,
2316 AccessorGetter getter,
2317 AccessorSetter setter = 0,
2318 Handle<Value> data = Handle<Value>(),
2319 AccessControl settings = DEFAULT,
2320 PropertyAttribute attribute = None);
2321
2322 /**
2323 * Sets a named property handler on the object template.
2324 *
2325 * Whenever a named property is accessed on objects created from
2326 * this object template, the provided callback is invoked instead of
2327 * accessing the property directly on the JavaScript object.
2328 *
2329 * \param getter The callback to invoke when getting a property.
2330 * \param setter The callback to invoke when setting a property.
Kristian Monsen9dcf7e22010-06-28 14:14:28 +01002331 * \param query The callback to invoke to check if a property is present,
2332 * and if present, get its attributes.
Steve Blocka7e24c12009-10-30 11:49:00 +00002333 * \param deleter The callback to invoke when deleting a property.
2334 * \param enumerator The callback to invoke to enumerate all the named
2335 * properties of an object.
2336 * \param data A piece of data that will be passed to the callbacks
2337 * whenever they are invoked.
2338 */
2339 void SetNamedPropertyHandler(NamedPropertyGetter getter,
2340 NamedPropertySetter setter = 0,
2341 NamedPropertyQuery query = 0,
2342 NamedPropertyDeleter deleter = 0,
2343 NamedPropertyEnumerator enumerator = 0,
Kristian Monsen9dcf7e22010-06-28 14:14:28 +01002344 Handle<Value> data = Handle<Value>());
Steve Blocka7e24c12009-10-30 11:49:00 +00002345
2346 /**
2347 * Sets an indexed property handler on the object template.
2348 *
2349 * Whenever an indexed property is accessed on objects created from
2350 * this object template, the provided callback is invoked instead of
2351 * accessing the property directly on the JavaScript object.
2352 *
2353 * \param getter The callback to invoke when getting a property.
2354 * \param setter The callback to invoke when setting a property.
Ben Murdoch257744e2011-11-30 15:57:28 +00002355 * \param query The callback to invoke to check if an object has a property.
Steve Blocka7e24c12009-10-30 11:49:00 +00002356 * \param deleter The callback to invoke when deleting a property.
2357 * \param enumerator The callback to invoke to enumerate all the indexed
2358 * properties of an object.
2359 * \param data A piece of data that will be passed to the callbacks
2360 * whenever they are invoked.
2361 */
2362 void SetIndexedPropertyHandler(IndexedPropertyGetter getter,
2363 IndexedPropertySetter setter = 0,
2364 IndexedPropertyQuery query = 0,
2365 IndexedPropertyDeleter deleter = 0,
2366 IndexedPropertyEnumerator enumerator = 0,
2367 Handle<Value> data = Handle<Value>());
Iain Merrick75681382010-08-19 15:07:18 +01002368
Steve Blocka7e24c12009-10-30 11:49:00 +00002369 /**
2370 * Sets the callback to be used when calling instances created from
2371 * this template as a function. If no callback is set, instances
2372 * behave like normal JavaScript objects that cannot be called as a
2373 * function.
2374 */
2375 void SetCallAsFunctionHandler(InvocationCallback callback,
2376 Handle<Value> data = Handle<Value>());
2377
2378 /**
2379 * Mark object instances of the template as undetectable.
2380 *
2381 * In many ways, undetectable objects behave as though they are not
2382 * there. They behave like 'undefined' in conditionals and when
2383 * printed. However, properties can be accessed and called as on
2384 * normal objects.
2385 */
2386 void MarkAsUndetectable();
2387
2388 /**
2389 * Sets access check callbacks on the object template.
2390 *
2391 * When accessing properties on instances of this object template,
2392 * the access check callback will be called to determine whether or
2393 * not to allow cross-context access to the properties.
2394 * The last parameter specifies whether access checks are turned
2395 * on by default on instances. If access checks are off by default,
2396 * they can be turned on on individual instances by calling
2397 * Object::TurnOnAccessCheck().
2398 */
2399 void SetAccessCheckCallbacks(NamedSecurityCallback named_handler,
2400 IndexedSecurityCallback indexed_handler,
2401 Handle<Value> data = Handle<Value>(),
2402 bool turned_on_by_default = true);
2403
2404 /**
2405 * Gets the number of internal fields for objects generated from
2406 * this template.
2407 */
2408 int InternalFieldCount();
2409
2410 /**
2411 * Sets the number of internal fields for objects generated from
2412 * this template.
2413 */
2414 void SetInternalFieldCount(int value);
2415
2416 private:
2417 ObjectTemplate();
2418 static Local<ObjectTemplate> New(Handle<FunctionTemplate> constructor);
2419 friend class FunctionTemplate;
2420};
2421
2422
2423/**
2424 * A Signature specifies which receivers and arguments a function can
2425 * legally be called with.
2426 */
2427class V8EXPORT Signature : public Data {
2428 public:
2429 static Local<Signature> New(Handle<FunctionTemplate> receiver =
2430 Handle<FunctionTemplate>(),
2431 int argc = 0,
2432 Handle<FunctionTemplate> argv[] = 0);
2433 private:
2434 Signature();
2435};
2436
2437
2438/**
2439 * A utility for determining the type of objects based on the template
2440 * they were constructed from.
2441 */
2442class V8EXPORT TypeSwitch : public Data {
2443 public:
2444 static Local<TypeSwitch> New(Handle<FunctionTemplate> type);
2445 static Local<TypeSwitch> New(int argc, Handle<FunctionTemplate> types[]);
2446 int match(Handle<Value> value);
2447 private:
2448 TypeSwitch();
2449};
2450
2451
Ben Murdoch257744e2011-11-30 15:57:28 +00002452// --- Extensions ---
Steve Blocka7e24c12009-10-30 11:49:00 +00002453
2454
2455/**
2456 * Ignore
2457 */
2458class V8EXPORT Extension { // NOLINT
2459 public:
2460 Extension(const char* name,
2461 const char* source = 0,
2462 int dep_count = 0,
2463 const char** deps = 0);
2464 virtual ~Extension() { }
2465 virtual v8::Handle<v8::FunctionTemplate>
2466 GetNativeFunction(v8::Handle<v8::String> name) {
2467 return v8::Handle<v8::FunctionTemplate>();
2468 }
2469
2470 const char* name() { return name_; }
2471 const char* source() { return source_; }
2472 int dependency_count() { return dep_count_; }
2473 const char** dependencies() { return deps_; }
2474 void set_auto_enable(bool value) { auto_enable_ = value; }
2475 bool auto_enable() { return auto_enable_; }
2476
2477 private:
2478 const char* name_;
2479 const char* source_;
2480 int dep_count_;
2481 const char** deps_;
2482 bool auto_enable_;
2483
2484 // Disallow copying and assigning.
2485 Extension(const Extension&);
2486 void operator=(const Extension&);
2487};
2488
2489
2490void V8EXPORT RegisterExtension(Extension* extension);
2491
2492
2493/**
2494 * Ignore
2495 */
2496class V8EXPORT DeclareExtension {
2497 public:
2498 inline DeclareExtension(Extension* extension) {
2499 RegisterExtension(extension);
2500 }
2501};
2502
2503
Ben Murdoch257744e2011-11-30 15:57:28 +00002504// --- Statics ---
Steve Blocka7e24c12009-10-30 11:49:00 +00002505
2506
2507Handle<Primitive> V8EXPORT Undefined();
2508Handle<Primitive> V8EXPORT Null();
2509Handle<Boolean> V8EXPORT True();
2510Handle<Boolean> V8EXPORT False();
2511
2512
2513/**
2514 * A set of constraints that specifies the limits of the runtime's memory use.
2515 * You must set the heap size before initializing the VM - the size cannot be
2516 * adjusted after the VM is initialized.
2517 *
2518 * If you are using threads then you should hold the V8::Locker lock while
2519 * setting the stack limit and you must set a non-default stack limit separately
2520 * for each thread.
2521 */
2522class V8EXPORT ResourceConstraints {
2523 public:
2524 ResourceConstraints();
2525 int max_young_space_size() const { return max_young_space_size_; }
2526 void set_max_young_space_size(int value) { max_young_space_size_ = value; }
2527 int max_old_space_size() const { return max_old_space_size_; }
2528 void set_max_old_space_size(int value) { max_old_space_size_ = value; }
Russell Brenner90bac252010-11-18 13:33:46 -08002529 int max_executable_size() { return max_executable_size_; }
2530 void set_max_executable_size(int value) { max_executable_size_ = value; }
Steve Blocka7e24c12009-10-30 11:49:00 +00002531 uint32_t* stack_limit() const { return stack_limit_; }
2532 // Sets an address beyond which the VM's stack may not grow.
2533 void set_stack_limit(uint32_t* value) { stack_limit_ = value; }
2534 private:
2535 int max_young_space_size_;
2536 int max_old_space_size_;
Russell Brenner90bac252010-11-18 13:33:46 -08002537 int max_executable_size_;
Steve Blocka7e24c12009-10-30 11:49:00 +00002538 uint32_t* stack_limit_;
2539};
2540
2541
Kristian Monsen25f61362010-05-21 11:50:48 +01002542bool V8EXPORT SetResourceConstraints(ResourceConstraints* constraints);
Steve Blocka7e24c12009-10-30 11:49:00 +00002543
2544
Ben Murdoch257744e2011-11-30 15:57:28 +00002545// --- Exceptions ---
Steve Blocka7e24c12009-10-30 11:49:00 +00002546
2547
2548typedef void (*FatalErrorCallback)(const char* location, const char* message);
2549
2550
2551typedef void (*MessageCallback)(Handle<Message> message, Handle<Value> data);
2552
2553
2554/**
2555 * Schedules an exception to be thrown when returning to JavaScript. When an
2556 * exception has been scheduled it is illegal to invoke any JavaScript
2557 * operation; the caller must return immediately and only after the exception
2558 * has been handled does it become legal to invoke JavaScript operations.
2559 */
2560Handle<Value> V8EXPORT ThrowException(Handle<Value> exception);
2561
2562/**
2563 * Create new error objects by calling the corresponding error object
2564 * constructor with the message.
2565 */
2566class V8EXPORT Exception {
2567 public:
2568 static Local<Value> RangeError(Handle<String> message);
2569 static Local<Value> ReferenceError(Handle<String> message);
2570 static Local<Value> SyntaxError(Handle<String> message);
2571 static Local<Value> TypeError(Handle<String> message);
2572 static Local<Value> Error(Handle<String> message);
2573};
2574
2575
Ben Murdoch257744e2011-11-30 15:57:28 +00002576// --- Counters Callbacks ---
Steve Blocka7e24c12009-10-30 11:49:00 +00002577
2578typedef int* (*CounterLookupCallback)(const char* name);
2579
2580typedef void* (*CreateHistogramCallback)(const char* name,
2581 int min,
2582 int max,
2583 size_t buckets);
2584
2585typedef void (*AddHistogramSampleCallback)(void* histogram, int sample);
2586
Ben Murdoch257744e2011-11-30 15:57:28 +00002587// --- Memory Allocation Callback ---
Iain Merrick9ac36c92010-09-13 15:29:50 +01002588 enum ObjectSpace {
2589 kObjectSpaceNewSpace = 1 << 0,
2590 kObjectSpaceOldPointerSpace = 1 << 1,
2591 kObjectSpaceOldDataSpace = 1 << 2,
2592 kObjectSpaceCodeSpace = 1 << 3,
2593 kObjectSpaceMapSpace = 1 << 4,
2594 kObjectSpaceLoSpace = 1 << 5,
2595
2596 kObjectSpaceAll = kObjectSpaceNewSpace | kObjectSpaceOldPointerSpace |
2597 kObjectSpaceOldDataSpace | kObjectSpaceCodeSpace | kObjectSpaceMapSpace |
2598 kObjectSpaceLoSpace
2599 };
2600
2601 enum AllocationAction {
2602 kAllocationActionAllocate = 1 << 0,
2603 kAllocationActionFree = 1 << 1,
2604 kAllocationActionAll = kAllocationActionAllocate | kAllocationActionFree
2605 };
2606
2607typedef void (*MemoryAllocationCallback)(ObjectSpace space,
2608 AllocationAction action,
2609 int size);
2610
Ben Murdoch257744e2011-11-30 15:57:28 +00002611// --- Failed Access Check Callback ---
Steve Blocka7e24c12009-10-30 11:49:00 +00002612typedef void (*FailedAccessCheckCallback)(Local<Object> target,
2613 AccessType type,
2614 Local<Value> data);
2615
Ben Murdoch257744e2011-11-30 15:57:28 +00002616// --- AllowCodeGenerationFromStrings callbacks ---
2617
2618/**
2619 * Callback to check if code generation from strings is allowed. See
2620 * Context::AllowCodeGenerationFromStrings.
2621 */
2622typedef bool (*AllowCodeGenerationFromStringsCallback)(Local<Context> context);
2623
2624// --- Garbage Collection Callbacks ---
Steve Blocka7e24c12009-10-30 11:49:00 +00002625
2626/**
Steve Block6ded16b2010-05-10 14:33:55 +01002627 * Applications can register callback functions which will be called
2628 * before and after a garbage collection. Allocations are not
2629 * allowed in the callback functions, you therefore cannot manipulate
Steve Blocka7e24c12009-10-30 11:49:00 +00002630 * objects (set or delete properties for example) since it is possible
2631 * such operations will result in the allocation of objects.
2632 */
Steve Block6ded16b2010-05-10 14:33:55 +01002633enum GCType {
2634 kGCTypeScavenge = 1 << 0,
2635 kGCTypeMarkSweepCompact = 1 << 1,
2636 kGCTypeAll = kGCTypeScavenge | kGCTypeMarkSweepCompact
2637};
2638
2639enum GCCallbackFlags {
2640 kNoGCCallbackFlags = 0,
2641 kGCCallbackFlagCompacted = 1 << 0
2642};
2643
2644typedef void (*GCPrologueCallback)(GCType type, GCCallbackFlags flags);
2645typedef void (*GCEpilogueCallback)(GCType type, GCCallbackFlags flags);
2646
Steve Blocka7e24c12009-10-30 11:49:00 +00002647typedef void (*GCCallback)();
2648
2649
Steve Blocka7e24c12009-10-30 11:49:00 +00002650/**
Steve Block3ce2e202009-11-05 08:53:23 +00002651 * Collection of V8 heap information.
2652 *
2653 * Instances of this class can be passed to v8::V8::HeapStatistics to
2654 * get heap statistics from V8.
2655 */
2656class V8EXPORT HeapStatistics {
2657 public:
2658 HeapStatistics();
2659 size_t total_heap_size() { return total_heap_size_; }
Russell Brenner90bac252010-11-18 13:33:46 -08002660 size_t total_heap_size_executable() { return total_heap_size_executable_; }
Steve Block3ce2e202009-11-05 08:53:23 +00002661 size_t used_heap_size() { return used_heap_size_; }
Ben Murdochb8e0da22011-05-16 14:20:40 +01002662 size_t heap_size_limit() { return heap_size_limit_; }
Steve Block3ce2e202009-11-05 08:53:23 +00002663
2664 private:
2665 void set_total_heap_size(size_t size) { total_heap_size_ = size; }
Russell Brenner90bac252010-11-18 13:33:46 -08002666 void set_total_heap_size_executable(size_t size) {
2667 total_heap_size_executable_ = size;
2668 }
Steve Block3ce2e202009-11-05 08:53:23 +00002669 void set_used_heap_size(size_t size) { used_heap_size_ = size; }
Ben Murdochb8e0da22011-05-16 14:20:40 +01002670 void set_heap_size_limit(size_t size) { heap_size_limit_ = size; }
Steve Block3ce2e202009-11-05 08:53:23 +00002671
2672 size_t total_heap_size_;
Russell Brenner90bac252010-11-18 13:33:46 -08002673 size_t total_heap_size_executable_;
Steve Block3ce2e202009-11-05 08:53:23 +00002674 size_t used_heap_size_;
Ben Murdochb8e0da22011-05-16 14:20:40 +01002675 size_t heap_size_limit_;
Steve Block3ce2e202009-11-05 08:53:23 +00002676
2677 friend class V8;
2678};
2679
2680
Steve Block44f0eee2011-05-26 01:26:41 +01002681class RetainedObjectInfo;
2682
2683/**
2684 * Isolate represents an isolated instance of the V8 engine. V8
2685 * isolates have completely separate states. Objects from one isolate
2686 * must not be used in other isolates. When V8 is initialized a
2687 * default isolate is implicitly created and entered. The embedder
2688 * can create additional isolates and use them in parallel in multiple
2689 * threads. An isolate can be entered by at most one thread at any
2690 * given time. The Locker/Unlocker API can be used to synchronize.
2691 */
2692class V8EXPORT Isolate {
2693 public:
2694 /**
2695 * Stack-allocated class which sets the isolate for all operations
2696 * executed within a local scope.
2697 */
2698 class V8EXPORT Scope {
2699 public:
2700 explicit Scope(Isolate* isolate) : isolate_(isolate) {
2701 isolate->Enter();
2702 }
2703
2704 ~Scope() { isolate_->Exit(); }
2705
2706 private:
2707 Isolate* const isolate_;
2708
2709 // Prevent copying of Scope objects.
2710 Scope(const Scope&);
2711 Scope& operator=(const Scope&);
2712 };
2713
2714 /**
2715 * Creates a new isolate. Does not change the currently entered
2716 * isolate.
2717 *
2718 * When an isolate is no longer used its resources should be freed
2719 * by calling Dispose(). Using the delete operator is not allowed.
2720 */
2721 static Isolate* New();
2722
2723 /**
2724 * Returns the entered isolate for the current thread or NULL in
2725 * case there is no current isolate.
2726 */
2727 static Isolate* GetCurrent();
2728
2729 /**
2730 * Methods below this point require holding a lock (using Locker) in
2731 * a multi-threaded environment.
2732 */
2733
2734 /**
2735 * Sets this isolate as the entered one for the current thread.
2736 * Saves the previously entered one (if any), so that it can be
2737 * restored when exiting. Re-entering an isolate is allowed.
2738 */
2739 void Enter();
2740
2741 /**
2742 * Exits this isolate by restoring the previously entered one in the
2743 * current thread. The isolate may still stay the same, if it was
2744 * entered more than once.
2745 *
2746 * Requires: this == Isolate::GetCurrent().
2747 */
2748 void Exit();
2749
2750 /**
2751 * Disposes the isolate. The isolate must not be entered by any
2752 * thread to be disposable.
2753 */
2754 void Dispose();
2755
Ben Murdoch257744e2011-11-30 15:57:28 +00002756 /**
2757 * Associate embedder-specific data with the isolate
2758 */
2759 void SetData(void* data);
2760
2761 /**
2762 * Retrive embedder-specific data from the isolate.
2763 * Returns NULL if SetData has never been called.
2764 */
2765 void* GetData();
2766
Steve Block44f0eee2011-05-26 01:26:41 +01002767 private:
Steve Block44f0eee2011-05-26 01:26:41 +01002768 Isolate();
2769 Isolate(const Isolate&);
2770 ~Isolate();
2771 Isolate& operator=(const Isolate&);
2772 void* operator new(size_t size);
2773 void operator delete(void*, size_t);
2774};
2775
2776
Ben Murdoch257744e2011-11-30 15:57:28 +00002777class StartupData {
2778 public:
2779 enum CompressionAlgorithm {
2780 kUncompressed,
2781 kBZip2
2782 };
2783
2784 const char* data;
2785 int compressed_size;
2786 int raw_size;
2787};
2788
Ben Murdoch3fb3ca82011-12-02 17:19:32 +00002789
2790/**
2791 * A helper class for driving V8 startup data decompression. It is based on
2792 * "CompressedStartupData" API functions from the V8 class. It isn't mandatory
2793 * for an embedder to use this class, instead, API functions can be used
2794 * directly.
2795 *
2796 * For an example of the class usage, see the "shell.cc" sample application.
2797 */
2798class V8EXPORT StartupDataDecompressor { // NOLINT
2799 public:
2800 StartupDataDecompressor();
2801 virtual ~StartupDataDecompressor();
2802 int Decompress();
2803
2804 protected:
2805 virtual int DecompressData(char* raw_data,
2806 int* raw_data_size,
2807 const char* compressed_data,
2808 int compressed_data_size) = 0;
2809
2810 private:
2811 char** raw_data;
2812};
2813
2814
2815/**
2816 * EntropySource is used as a callback function when v8 needs a source
2817 * of entropy.
2818 */
2819typedef bool (*EntropySource)(unsigned char* buffer, size_t length);
2820
Steve Block3ce2e202009-11-05 08:53:23 +00002821/**
Steve Blocka7e24c12009-10-30 11:49:00 +00002822 * Container class for static utility functions.
2823 */
2824class V8EXPORT V8 {
2825 public:
2826 /** Set the callback to invoke in case of fatal errors. */
2827 static void SetFatalErrorHandler(FatalErrorCallback that);
2828
2829 /**
Ben Murdoch257744e2011-11-30 15:57:28 +00002830 * Set the callback to invoke to check if code generation from
2831 * strings should be allowed.
2832 */
2833 static void SetAllowCodeGenerationFromStringsCallback(
2834 AllowCodeGenerationFromStringsCallback that);
2835
2836 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00002837 * Ignore out-of-memory exceptions.
2838 *
2839 * V8 running out of memory is treated as a fatal error by default.
2840 * This means that the fatal error handler is called and that V8 is
2841 * terminated.
2842 *
Ben Murdoch257744e2011-11-30 15:57:28 +00002843 * IgnoreOutOfMemoryException can be used to not treat an
Steve Blocka7e24c12009-10-30 11:49:00 +00002844 * out-of-memory situation as a fatal error. This way, the contexts
2845 * that did not cause the out of memory problem might be able to
2846 * continue execution.
2847 */
2848 static void IgnoreOutOfMemoryException();
2849
2850 /**
2851 * Check if V8 is dead and therefore unusable. This is the case after
2852 * fatal errors such as out-of-memory situations.
2853 */
2854 static bool IsDead();
2855
2856 /**
Ben Murdoch257744e2011-11-30 15:57:28 +00002857 * The following 4 functions are to be used when V8 is built with
2858 * the 'compress_startup_data' flag enabled. In this case, the
2859 * embedder must decompress startup data prior to initializing V8.
2860 *
2861 * This is how interaction with V8 should look like:
2862 * int compressed_data_count = v8::V8::GetCompressedStartupDataCount();
2863 * v8::StartupData* compressed_data =
2864 * new v8::StartupData[compressed_data_count];
2865 * v8::V8::GetCompressedStartupData(compressed_data);
2866 * ... decompress data (compressed_data can be updated in-place) ...
2867 * v8::V8::SetDecompressedStartupData(compressed_data);
2868 * ... now V8 can be initialized
2869 * ... make sure the decompressed data stays valid until V8 shutdown
Ben Murdoch3fb3ca82011-12-02 17:19:32 +00002870 *
2871 * A helper class StartupDataDecompressor is provided. It implements
2872 * the protocol of the interaction described above, and can be used in
2873 * most cases instead of calling these API functions directly.
Ben Murdoch257744e2011-11-30 15:57:28 +00002874 */
2875 static StartupData::CompressionAlgorithm GetCompressedStartupDataAlgorithm();
2876 static int GetCompressedStartupDataCount();
2877 static void GetCompressedStartupData(StartupData* compressed_data);
2878 static void SetDecompressedStartupData(StartupData* decompressed_data);
2879
2880 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00002881 * Adds a message listener.
2882 *
Ben Murdoch257744e2011-11-30 15:57:28 +00002883 * The same message listener can be added more than once and in that
Steve Blocka7e24c12009-10-30 11:49:00 +00002884 * case it will be called more than once for each message.
2885 */
2886 static bool AddMessageListener(MessageCallback that,
2887 Handle<Value> data = Handle<Value>());
2888
2889 /**
2890 * Remove all message listeners from the specified callback function.
2891 */
2892 static void RemoveMessageListeners(MessageCallback that);
2893
2894 /**
Ben Murdoch3bec4d22010-07-22 14:51:16 +01002895 * Tells V8 to capture current stack trace when uncaught exception occurs
2896 * and report it to the message listeners. The option is off by default.
2897 */
2898 static void SetCaptureStackTraceForUncaughtExceptions(
2899 bool capture,
2900 int frame_limit = 10,
2901 StackTrace::StackTraceOptions options = StackTrace::kOverview);
2902
2903 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00002904 * Sets V8 flags from a string.
2905 */
2906 static void SetFlagsFromString(const char* str, int length);
2907
2908 /**
2909 * Sets V8 flags from the command line.
2910 */
2911 static void SetFlagsFromCommandLine(int* argc,
2912 char** argv,
2913 bool remove_flags);
2914
2915 /** Get the version string. */
2916 static const char* GetVersion();
2917
2918 /**
2919 * Enables the host application to provide a mechanism for recording
2920 * statistics counters.
2921 */
2922 static void SetCounterFunction(CounterLookupCallback);
2923
2924 /**
2925 * Enables the host application to provide a mechanism for recording
2926 * histograms. The CreateHistogram function returns a
2927 * histogram which will later be passed to the AddHistogramSample
2928 * function.
2929 */
2930 static void SetCreateHistogramFunction(CreateHistogramCallback);
2931 static void SetAddHistogramSampleFunction(AddHistogramSampleCallback);
2932
2933 /**
2934 * Enables the computation of a sliding window of states. The sliding
2935 * window information is recorded in statistics counters.
2936 */
2937 static void EnableSlidingStateWindow();
2938
2939 /** Callback function for reporting failed access checks.*/
2940 static void SetFailedAccessCheckCallbackFunction(FailedAccessCheckCallback);
2941
2942 /**
2943 * Enables the host application to receive a notification before a
Steve Block6ded16b2010-05-10 14:33:55 +01002944 * garbage collection. Allocations are not allowed in the
2945 * callback function, you therefore cannot manipulate objects (set
2946 * or delete properties for example) since it is possible such
2947 * operations will result in the allocation of objects. It is possible
2948 * to specify the GCType filter for your callback. But it is not possible to
2949 * register the same callback function two times with different
2950 * GCType filters.
2951 */
2952 static void AddGCPrologueCallback(
2953 GCPrologueCallback callback, GCType gc_type_filter = kGCTypeAll);
2954
2955 /**
2956 * This function removes callback which was installed by
2957 * AddGCPrologueCallback function.
2958 */
2959 static void RemoveGCPrologueCallback(GCPrologueCallback callback);
2960
2961 /**
2962 * The function is deprecated. Please use AddGCPrologueCallback instead.
2963 * Enables the host application to receive a notification before a
2964 * garbage collection. Allocations are not allowed in the
Steve Blocka7e24c12009-10-30 11:49:00 +00002965 * callback function, you therefore cannot manipulate objects (set
2966 * or delete properties for example) since it is possible such
2967 * operations will result in the allocation of objects.
2968 */
2969 static void SetGlobalGCPrologueCallback(GCCallback);
2970
2971 /**
2972 * Enables the host application to receive a notification after a
Steve Block6ded16b2010-05-10 14:33:55 +01002973 * garbage collection. Allocations are not allowed in the
2974 * callback function, you therefore cannot manipulate objects (set
2975 * or delete properties for example) since it is possible such
2976 * operations will result in the allocation of objects. It is possible
2977 * to specify the GCType filter for your callback. But it is not possible to
2978 * register the same callback function two times with different
2979 * GCType filters.
2980 */
2981 static void AddGCEpilogueCallback(
2982 GCEpilogueCallback callback, GCType gc_type_filter = kGCTypeAll);
2983
2984 /**
2985 * This function removes callback which was installed by
2986 * AddGCEpilogueCallback function.
2987 */
2988 static void RemoveGCEpilogueCallback(GCEpilogueCallback callback);
2989
2990 /**
2991 * The function is deprecated. Please use AddGCEpilogueCallback instead.
2992 * Enables the host application to receive a notification after a
Steve Blocka7e24c12009-10-30 11:49:00 +00002993 * major garbage collection. Allocations are not allowed in the
2994 * callback function, you therefore cannot manipulate objects (set
2995 * or delete properties for example) since it is possible such
2996 * operations will result in the allocation of objects.
2997 */
2998 static void SetGlobalGCEpilogueCallback(GCCallback);
2999
3000 /**
Iain Merrick9ac36c92010-09-13 15:29:50 +01003001 * Enables the host application to provide a mechanism to be notified
3002 * and perform custom logging when V8 Allocates Executable Memory.
3003 */
3004 static void AddMemoryAllocationCallback(MemoryAllocationCallback callback,
3005 ObjectSpace space,
3006 AllocationAction action);
3007
3008 /**
3009 * This function removes callback which was installed by
3010 * AddMemoryAllocationCallback function.
3011 */
3012 static void RemoveMemoryAllocationCallback(MemoryAllocationCallback callback);
3013
3014 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00003015 * Allows the host application to group objects together. If one
3016 * object in the group is alive, all objects in the group are alive.
3017 * After each garbage collection, object groups are removed. It is
3018 * intended to be used in the before-garbage-collection callback
3019 * function, for instance to simulate DOM tree connections among JS
3020 * wrapper objects.
Steve Block44f0eee2011-05-26 01:26:41 +01003021 * See v8-profiler.h for RetainedObjectInfo interface description.
Steve Blocka7e24c12009-10-30 11:49:00 +00003022 */
Steve Block44f0eee2011-05-26 01:26:41 +01003023 static void AddObjectGroup(Persistent<Value>* objects,
3024 size_t length,
3025 RetainedObjectInfo* info = NULL);
3026
3027 /**
3028 * Allows the host application to declare implicit references between
3029 * the objects: if |parent| is alive, all |children| are alive too.
3030 * After each garbage collection, all implicit references
3031 * are removed. It is intended to be used in the before-garbage-collection
3032 * callback function.
3033 */
3034 static void AddImplicitReferences(Persistent<Object> parent,
3035 Persistent<Value>* children,
3036 size_t length);
Steve Blocka7e24c12009-10-30 11:49:00 +00003037
3038 /**
3039 * Initializes from snapshot if possible. Otherwise, attempts to
3040 * initialize from scratch. This function is called implicitly if
3041 * you use the API without calling it first.
3042 */
3043 static bool Initialize();
3044
3045 /**
Ben Murdoch3fb3ca82011-12-02 17:19:32 +00003046 * Allows the host application to provide a callback which can be used
3047 * as a source of entropy for random number generators.
3048 */
3049 static void SetEntropySource(EntropySource source);
3050
3051 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00003052 * Adjusts the amount of registered external memory. Used to give
3053 * V8 an indication of the amount of externally allocated memory
3054 * that is kept alive by JavaScript objects. V8 uses this to decide
3055 * when to perform global garbage collections. Registering
3056 * externally allocated memory will trigger global garbage
3057 * collections more often than otherwise in an attempt to garbage
3058 * collect the JavaScript objects keeping the externally allocated
3059 * memory alive.
3060 *
3061 * \param change_in_bytes the change in externally allocated memory
3062 * that is kept alive by JavaScript objects.
3063 * \returns the adjusted value.
3064 */
3065 static int AdjustAmountOfExternalAllocatedMemory(int change_in_bytes);
3066
3067 /**
3068 * Suspends recording of tick samples in the profiler.
3069 * When the V8 profiling mode is enabled (usually via command line
3070 * switches) this function suspends recording of tick samples.
3071 * Profiling ticks are discarded until ResumeProfiler() is called.
3072 *
3073 * See also the --prof and --prof_auto command line switches to
3074 * enable V8 profiling.
3075 */
3076 static void PauseProfiler();
3077
3078 /**
3079 * Resumes recording of tick samples in the profiler.
3080 * See also PauseProfiler().
3081 */
3082 static void ResumeProfiler();
3083
3084 /**
3085 * Return whether profiler is currently paused.
3086 */
3087 static bool IsProfilerPaused();
3088
3089 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00003090 * Retrieve the V8 thread id of the calling thread.
3091 *
3092 * The thread id for a thread should only be retrieved after the V8
3093 * lock has been acquired with a Locker object with that thread.
3094 */
3095 static int GetCurrentThreadId();
3096
3097 /**
3098 * Forcefully terminate execution of a JavaScript thread. This can
3099 * be used to terminate long-running scripts.
3100 *
3101 * TerminateExecution should only be called when then V8 lock has
3102 * been acquired with a Locker object. Therefore, in order to be
3103 * able to terminate long-running threads, preemption must be
3104 * enabled to allow the user of TerminateExecution to acquire the
3105 * lock.
3106 *
3107 * The termination is achieved by throwing an exception that is
3108 * uncatchable by JavaScript exception handlers. Termination
3109 * exceptions act as if they were caught by a C++ TryCatch exception
Ben Murdoch257744e2011-11-30 15:57:28 +00003110 * handler. If forceful termination is used, any C++ TryCatch
Steve Blocka7e24c12009-10-30 11:49:00 +00003111 * exception handler that catches an exception should check if that
3112 * exception is a termination exception and immediately return if
3113 * that is the case. Returning immediately in that case will
3114 * continue the propagation of the termination exception if needed.
3115 *
3116 * The thread id passed to TerminateExecution must have been
3117 * obtained by calling GetCurrentThreadId on the thread in question.
3118 *
3119 * \param thread_id The thread id of the thread to terminate.
3120 */
3121 static void TerminateExecution(int thread_id);
3122
3123 /**
Steve Block44f0eee2011-05-26 01:26:41 +01003124 * Forcefully terminate the current thread of JavaScript execution
3125 * in the given isolate. If no isolate is provided, the default
3126 * isolate is used.
Steve Blocka7e24c12009-10-30 11:49:00 +00003127 *
3128 * This method can be used by any thread even if that thread has not
3129 * acquired the V8 lock with a Locker object.
Steve Block44f0eee2011-05-26 01:26:41 +01003130 *
3131 * \param isolate The isolate in which to terminate the current JS execution.
Steve Blocka7e24c12009-10-30 11:49:00 +00003132 */
Steve Block44f0eee2011-05-26 01:26:41 +01003133 static void TerminateExecution(Isolate* isolate = NULL);
Steve Blocka7e24c12009-10-30 11:49:00 +00003134
3135 /**
Steve Block6ded16b2010-05-10 14:33:55 +01003136 * Is V8 terminating JavaScript execution.
3137 *
3138 * Returns true if JavaScript execution is currently terminating
3139 * because of a call to TerminateExecution. In that case there are
3140 * still JavaScript frames on the stack and the termination
3141 * exception is still active.
Ben Murdoch3fb3ca82011-12-02 17:19:32 +00003142 *
3143 * \param isolate The isolate in which to check.
Steve Block6ded16b2010-05-10 14:33:55 +01003144 */
Ben Murdoch3fb3ca82011-12-02 17:19:32 +00003145 static bool IsExecutionTerminating(Isolate* isolate = NULL);
Steve Block6ded16b2010-05-10 14:33:55 +01003146
3147 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00003148 * Releases any resources used by v8 and stops any utility threads
3149 * that may be running. Note that disposing v8 is permanent, it
3150 * cannot be reinitialized.
3151 *
3152 * It should generally not be necessary to dispose v8 before exiting
3153 * a process, this should happen automatically. It is only necessary
3154 * to use if the process needs the resources taken up by v8.
3155 */
3156 static bool Dispose();
3157
Steve Block3ce2e202009-11-05 08:53:23 +00003158 /**
3159 * Get statistics about the heap memory usage.
3160 */
3161 static void GetHeapStatistics(HeapStatistics* heap_statistics);
Steve Blocka7e24c12009-10-30 11:49:00 +00003162
3163 /**
3164 * Optional notification that the embedder is idle.
3165 * V8 uses the notification to reduce memory footprint.
3166 * This call can be used repeatedly if the embedder remains idle.
Steve Blocka7e24c12009-10-30 11:49:00 +00003167 * Returns true if the embedder should stop calling IdleNotification
3168 * until real work has been done. This indicates that V8 has done
3169 * as much cleanup as it will be able to do.
3170 */
Steve Block3ce2e202009-11-05 08:53:23 +00003171 static bool IdleNotification();
Steve Blocka7e24c12009-10-30 11:49:00 +00003172
3173 /**
3174 * Optional notification that the system is running low on memory.
3175 * V8 uses these notifications to attempt to free memory.
3176 */
3177 static void LowMemoryNotification();
3178
Steve Block6ded16b2010-05-10 14:33:55 +01003179 /**
3180 * Optional notification that a context has been disposed. V8 uses
3181 * these notifications to guide the GC heuristic. Returns the number
3182 * of context disposals - including this one - since the last time
3183 * V8 had a chance to clean up.
3184 */
3185 static int ContextDisposedNotification();
3186
Steve Blocka7e24c12009-10-30 11:49:00 +00003187 private:
3188 V8();
3189
3190 static internal::Object** GlobalizeReference(internal::Object** handle);
3191 static void DisposeGlobal(internal::Object** global_handle);
3192 static void MakeWeak(internal::Object** global_handle,
3193 void* data,
3194 WeakReferenceCallback);
3195 static void ClearWeak(internal::Object** global_handle);
Ben Murdoch257744e2011-11-30 15:57:28 +00003196 static void MarkIndependent(internal::Object** global_handle);
Steve Blocka7e24c12009-10-30 11:49:00 +00003197 static bool IsGlobalNearDeath(internal::Object** global_handle);
3198 static bool IsGlobalWeak(internal::Object** global_handle);
Steve Block44f0eee2011-05-26 01:26:41 +01003199 static void SetWrapperClassId(internal::Object** global_handle,
3200 uint16_t class_id);
Steve Blocka7e24c12009-10-30 11:49:00 +00003201
3202 template <class T> friend class Handle;
3203 template <class T> friend class Local;
3204 template <class T> friend class Persistent;
3205 friend class Context;
3206};
3207
3208
3209/**
3210 * An external exception handler.
3211 */
3212class V8EXPORT TryCatch {
3213 public:
Steve Blocka7e24c12009-10-30 11:49:00 +00003214 /**
3215 * Creates a new try/catch block and registers it with v8.
3216 */
3217 TryCatch();
3218
3219 /**
3220 * Unregisters and deletes this try/catch block.
3221 */
3222 ~TryCatch();
3223
3224 /**
3225 * Returns true if an exception has been caught by this try/catch block.
3226 */
3227 bool HasCaught() const;
3228
3229 /**
3230 * For certain types of exceptions, it makes no sense to continue
3231 * execution.
3232 *
3233 * Currently, the only type of exception that can be caught by a
3234 * TryCatch handler and for which it does not make sense to continue
3235 * is termination exception. Such exceptions are thrown when the
3236 * TerminateExecution methods are called to terminate a long-running
3237 * script.
3238 *
3239 * If CanContinue returns false, the correct action is to perform
3240 * any C++ cleanup needed and then return.
3241 */
3242 bool CanContinue() const;
3243
3244 /**
Steve Blockd0582a62009-12-15 09:54:21 +00003245 * Throws the exception caught by this TryCatch in a way that avoids
3246 * it being caught again by this same TryCatch. As with ThrowException
3247 * it is illegal to execute any JavaScript operations after calling
3248 * ReThrow; the caller must return immediately to where the exception
3249 * is caught.
3250 */
3251 Handle<Value> ReThrow();
3252
3253 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00003254 * Returns the exception caught by this try/catch block. If no exception has
3255 * been caught an empty handle is returned.
3256 *
3257 * The returned handle is valid until this TryCatch block has been destroyed.
3258 */
3259 Local<Value> Exception() const;
3260
3261 /**
3262 * Returns the .stack property of the thrown object. If no .stack
3263 * property is present an empty handle is returned.
3264 */
3265 Local<Value> StackTrace() const;
3266
3267 /**
3268 * Returns the message associated with this exception. If there is
3269 * no message associated an empty handle is returned.
3270 *
3271 * The returned handle is valid until this TryCatch block has been
3272 * destroyed.
3273 */
3274 Local<v8::Message> Message() const;
3275
3276 /**
3277 * Clears any exceptions that may have been caught by this try/catch block.
3278 * After this method has been called, HasCaught() will return false.
3279 *
3280 * It is not necessary to clear a try/catch block before using it again; if
3281 * another exception is thrown the previously caught exception will just be
3282 * overwritten. However, it is often a good idea since it makes it easier
3283 * to determine which operation threw a given exception.
3284 */
3285 void Reset();
3286
3287 /**
3288 * Set verbosity of the external exception handler.
3289 *
3290 * By default, exceptions that are caught by an external exception
3291 * handler are not reported. Call SetVerbose with true on an
3292 * external exception handler to have exceptions caught by the
3293 * handler reported as if they were not caught.
3294 */
3295 void SetVerbose(bool value);
3296
3297 /**
3298 * Set whether or not this TryCatch should capture a Message object
3299 * which holds source information about where the exception
3300 * occurred. True by default.
3301 */
3302 void SetCaptureMessage(bool value);
3303
Steve Blockd0582a62009-12-15 09:54:21 +00003304 private:
Ben Murdoch3fb3ca82011-12-02 17:19:32 +00003305 v8::internal::Isolate* isolate_;
Steve Blockd0582a62009-12-15 09:54:21 +00003306 void* next_;
Steve Blocka7e24c12009-10-30 11:49:00 +00003307 void* exception_;
3308 void* message_;
Steve Blockd0582a62009-12-15 09:54:21 +00003309 bool is_verbose_ : 1;
3310 bool can_continue_ : 1;
3311 bool capture_message_ : 1;
3312 bool rethrow_ : 1;
3313
Steve Block44f0eee2011-05-26 01:26:41 +01003314 friend class v8::internal::Isolate;
Steve Blocka7e24c12009-10-30 11:49:00 +00003315};
3316
3317
Ben Murdoch257744e2011-11-30 15:57:28 +00003318// --- Context ---
Steve Blocka7e24c12009-10-30 11:49:00 +00003319
3320
3321/**
3322 * Ignore
3323 */
3324class V8EXPORT ExtensionConfiguration {
3325 public:
3326 ExtensionConfiguration(int name_count, const char* names[])
3327 : name_count_(name_count), names_(names) { }
3328 private:
3329 friend class ImplementationUtilities;
3330 int name_count_;
3331 const char** names_;
3332};
3333
3334
3335/**
3336 * A sandboxed execution context with its own set of built-in objects
3337 * and functions.
3338 */
3339class V8EXPORT Context {
3340 public:
Steve Block1e0659c2011-05-24 12:43:12 +01003341 /**
3342 * Returns the global proxy object or global object itself for
3343 * detached contexts.
3344 *
3345 * Global proxy object is a thin wrapper whose prototype points to
3346 * actual context's global object with the properties like Object, etc.
3347 * This is done that way for security reasons (for more details see
3348 * https://wiki.mozilla.org/Gecko:SplitWindow).
3349 *
3350 * Please note that changes to global proxy object prototype most probably
3351 * would break VM---v8 expects only global object as a prototype of
3352 * global proxy object.
3353 *
3354 * If DetachGlobal() has been invoked, Global() would return actual global
3355 * object until global is reattached with ReattachGlobal().
3356 */
Steve Blocka7e24c12009-10-30 11:49:00 +00003357 Local<Object> Global();
3358
3359 /**
3360 * Detaches the global object from its context before
3361 * the global object can be reused to create a new context.
3362 */
3363 void DetachGlobal();
3364
Andrei Popescu74b3c142010-03-29 12:03:09 +01003365 /**
3366 * Reattaches a global object to a context. This can be used to
3367 * restore the connection between a global object and a context
3368 * after DetachGlobal has been called.
3369 *
3370 * \param global_object The global object to reattach to the
3371 * context. For this to work, the global object must be the global
3372 * object that was associated with this context before a call to
3373 * DetachGlobal.
3374 */
3375 void ReattachGlobal(Handle<Object> global_object);
3376
Leon Clarkef7060e22010-06-03 12:02:55 +01003377 /** Creates a new context.
3378 *
3379 * Returns a persistent handle to the newly allocated context. This
3380 * persistent handle has to be disposed when the context is no
3381 * longer used so the context can be garbage collected.
Steve Block9fac8402011-05-12 15:51:54 +01003382 *
3383 * \param extensions An optional extension configuration containing
3384 * the extensions to be installed in the newly created context.
3385 *
3386 * \param global_template An optional object template from which the
3387 * global object for the newly created context will be created.
3388 *
3389 * \param global_object An optional global object to be reused for
3390 * the newly created context. This global object must have been
3391 * created by a previous call to Context::New with the same global
3392 * template. The state of the global object will be completely reset
3393 * and only object identify will remain.
Leon Clarkef7060e22010-06-03 12:02:55 +01003394 */
Steve Blocka7e24c12009-10-30 11:49:00 +00003395 static Persistent<Context> New(
Andrei Popescu31002712010-02-23 13:46:05 +00003396 ExtensionConfiguration* extensions = NULL,
Steve Blocka7e24c12009-10-30 11:49:00 +00003397 Handle<ObjectTemplate> global_template = Handle<ObjectTemplate>(),
3398 Handle<Value> global_object = Handle<Value>());
3399
3400 /** Returns the last entered context. */
3401 static Local<Context> GetEntered();
3402
3403 /** Returns the context that is on the top of the stack. */
3404 static Local<Context> GetCurrent();
3405
3406 /**
3407 * Returns the context of the calling JavaScript code. That is the
3408 * context of the top-most JavaScript frame. If there are no
3409 * JavaScript frames an empty handle is returned.
3410 */
3411 static Local<Context> GetCalling();
3412
3413 /**
3414 * Sets the security token for the context. To access an object in
3415 * another context, the security tokens must match.
3416 */
3417 void SetSecurityToken(Handle<Value> token);
3418
3419 /** Restores the security token to the default value. */
3420 void UseDefaultSecurityToken();
3421
3422 /** Returns the security token of this context.*/
3423 Handle<Value> GetSecurityToken();
3424
3425 /**
3426 * Enter this context. After entering a context, all code compiled
3427 * and run is compiled and run in this context. If another context
3428 * is already entered, this old context is saved so it can be
3429 * restored when the new context is exited.
3430 */
3431 void Enter();
3432
3433 /**
3434 * Exit this context. Exiting the current context restores the
3435 * context that was in place when entering the current context.
3436 */
3437 void Exit();
3438
3439 /** Returns true if the context has experienced an out of memory situation. */
3440 bool HasOutOfMemoryException();
3441
3442 /** Returns true if V8 has a current context. */
3443 static bool InContext();
3444
3445 /**
3446 * Associate an additional data object with the context. This is mainly used
3447 * with the debugger to provide additional information on the context through
3448 * the debugger API.
3449 */
Steve Blockd0582a62009-12-15 09:54:21 +00003450 void SetData(Handle<String> data);
Steve Blocka7e24c12009-10-30 11:49:00 +00003451 Local<Value> GetData();
3452
3453 /**
Ben Murdoch257744e2011-11-30 15:57:28 +00003454 * Control whether code generation from strings is allowed. Calling
3455 * this method with false will disable 'eval' and the 'Function'
3456 * constructor for code running in this context. If 'eval' or the
3457 * 'Function' constructor are used an exception will be thrown.
3458 *
3459 * If code generation from strings is not allowed the
3460 * V8::AllowCodeGenerationFromStrings callback will be invoked if
3461 * set before blocking the call to 'eval' or the 'Function'
3462 * constructor. If that callback returns true, the call will be
3463 * allowed, otherwise an exception will be thrown. If no callback is
3464 * set an exception will be thrown.
3465 */
3466 void AllowCodeGenerationFromStrings(bool allow);
3467
3468 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00003469 * Stack-allocated class which sets the execution context for all
3470 * operations executed within a local scope.
3471 */
Steve Block8defd9f2010-07-08 12:39:36 +01003472 class Scope {
Steve Blocka7e24c12009-10-30 11:49:00 +00003473 public:
Ben Murdoch8b112d22011-06-08 16:22:53 +01003474 explicit inline Scope(Handle<Context> context) : context_(context) {
Steve Blocka7e24c12009-10-30 11:49:00 +00003475 context_->Enter();
3476 }
3477 inline ~Scope() { context_->Exit(); }
3478 private:
3479 Handle<Context> context_;
3480 };
3481
3482 private:
3483 friend class Value;
3484 friend class Script;
3485 friend class Object;
3486 friend class Function;
3487};
3488
3489
3490/**
3491 * Multiple threads in V8 are allowed, but only one thread at a time
Steve Block44f0eee2011-05-26 01:26:41 +01003492 * is allowed to use any given V8 isolate. See Isolate class
3493 * comments. The definition of 'using V8 isolate' includes
3494 * accessing handles or holding onto object pointers obtained
3495 * from V8 handles while in the particular V8 isolate. It is up
3496 * to the user of V8 to ensure (perhaps with locking) that this
3497 * constraint is not violated.
Steve Blocka7e24c12009-10-30 11:49:00 +00003498 *
Ben Murdoch257744e2011-11-30 15:57:28 +00003499 * v8::Locker is a scoped lock object. While it's
3500 * active (i.e. between its construction and destruction) the current thread is
3501 * allowed to use the locked isolate. V8 guarantees that an isolate can be locked
3502 * by at most one thread at any time. In other words, the scope of a v8::Locker is
3503 * a critical section.
Steve Block44f0eee2011-05-26 01:26:41 +01003504 *
Ben Murdoch257744e2011-11-30 15:57:28 +00003505 * Sample usage:
3506* \code
Steve Blocka7e24c12009-10-30 11:49:00 +00003507 * ...
3508 * {
Ben Murdoch257744e2011-11-30 15:57:28 +00003509 * v8::Locker locker(isolate);
3510 * v8::Isolate::Scope isolate_scope(isolate);
Steve Blocka7e24c12009-10-30 11:49:00 +00003511 * ...
Ben Murdoch257744e2011-11-30 15:57:28 +00003512 * // Code using V8 and isolate goes here.
Steve Blocka7e24c12009-10-30 11:49:00 +00003513 * ...
3514 * } // Destructor called here
3515 * \endcode
3516 *
Ben Murdoch257744e2011-11-30 15:57:28 +00003517 * If you wish to stop using V8 in a thread A you can do this either
Steve Blocka7e24c12009-10-30 11:49:00 +00003518 * by destroying the v8::Locker object as above or by constructing a
3519 * v8::Unlocker object:
3520 *
3521 * \code
3522 * {
Ben Murdoch257744e2011-11-30 15:57:28 +00003523 * isolate->Exit();
3524 * v8::Unlocker unlocker(isolate);
Steve Blocka7e24c12009-10-30 11:49:00 +00003525 * ...
3526 * // Code not using V8 goes here while V8 can run in another thread.
3527 * ...
3528 * } // Destructor called here.
Ben Murdoch257744e2011-11-30 15:57:28 +00003529 * isolate->Enter();
Steve Blocka7e24c12009-10-30 11:49:00 +00003530 * \endcode
3531 *
3532 * The Unlocker object is intended for use in a long-running callback
3533 * from V8, where you want to release the V8 lock for other threads to
3534 * use.
3535 *
3536 * The v8::Locker is a recursive lock. That is, you can lock more than
3537 * once in a given thread. This can be useful if you have code that can
3538 * be called either from code that holds the lock or from code that does
3539 * not. The Unlocker is not recursive so you can not have several
3540 * Unlockers on the stack at once, and you can not use an Unlocker in a
3541 * thread that is not inside a Locker's scope.
3542 *
3543 * An unlocker will unlock several lockers if it has to and reinstate
3544 * the correct depth of locking on its destruction. eg.:
3545 *
3546 * \code
3547 * // V8 not locked.
3548 * {
Ben Murdoch257744e2011-11-30 15:57:28 +00003549 * v8::Locker locker(isolate);
3550 * Isolate::Scope isolate_scope(isolate);
Steve Blocka7e24c12009-10-30 11:49:00 +00003551 * // V8 locked.
3552 * {
Ben Murdoch257744e2011-11-30 15:57:28 +00003553 * v8::Locker another_locker(isolate);
Steve Blocka7e24c12009-10-30 11:49:00 +00003554 * // V8 still locked (2 levels).
3555 * {
Ben Murdoch257744e2011-11-30 15:57:28 +00003556 * isolate->Exit();
3557 * v8::Unlocker unlocker(isolate);
Steve Blocka7e24c12009-10-30 11:49:00 +00003558 * // V8 not locked.
3559 * }
Ben Murdoch257744e2011-11-30 15:57:28 +00003560 * isolate->Enter();
Steve Blocka7e24c12009-10-30 11:49:00 +00003561 * // V8 locked again (2 levels).
3562 * }
3563 * // V8 still locked (1 level).
3564 * }
3565 * // V8 Now no longer locked.
3566 * \endcode
Ben Murdoch257744e2011-11-30 15:57:28 +00003567 *
Ben Murdoch589d6972011-11-30 16:04:58 +00003568 *
Steve Blocka7e24c12009-10-30 11:49:00 +00003569 */
3570class V8EXPORT Unlocker {
3571 public:
Ben Murdoch257744e2011-11-30 15:57:28 +00003572 /**
3573 * Initialize Unlocker for a given Isolate. NULL means default isolate.
3574 */
3575 explicit Unlocker(Isolate* isolate = NULL);
Steve Blocka7e24c12009-10-30 11:49:00 +00003576 ~Unlocker();
Ben Murdoch257744e2011-11-30 15:57:28 +00003577 private:
3578 internal::Isolate* isolate_;
Steve Blocka7e24c12009-10-30 11:49:00 +00003579};
3580
3581
3582class V8EXPORT Locker {
3583 public:
Ben Murdoch257744e2011-11-30 15:57:28 +00003584 /**
3585 * Initialize Locker for a given Isolate. NULL means default isolate.
3586 */
3587 explicit Locker(Isolate* isolate = NULL);
Steve Blocka7e24c12009-10-30 11:49:00 +00003588 ~Locker();
3589
3590 /**
3591 * Start preemption.
3592 *
Ben Murdoch257744e2011-11-30 15:57:28 +00003593 * When preemption is started, a timer is fired every n milliseconds
Steve Blocka7e24c12009-10-30 11:49:00 +00003594 * that will switch between multiple threads that are in contention
3595 * for the V8 lock.
3596 */
3597 static void StartPreemption(int every_n_ms);
3598
3599 /**
3600 * Stop preemption.
3601 */
3602 static void StopPreemption();
3603
3604 /**
Ben Murdoch257744e2011-11-30 15:57:28 +00003605 * Returns whether or not the locker for a given isolate, or default isolate if NULL is given,
3606 * is locked by the current thread.
Steve Blocka7e24c12009-10-30 11:49:00 +00003607 */
Ben Murdoch257744e2011-11-30 15:57:28 +00003608 static bool IsLocked(Isolate* isolate = NULL);
Steve Blocka7e24c12009-10-30 11:49:00 +00003609
3610 /**
3611 * Returns whether v8::Locker is being used by this V8 instance.
3612 */
Ben Murdoch69a99ed2011-11-30 16:03:39 +00003613 static bool IsActive();
Steve Blocka7e24c12009-10-30 11:49:00 +00003614
3615 private:
3616 bool has_lock_;
3617 bool top_level_;
Ben Murdoch257744e2011-11-30 15:57:28 +00003618 internal::Isolate* isolate_;
Steve Blocka7e24c12009-10-30 11:49:00 +00003619
3620 static bool active_;
3621
3622 // Disallow copying and assigning.
3623 Locker(const Locker&);
3624 void operator=(const Locker&);
3625};
3626
3627
Kristian Monsen0d5e1162010-09-30 15:31:59 +01003628/**
3629 * An interface for exporting data from V8, using "push" model.
3630 */
Teng-Hui Zhu3e5fa292010-11-09 16:16:48 -08003631class V8EXPORT OutputStream { // NOLINT
3632 public:
Kristian Monsen0d5e1162010-09-30 15:31:59 +01003633 enum OutputEncoding {
3634 kAscii = 0 // 7-bit ASCII.
3635 };
3636 enum WriteResult {
3637 kContinue = 0,
3638 kAbort = 1
3639 };
3640 virtual ~OutputStream() {}
3641 /** Notify about the end of stream. */
3642 virtual void EndOfStream() = 0;
3643 /** Get preferred output chunk size. Called only once. */
3644 virtual int GetChunkSize() { return 1024; }
3645 /** Get preferred output encoding. Called only once. */
3646 virtual OutputEncoding GetOutputEncoding() { return kAscii; }
3647 /**
3648 * Writes the next chunk of snapshot data into the stream. Writing
3649 * can be stopped by returning kAbort as function result. EndOfStream
3650 * will not be called in case writing was aborted.
3651 */
3652 virtual WriteResult WriteAsciiChunk(char* data, int size) = 0;
3653};
3654
3655
Ben Murdochb0fe1622011-05-05 13:52:32 +01003656/**
3657 * An interface for reporting progress and controlling long-running
3658 * activities.
3659 */
3660class V8EXPORT ActivityControl { // NOLINT
3661 public:
3662 enum ControlOption {
3663 kContinue = 0,
3664 kAbort = 1
3665 };
3666 virtual ~ActivityControl() {}
3667 /**
3668 * Notify about current progress. The activity can be stopped by
3669 * returning kAbort as the callback result.
3670 */
3671 virtual ControlOption ReportProgressValue(int done, int total) = 0;
3672};
3673
Steve Blocka7e24c12009-10-30 11:49:00 +00003674
Ben Murdoch257744e2011-11-30 15:57:28 +00003675// --- Implementation ---
Steve Blocka7e24c12009-10-30 11:49:00 +00003676
3677
3678namespace internal {
3679
Shimeng (Simon) Wang8a31eba2010-12-06 19:01:33 -08003680static const int kApiPointerSize = sizeof(void*); // NOLINT
3681static const int kApiIntSize = sizeof(int); // NOLINT
Steve Blocka7e24c12009-10-30 11:49:00 +00003682
3683// Tag information for HeapObject.
3684const int kHeapObjectTag = 1;
3685const int kHeapObjectTagSize = 2;
3686const intptr_t kHeapObjectTagMask = (1 << kHeapObjectTagSize) - 1;
3687
Steve Blocka7e24c12009-10-30 11:49:00 +00003688// Tag information for Smi.
3689const int kSmiTag = 0;
3690const int kSmiTagSize = 1;
3691const intptr_t kSmiTagMask = (1 << kSmiTagSize) - 1;
3692
Ben Murdochb8e0da22011-05-16 14:20:40 +01003693template <size_t ptr_size> struct SmiTagging;
Steve Block3ce2e202009-11-05 08:53:23 +00003694
3695// Smi constants for 32-bit systems.
Ben Murdochb8e0da22011-05-16 14:20:40 +01003696template <> struct SmiTagging<4> {
Steve Block3ce2e202009-11-05 08:53:23 +00003697 static const int kSmiShiftSize = 0;
3698 static const int kSmiValueSize = 31;
3699 static inline int SmiToInt(internal::Object* value) {
3700 int shift_bits = kSmiTagSize + kSmiShiftSize;
3701 // Throw away top 32 bits and shift down (requires >> to be sign extending).
3702 return static_cast<int>(reinterpret_cast<intptr_t>(value)) >> shift_bits;
3703 }
Ben Murdochb8e0da22011-05-16 14:20:40 +01003704
3705 // For 32-bit systems any 2 bytes aligned pointer can be encoded as smi
3706 // with a plain reinterpret_cast.
Steve Block1e0659c2011-05-24 12:43:12 +01003707 static const uintptr_t kEncodablePointerMask = 0x1;
Ben Murdochb8e0da22011-05-16 14:20:40 +01003708 static const int kPointerToSmiShift = 0;
Steve Block3ce2e202009-11-05 08:53:23 +00003709};
3710
3711// Smi constants for 64-bit systems.
Ben Murdochb8e0da22011-05-16 14:20:40 +01003712template <> struct SmiTagging<8> {
Steve Block3ce2e202009-11-05 08:53:23 +00003713 static const int kSmiShiftSize = 31;
3714 static const int kSmiValueSize = 32;
3715 static inline int SmiToInt(internal::Object* value) {
3716 int shift_bits = kSmiTagSize + kSmiShiftSize;
3717 // Shift down and throw away top 32 bits.
3718 return static_cast<int>(reinterpret_cast<intptr_t>(value) >> shift_bits);
3719 }
Ben Murdochb8e0da22011-05-16 14:20:40 +01003720
3721 // To maximize the range of pointers that can be encoded
3722 // in the available 32 bits, we require them to be 8 bytes aligned.
3723 // This gives 2 ^ (32 + 3) = 32G address space covered.
3724 // It might be not enough to cover stack allocated objects on some platforms.
3725 static const int kPointerAlignment = 3;
3726
Steve Block1e0659c2011-05-24 12:43:12 +01003727 static const uintptr_t kEncodablePointerMask =
3728 ~(uintptr_t(0xffffffff) << kPointerAlignment);
Ben Murdochb8e0da22011-05-16 14:20:40 +01003729
3730 static const int kPointerToSmiShift =
3731 kSmiTagSize + kSmiShiftSize - kPointerAlignment;
Steve Block3ce2e202009-11-05 08:53:23 +00003732};
3733
Ben Murdochb8e0da22011-05-16 14:20:40 +01003734typedef SmiTagging<kApiPointerSize> PlatformSmiTagging;
3735const int kSmiShiftSize = PlatformSmiTagging::kSmiShiftSize;
3736const int kSmiValueSize = PlatformSmiTagging::kSmiValueSize;
Steve Block1e0659c2011-05-24 12:43:12 +01003737const uintptr_t kEncodablePointerMask =
Ben Murdochb8e0da22011-05-16 14:20:40 +01003738 PlatformSmiTagging::kEncodablePointerMask;
3739const int kPointerToSmiShift = PlatformSmiTagging::kPointerToSmiShift;
Steve Blocka7e24c12009-10-30 11:49:00 +00003740
Steve Blockd0582a62009-12-15 09:54:21 +00003741template <size_t ptr_size> struct InternalConstants;
3742
3743// Internal constants for 32-bit systems.
3744template <> struct InternalConstants<4> {
Shimeng (Simon) Wang8a31eba2010-12-06 19:01:33 -08003745 static const int kStringResourceOffset = 3 * kApiPointerSize;
Steve Blockd0582a62009-12-15 09:54:21 +00003746};
3747
3748// Internal constants for 64-bit systems.
3749template <> struct InternalConstants<8> {
Shimeng (Simon) Wang8a31eba2010-12-06 19:01:33 -08003750 static const int kStringResourceOffset = 3 * kApiPointerSize;
Steve Blockd0582a62009-12-15 09:54:21 +00003751};
3752
Steve Blocka7e24c12009-10-30 11:49:00 +00003753/**
3754 * This class exports constants and functionality from within v8 that
3755 * is necessary to implement inline functions in the v8 api. Don't
3756 * depend on functions and constants defined here.
3757 */
3758class Internals {
3759 public:
Steve Blocka7e24c12009-10-30 11:49:00 +00003760 // These values match non-compiler-dependent values defined within
3761 // the implementation of v8.
3762 static const int kHeapObjectMapOffset = 0;
Steve Block44f0eee2011-05-26 01:26:41 +01003763 static const int kMapInstanceTypeOffset = 1 * kApiPointerSize + kApiIntSize;
Steve Blockd0582a62009-12-15 09:54:21 +00003764 static const int kStringResourceOffset =
Shimeng (Simon) Wang8a31eba2010-12-06 19:01:33 -08003765 InternalConstants<kApiPointerSize>::kStringResourceOffset;
Steve Blockd0582a62009-12-15 09:54:21 +00003766
Ben Murdoch257744e2011-11-30 15:57:28 +00003767 static const int kForeignAddressOffset = kApiPointerSize;
Shimeng (Simon) Wang8a31eba2010-12-06 19:01:33 -08003768 static const int kJSObjectHeaderSize = 3 * kApiPointerSize;
Steve Blocka7e24c12009-10-30 11:49:00 +00003769 static const int kFullStringRepresentationMask = 0x07;
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01003770 static const int kExternalTwoByteRepresentationTag = 0x02;
Steve Blocka7e24c12009-10-30 11:49:00 +00003771
Ben Murdoch3fb3ca82011-12-02 17:19:32 +00003772 static const int kJSObjectType = 0xa3;
Kristian Monsen9dcf7e22010-06-28 14:14:28 +01003773 static const int kFirstNonstringType = 0x80;
Ben Murdoch257744e2011-11-30 15:57:28 +00003774 static const int kForeignType = 0x85;
Steve Blocka7e24c12009-10-30 11:49:00 +00003775
3776 static inline bool HasHeapObjectTag(internal::Object* value) {
3777 return ((reinterpret_cast<intptr_t>(value) & kHeapObjectTagMask) ==
3778 kHeapObjectTag);
3779 }
3780
3781 static inline bool HasSmiTag(internal::Object* value) {
3782 return ((reinterpret_cast<intptr_t>(value) & kSmiTagMask) == kSmiTag);
3783 }
3784
3785 static inline int SmiValue(internal::Object* value) {
Ben Murdochb8e0da22011-05-16 14:20:40 +01003786 return PlatformSmiTagging::SmiToInt(value);
Steve Block3ce2e202009-11-05 08:53:23 +00003787 }
3788
3789 static inline int GetInstanceType(internal::Object* obj) {
3790 typedef internal::Object O;
3791 O* map = ReadField<O*>(obj, kHeapObjectMapOffset);
3792 return ReadField<uint8_t>(map, kMapInstanceTypeOffset);
3793 }
3794
Ben Murdochb8e0da22011-05-16 14:20:40 +01003795 static inline void* GetExternalPointerFromSmi(internal::Object* value) {
Steve Block1e0659c2011-05-24 12:43:12 +01003796 const uintptr_t address = reinterpret_cast<uintptr_t>(value);
Ben Murdochb8e0da22011-05-16 14:20:40 +01003797 return reinterpret_cast<void*>(address >> kPointerToSmiShift);
3798 }
3799
Steve Block3ce2e202009-11-05 08:53:23 +00003800 static inline void* GetExternalPointer(internal::Object* obj) {
3801 if (HasSmiTag(obj)) {
Ben Murdochb8e0da22011-05-16 14:20:40 +01003802 return GetExternalPointerFromSmi(obj);
Ben Murdoch257744e2011-11-30 15:57:28 +00003803 } else if (GetInstanceType(obj) == kForeignType) {
3804 return ReadField<void*>(obj, kForeignAddressOffset);
Steve Block3ce2e202009-11-05 08:53:23 +00003805 } else {
3806 return NULL;
3807 }
Steve Blocka7e24c12009-10-30 11:49:00 +00003808 }
3809
3810 static inline bool IsExternalTwoByteString(int instance_type) {
3811 int representation = (instance_type & kFullStringRepresentationMask);
3812 return representation == kExternalTwoByteRepresentationTag;
3813 }
3814
3815 template <typename T>
3816 static inline T ReadField(Object* ptr, int offset) {
3817 uint8_t* addr = reinterpret_cast<uint8_t*>(ptr) + offset - kHeapObjectTag;
3818 return *reinterpret_cast<T*>(addr);
3819 }
Steve Block44f0eee2011-05-26 01:26:41 +01003820
3821 static inline bool CanCastToHeapObject(void* o) { return false; }
3822 static inline bool CanCastToHeapObject(Context* o) { return true; }
3823 static inline bool CanCastToHeapObject(String* o) { return true; }
3824 static inline bool CanCastToHeapObject(Object* o) { return true; }
3825 static inline bool CanCastToHeapObject(Message* o) { return true; }
3826 static inline bool CanCastToHeapObject(StackTrace* o) { return true; }
3827 static inline bool CanCastToHeapObject(StackFrame* o) { return true; }
Steve Blocka7e24c12009-10-30 11:49:00 +00003828};
3829
Teng-Hui Zhu3e5fa292010-11-09 16:16:48 -08003830} // namespace internal
Steve Blocka7e24c12009-10-30 11:49:00 +00003831
3832
3833template <class T>
Steve Blocka7e24c12009-10-30 11:49:00 +00003834Local<T>::Local() : Handle<T>() { }
3835
3836
3837template <class T>
3838Local<T> Local<T>::New(Handle<T> that) {
3839 if (that.IsEmpty()) return Local<T>();
Steve Block44f0eee2011-05-26 01:26:41 +01003840 T* that_ptr = *that;
3841 internal::Object** p = reinterpret_cast<internal::Object**>(that_ptr);
3842 if (internal::Internals::CanCastToHeapObject(that_ptr)) {
3843 return Local<T>(reinterpret_cast<T*>(HandleScope::CreateHandle(
3844 reinterpret_cast<internal::HeapObject*>(*p))));
3845 }
Steve Blocka7e24c12009-10-30 11:49:00 +00003846 return Local<T>(reinterpret_cast<T*>(HandleScope::CreateHandle(*p)));
3847}
3848
3849
3850template <class T>
3851Persistent<T> Persistent<T>::New(Handle<T> that) {
3852 if (that.IsEmpty()) return Persistent<T>();
3853 internal::Object** p = reinterpret_cast<internal::Object**>(*that);
3854 return Persistent<T>(reinterpret_cast<T*>(V8::GlobalizeReference(p)));
3855}
3856
3857
3858template <class T>
3859bool Persistent<T>::IsNearDeath() const {
3860 if (this->IsEmpty()) return false;
3861 return V8::IsGlobalNearDeath(reinterpret_cast<internal::Object**>(**this));
3862}
3863
3864
3865template <class T>
3866bool Persistent<T>::IsWeak() const {
3867 if (this->IsEmpty()) return false;
3868 return V8::IsGlobalWeak(reinterpret_cast<internal::Object**>(**this));
3869}
3870
3871
3872template <class T>
3873void Persistent<T>::Dispose() {
3874 if (this->IsEmpty()) return;
3875 V8::DisposeGlobal(reinterpret_cast<internal::Object**>(**this));
3876}
3877
3878
3879template <class T>
3880Persistent<T>::Persistent() : Handle<T>() { }
3881
3882template <class T>
3883void Persistent<T>::MakeWeak(void* parameters, WeakReferenceCallback callback) {
3884 V8::MakeWeak(reinterpret_cast<internal::Object**>(**this),
3885 parameters,
3886 callback);
3887}
3888
3889template <class T>
3890void Persistent<T>::ClearWeak() {
3891 V8::ClearWeak(reinterpret_cast<internal::Object**>(**this));
3892}
3893
Steve Block44f0eee2011-05-26 01:26:41 +01003894template <class T>
Ben Murdoch257744e2011-11-30 15:57:28 +00003895void Persistent<T>::MarkIndependent() {
3896 V8::MarkIndependent(reinterpret_cast<internal::Object**>(**this));
3897}
3898
3899template <class T>
Steve Block44f0eee2011-05-26 01:26:41 +01003900void Persistent<T>::SetWrapperClassId(uint16_t class_id) {
3901 V8::SetWrapperClassId(reinterpret_cast<internal::Object**>(**this), class_id);
3902}
Steve Block8defd9f2010-07-08 12:39:36 +01003903
Teng-Hui Zhu3e5fa292010-11-09 16:16:48 -08003904Arguments::Arguments(internal::Object** implicit_args,
3905 internal::Object** values, int length,
3906 bool is_construct_call)
3907 : implicit_args_(implicit_args),
3908 values_(values),
3909 length_(length),
3910 is_construct_call_(is_construct_call) { }
Steve Block8defd9f2010-07-08 12:39:36 +01003911
3912
Steve Blocka7e24c12009-10-30 11:49:00 +00003913Local<Value> Arguments::operator[](int i) const {
3914 if (i < 0 || length_ <= i) return Local<Value>(*Undefined());
3915 return Local<Value>(reinterpret_cast<Value*>(values_ - i));
3916}
3917
3918
3919Local<Function> Arguments::Callee() const {
Teng-Hui Zhu3e5fa292010-11-09 16:16:48 -08003920 return Local<Function>(reinterpret_cast<Function*>(
3921 &implicit_args_[kCalleeIndex]));
Steve Blocka7e24c12009-10-30 11:49:00 +00003922}
3923
3924
3925Local<Object> Arguments::This() const {
3926 return Local<Object>(reinterpret_cast<Object*>(values_ + 1));
3927}
3928
3929
3930Local<Object> Arguments::Holder() const {
Teng-Hui Zhu3e5fa292010-11-09 16:16:48 -08003931 return Local<Object>(reinterpret_cast<Object*>(
3932 &implicit_args_[kHolderIndex]));
Steve Blocka7e24c12009-10-30 11:49:00 +00003933}
3934
3935
3936Local<Value> Arguments::Data() const {
Teng-Hui Zhu3e5fa292010-11-09 16:16:48 -08003937 return Local<Value>(reinterpret_cast<Value*>(&implicit_args_[kDataIndex]));
Steve Blocka7e24c12009-10-30 11:49:00 +00003938}
3939
3940
3941bool Arguments::IsConstructCall() const {
3942 return is_construct_call_;
3943}
3944
3945
3946int Arguments::Length() const {
3947 return length_;
3948}
3949
3950
3951template <class T>
3952Local<T> HandleScope::Close(Handle<T> value) {
3953 internal::Object** before = reinterpret_cast<internal::Object**>(*value);
3954 internal::Object** after = RawClose(before);
3955 return Local<T>(reinterpret_cast<T*>(after));
3956}
3957
3958Handle<Value> ScriptOrigin::ResourceName() const {
3959 return resource_name_;
3960}
3961
3962
3963Handle<Integer> ScriptOrigin::ResourceLineOffset() const {
3964 return resource_line_offset_;
3965}
3966
3967
3968Handle<Integer> ScriptOrigin::ResourceColumnOffset() const {
3969 return resource_column_offset_;
3970}
3971
3972
3973Handle<Boolean> Boolean::New(bool value) {
3974 return value ? True() : False();
3975}
3976
3977
3978void Template::Set(const char* name, v8::Handle<Data> value) {
3979 Set(v8::String::New(name), value);
3980}
3981
3982
3983Local<Value> Object::GetInternalField(int index) {
3984#ifndef V8_ENABLE_CHECKS
3985 Local<Value> quick_result = UncheckedGetInternalField(index);
3986 if (!quick_result.IsEmpty()) return quick_result;
3987#endif
3988 return CheckedGetInternalField(index);
3989}
3990
3991
3992Local<Value> Object::UncheckedGetInternalField(int index) {
3993 typedef internal::Object O;
3994 typedef internal::Internals I;
3995 O* obj = *reinterpret_cast<O**>(this);
Steve Block3ce2e202009-11-05 08:53:23 +00003996 if (I::GetInstanceType(obj) == I::kJSObjectType) {
Steve Blocka7e24c12009-10-30 11:49:00 +00003997 // If the object is a plain JSObject, which is the common case,
3998 // we know where to find the internal fields and can return the
3999 // value directly.
Shimeng (Simon) Wang8a31eba2010-12-06 19:01:33 -08004000 int offset = I::kJSObjectHeaderSize + (internal::kApiPointerSize * index);
Steve Blocka7e24c12009-10-30 11:49:00 +00004001 O* value = I::ReadField<O*>(obj, offset);
4002 O** result = HandleScope::CreateHandle(value);
4003 return Local<Value>(reinterpret_cast<Value*>(result));
4004 } else {
4005 return Local<Value>();
4006 }
4007}
4008
4009
4010void* External::Unwrap(Handle<v8::Value> obj) {
4011#ifdef V8_ENABLE_CHECKS
4012 return FullUnwrap(obj);
4013#else
4014 return QuickUnwrap(obj);
4015#endif
4016}
4017
4018
4019void* External::QuickUnwrap(Handle<v8::Value> wrapper) {
4020 typedef internal::Object O;
Steve Blocka7e24c12009-10-30 11:49:00 +00004021 O* obj = *reinterpret_cast<O**>(const_cast<v8::Value*>(*wrapper));
Steve Block3ce2e202009-11-05 08:53:23 +00004022 return internal::Internals::GetExternalPointer(obj);
Steve Blocka7e24c12009-10-30 11:49:00 +00004023}
4024
4025
4026void* Object::GetPointerFromInternalField(int index) {
Steve Block3ce2e202009-11-05 08:53:23 +00004027 typedef internal::Object O;
4028 typedef internal::Internals I;
4029
4030 O* obj = *reinterpret_cast<O**>(this);
4031
4032 if (I::GetInstanceType(obj) == I::kJSObjectType) {
4033 // If the object is a plain JSObject, which is the common case,
4034 // we know where to find the internal fields and can return the
4035 // value directly.
Shimeng (Simon) Wang8a31eba2010-12-06 19:01:33 -08004036 int offset = I::kJSObjectHeaderSize + (internal::kApiPointerSize * index);
Steve Block3ce2e202009-11-05 08:53:23 +00004037 O* value = I::ReadField<O*>(obj, offset);
4038 return I::GetExternalPointer(value);
4039 }
4040
4041 return SlowGetPointerFromInternalField(index);
Steve Blocka7e24c12009-10-30 11:49:00 +00004042}
4043
4044
4045String* String::Cast(v8::Value* value) {
4046#ifdef V8_ENABLE_CHECKS
4047 CheckCast(value);
4048#endif
4049 return static_cast<String*>(value);
4050}
4051
4052
4053String::ExternalStringResource* String::GetExternalStringResource() const {
4054 typedef internal::Object O;
4055 typedef internal::Internals I;
4056 O* obj = *reinterpret_cast<O**>(const_cast<String*>(this));
Steve Blocka7e24c12009-10-30 11:49:00 +00004057 String::ExternalStringResource* result;
Steve Block3ce2e202009-11-05 08:53:23 +00004058 if (I::IsExternalTwoByteString(I::GetInstanceType(obj))) {
Steve Blocka7e24c12009-10-30 11:49:00 +00004059 void* value = I::ReadField<void*>(obj, I::kStringResourceOffset);
4060 result = reinterpret_cast<String::ExternalStringResource*>(value);
4061 } else {
4062 result = NULL;
4063 }
4064#ifdef V8_ENABLE_CHECKS
4065 VerifyExternalStringResource(result);
4066#endif
4067 return result;
4068}
4069
4070
4071bool Value::IsString() const {
4072#ifdef V8_ENABLE_CHECKS
4073 return FullIsString();
4074#else
4075 return QuickIsString();
4076#endif
4077}
4078
4079bool Value::QuickIsString() const {
4080 typedef internal::Object O;
4081 typedef internal::Internals I;
4082 O* obj = *reinterpret_cast<O**>(const_cast<Value*>(this));
4083 if (!I::HasHeapObjectTag(obj)) return false;
Steve Block3ce2e202009-11-05 08:53:23 +00004084 return (I::GetInstanceType(obj) < I::kFirstNonstringType);
Steve Blocka7e24c12009-10-30 11:49:00 +00004085}
4086
4087
4088Number* Number::Cast(v8::Value* value) {
4089#ifdef V8_ENABLE_CHECKS
4090 CheckCast(value);
4091#endif
4092 return static_cast<Number*>(value);
4093}
4094
4095
4096Integer* Integer::Cast(v8::Value* value) {
4097#ifdef V8_ENABLE_CHECKS
4098 CheckCast(value);
4099#endif
4100 return static_cast<Integer*>(value);
4101}
4102
4103
4104Date* Date::Cast(v8::Value* value) {
4105#ifdef V8_ENABLE_CHECKS
4106 CheckCast(value);
4107#endif
4108 return static_cast<Date*>(value);
4109}
4110
4111
Ben Murdoch3fb3ca82011-12-02 17:19:32 +00004112StringObject* StringObject::Cast(v8::Value* value) {
4113#ifdef V8_ENABLE_CHECKS
4114 CheckCast(value);
4115#endif
4116 return static_cast<StringObject*>(value);
4117}
4118
4119
4120NumberObject* NumberObject::Cast(v8::Value* value) {
4121#ifdef V8_ENABLE_CHECKS
4122 CheckCast(value);
4123#endif
4124 return static_cast<NumberObject*>(value);
4125}
4126
4127
4128BooleanObject* BooleanObject::Cast(v8::Value* value) {
4129#ifdef V8_ENABLE_CHECKS
4130 CheckCast(value);
4131#endif
4132 return static_cast<BooleanObject*>(value);
4133}
4134
4135
Ben Murdochf87a2032010-10-22 12:50:53 +01004136RegExp* RegExp::Cast(v8::Value* value) {
4137#ifdef V8_ENABLE_CHECKS
4138 CheckCast(value);
4139#endif
4140 return static_cast<RegExp*>(value);
4141}
4142
4143
Steve Blocka7e24c12009-10-30 11:49:00 +00004144Object* Object::Cast(v8::Value* value) {
4145#ifdef V8_ENABLE_CHECKS
4146 CheckCast(value);
4147#endif
4148 return static_cast<Object*>(value);
4149}
4150
4151
4152Array* Array::Cast(v8::Value* value) {
4153#ifdef V8_ENABLE_CHECKS
4154 CheckCast(value);
4155#endif
4156 return static_cast<Array*>(value);
4157}
4158
4159
4160Function* Function::Cast(v8::Value* value) {
4161#ifdef V8_ENABLE_CHECKS
4162 CheckCast(value);
4163#endif
4164 return static_cast<Function*>(value);
4165}
4166
4167
4168External* External::Cast(v8::Value* value) {
4169#ifdef V8_ENABLE_CHECKS
4170 CheckCast(value);
4171#endif
4172 return static_cast<External*>(value);
4173}
4174
4175
4176Local<Value> AccessorInfo::Data() const {
Steve Block6ded16b2010-05-10 14:33:55 +01004177 return Local<Value>(reinterpret_cast<Value*>(&args_[-2]));
Steve Blocka7e24c12009-10-30 11:49:00 +00004178}
4179
4180
4181Local<Object> AccessorInfo::This() const {
4182 return Local<Object>(reinterpret_cast<Object*>(&args_[0]));
4183}
4184
4185
4186Local<Object> AccessorInfo::Holder() const {
4187 return Local<Object>(reinterpret_cast<Object*>(&args_[-1]));
4188}
4189
4190
4191/**
4192 * \example shell.cc
4193 * A simple shell that takes a list of expressions on the
4194 * command-line and executes them.
4195 */
4196
4197
4198/**
4199 * \example process.cc
4200 */
4201
4202
4203} // namespace v8
4204
4205
4206#undef V8EXPORT
Steve Blocka7e24c12009-10-30 11:49:00 +00004207#undef TYPE_CHECK
4208
4209
4210#endif // V8_H_