blob: b62561876c20021851ba79cc12d89a18053674e4 [file] [log] [blame]
Steve Blocka7e24c12009-10-30 11:49:00 +00001// Copyright 2007-2009 the V8 project authors. All rights reserved.
2// 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
41#include <stdio.h>
42
43#ifdef _WIN32
44// When compiling on MinGW stdint.h is available.
45#ifdef __MINGW32__
46#include <stdint.h>
47#else // __MINGW32__
48typedef signed char int8_t;
49typedef unsigned char uint8_t;
50typedef short int16_t; // NOLINT
51typedef unsigned short uint16_t; // NOLINT
52typedef int int32_t;
53typedef unsigned int uint32_t;
54typedef __int64 int64_t;
55typedef unsigned __int64 uint64_t;
56// intptr_t and friends are defined in crtdefs.h through stdio.h.
57#endif // __MINGW32__
58
59// Setup for Windows DLL export/import. When building the V8 DLL the
60// BUILDING_V8_SHARED needs to be defined. When building a program which uses
61// the V8 DLL USING_V8_SHARED needs to be defined. When either building the V8
62// static library or building a program which uses the V8 static library neither
63// BUILDING_V8_SHARED nor USING_V8_SHARED should be defined.
64// The reason for having both V8EXPORT and V8EXPORT_INLINE is that classes which
65// have their code inside this header file need to have __declspec(dllexport)
66// when building the DLL but cannot have __declspec(dllimport) when building
67// a program which uses the DLL.
68#if defined(BUILDING_V8_SHARED) && defined(USING_V8_SHARED)
69#error both BUILDING_V8_SHARED and USING_V8_SHARED are set - please check the\
70 build configuration to ensure that at most one of these is set
71#endif
72
73#ifdef BUILDING_V8_SHARED
74#define V8EXPORT __declspec(dllexport)
75#define V8EXPORT_INLINE __declspec(dllexport)
76#elif USING_V8_SHARED
77#define V8EXPORT __declspec(dllimport)
78#define V8EXPORT_INLINE
79#else
80#define V8EXPORT
81#define V8EXPORT_INLINE
82#endif // BUILDING_V8_SHARED
83
84#else // _WIN32
85
86#include <stdint.h>
87
88// Setup for Linux shared library export. There is no need to distinguish
89// between building or using the V8 shared library, but we should not
90// export symbols when we are building a static library.
91#if defined(__GNUC__) && (__GNUC__ >= 4) && defined(V8_SHARED)
92#define V8EXPORT __attribute__ ((visibility("default")))
93#define V8EXPORT_INLINE __attribute__ ((visibility("default")))
94#else // defined(__GNUC__) && (__GNUC__ >= 4)
95#define V8EXPORT
96#define V8EXPORT_INLINE
97#endif // defined(__GNUC__) && (__GNUC__ >= 4)
98
99#endif // _WIN32
100
101/**
102 * The v8 JavaScript engine.
103 */
104namespace v8 {
105
106class Context;
107class String;
108class Value;
109class Utils;
110class Number;
111class Object;
112class Array;
113class Int32;
114class Uint32;
115class External;
116class Primitive;
117class Boolean;
118class Integer;
119class Function;
120class Date;
121class ImplementationUtilities;
122class Signature;
123template <class T> class Handle;
124template <class T> class Local;
125template <class T> class Persistent;
126class FunctionTemplate;
127class ObjectTemplate;
128class Data;
Leon Clarkef7060e22010-06-03 12:02:55 +0100129class AccessorInfo;
Kristian Monsen25f61362010-05-21 11:50:48 +0100130class StackTrace;
131class StackFrame;
Steve Blocka7e24c12009-10-30 11:49:00 +0000132
133namespace internal {
134
Steve Blocka7e24c12009-10-30 11:49:00 +0000135class Arguments;
Steve Blockd0582a62009-12-15 09:54:21 +0000136class Object;
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +0100137class Heap;
Steve Blockd0582a62009-12-15 09:54:21 +0000138class Top;
Steve Blocka7e24c12009-10-30 11:49:00 +0000139
140}
141
142
143// --- W e a k H a n d l e s
144
145
146/**
147 * A weak reference callback function.
148 *
149 * \param object the weak global object to be reclaimed by the garbage collector
150 * \param parameter the value passed in when making the weak global object
151 */
152typedef void (*WeakReferenceCallback)(Persistent<Value> object,
153 void* parameter);
154
155
156// --- H a n d l e s ---
157
158#define TYPE_CHECK(T, S) \
159 while (false) { \
160 *(static_cast<T**>(0)) = static_cast<S*>(0); \
161 }
162
163/**
164 * An object reference managed by the v8 garbage collector.
165 *
166 * All objects returned from v8 have to be tracked by the garbage
167 * collector so that it knows that the objects are still alive. Also,
168 * because the garbage collector may move objects, it is unsafe to
169 * point directly to an object. Instead, all objects are stored in
170 * handles which are known by the garbage collector and updated
171 * whenever an object moves. Handles should always be passed by value
172 * (except in cases like out-parameters) and they should never be
173 * allocated on the heap.
174 *
175 * There are two types of handles: local and persistent handles.
176 * Local handles are light-weight and transient and typically used in
177 * local operations. They are managed by HandleScopes. Persistent
178 * handles can be used when storing objects across several independent
179 * operations and have to be explicitly deallocated when they're no
180 * longer used.
181 *
182 * It is safe to extract the object stored in the handle by
183 * dereferencing the handle (for instance, to extract the Object* from
184 * an Handle<Object>); the value will still be governed by a handle
185 * behind the scenes and the same rules apply to these values as to
186 * their handles.
187 */
188template <class T> class V8EXPORT_INLINE Handle {
189 public:
190
191 /**
192 * Creates an empty handle.
193 */
194 inline Handle();
195
196 /**
197 * Creates a new handle for the specified value.
198 */
199 explicit Handle(T* val) : val_(val) { }
200
201 /**
202 * Creates a handle for the contents of the specified handle. This
203 * constructor allows you to pass handles as arguments by value and
204 * to assign between handles. However, if you try to assign between
205 * incompatible handles, for instance from a Handle<String> to a
206 * Handle<Number> it will cause a compiletime error. Assigning
207 * between compatible handles, for instance assigning a
208 * Handle<String> to a variable declared as Handle<Value>, is legal
209 * because String is a subclass of Value.
210 */
211 template <class S> inline Handle(Handle<S> that)
212 : val_(reinterpret_cast<T*>(*that)) {
213 /**
214 * This check fails when trying to convert between incompatible
215 * handles. For example, converting from a Handle<String> to a
216 * Handle<Number>.
217 */
218 TYPE_CHECK(T, S);
219 }
220
221 /**
222 * Returns true if the handle is empty.
223 */
224 bool IsEmpty() const { return val_ == 0; }
225
226 T* operator->() const { return val_; }
227
228 T* operator*() const { return val_; }
229
230 /**
231 * Sets the handle to be empty. IsEmpty() will then return true.
232 */
233 void Clear() { this->val_ = 0; }
234
235 /**
236 * Checks whether two handles are the same.
237 * Returns true if both are empty, or if the objects
238 * to which they refer are identical.
239 * The handles' references are not checked.
240 */
241 template <class S> bool operator==(Handle<S> that) const {
242 internal::Object** a = reinterpret_cast<internal::Object**>(**this);
243 internal::Object** b = reinterpret_cast<internal::Object**>(*that);
244 if (a == 0) return b == 0;
245 if (b == 0) return false;
246 return *a == *b;
247 }
248
249 /**
250 * Checks whether two handles are different.
251 * Returns true if only one of the handles is empty, or if
252 * the objects to which they refer are different.
253 * The handles' references are not checked.
254 */
255 template <class S> bool operator!=(Handle<S> that) const {
256 return !operator==(that);
257 }
258
259 template <class S> static inline Handle<T> Cast(Handle<S> that) {
260#ifdef V8_ENABLE_CHECKS
261 // If we're going to perform the type check then we have to check
262 // that the handle isn't empty before doing the checked cast.
263 if (that.IsEmpty()) return Handle<T>();
264#endif
265 return Handle<T>(T::Cast(*that));
266 }
267
Steve Block6ded16b2010-05-10 14:33:55 +0100268 template <class S> inline Handle<S> As() {
269 return Handle<S>::Cast(*this);
270 }
271
Steve Blocka7e24c12009-10-30 11:49:00 +0000272 private:
273 T* val_;
274};
275
276
277/**
278 * A light-weight stack-allocated object handle. All operations
279 * that return objects from within v8 return them in local handles. They
280 * are created within HandleScopes, and all local handles allocated within a
281 * handle scope are destroyed when the handle scope is destroyed. Hence it
282 * is not necessary to explicitly deallocate local handles.
283 */
284template <class T> class V8EXPORT_INLINE Local : public Handle<T> {
285 public:
286 inline Local();
287 template <class S> inline Local(Local<S> that)
288 : Handle<T>(reinterpret_cast<T*>(*that)) {
289 /**
290 * This check fails when trying to convert between incompatible
291 * handles. For example, converting from a Handle<String> to a
292 * Handle<Number>.
293 */
294 TYPE_CHECK(T, S);
295 }
296 template <class S> inline Local(S* that) : Handle<T>(that) { }
297 template <class S> static inline Local<T> Cast(Local<S> that) {
298#ifdef V8_ENABLE_CHECKS
299 // If we're going to perform the type check then we have to check
300 // that the handle isn't empty before doing the checked cast.
301 if (that.IsEmpty()) return Local<T>();
302#endif
303 return Local<T>(T::Cast(*that));
304 }
305
Steve Block6ded16b2010-05-10 14:33:55 +0100306 template <class S> inline Local<S> As() {
307 return Local<S>::Cast(*this);
308 }
309
Steve Blocka7e24c12009-10-30 11:49:00 +0000310 /** Create a local handle for the content of another handle.
311 * The referee is kept alive by the local handle even when
312 * the original handle is destroyed/disposed.
313 */
314 inline static Local<T> New(Handle<T> that);
315};
316
317
318/**
319 * An object reference that is independent of any handle scope. Where
320 * a Local handle only lives as long as the HandleScope in which it was
321 * allocated, a Persistent handle remains valid until it is explicitly
322 * disposed.
323 *
324 * A persistent handle contains a reference to a storage cell within
325 * the v8 engine which holds an object value and which is updated by
326 * the garbage collector whenever the object is moved. A new storage
327 * cell can be created using Persistent::New and existing handles can
328 * be disposed using Persistent::Dispose. Since persistent handles
329 * are passed by value you may have many persistent handle objects
330 * that point to the same storage cell. For instance, if you pass a
331 * persistent handle as an argument to a function you will not get two
332 * different storage cells but rather two references to the same
333 * storage cell.
334 */
335template <class T> class V8EXPORT_INLINE Persistent : public Handle<T> {
336 public:
337
338 /**
339 * Creates an empty persistent handle that doesn't point to any
340 * storage cell.
341 */
342 inline Persistent();
343
344 /**
345 * Creates a persistent handle for the same storage cell as the
346 * specified handle. This constructor allows you to pass persistent
347 * handles as arguments by value and to assign between persistent
348 * handles. However, attempting to assign between incompatible
349 * persistent handles, for instance from a Persistent<String> to a
350 * Persistent<Number> will cause a compiletime error. Assigning
351 * between compatible persistent handles, for instance assigning a
352 * Persistent<String> to a variable declared as Persistent<Value>,
353 * is allowed as String is a subclass of Value.
354 */
355 template <class S> inline Persistent(Persistent<S> that)
356 : Handle<T>(reinterpret_cast<T*>(*that)) {
357 /**
358 * This check fails when trying to convert between incompatible
359 * handles. For example, converting from a Handle<String> to a
360 * Handle<Number>.
361 */
362 TYPE_CHECK(T, S);
363 }
364
365 template <class S> inline Persistent(S* that) : Handle<T>(that) { }
366
367 /**
368 * "Casts" a plain handle which is known to be a persistent handle
369 * to a persistent handle.
370 */
371 template <class S> explicit inline Persistent(Handle<S> that)
372 : Handle<T>(*that) { }
373
374 template <class S> static inline Persistent<T> Cast(Persistent<S> that) {
375#ifdef V8_ENABLE_CHECKS
376 // If we're going to perform the type check then we have to check
377 // that the handle isn't empty before doing the checked cast.
378 if (that.IsEmpty()) return Persistent<T>();
379#endif
380 return Persistent<T>(T::Cast(*that));
381 }
382
Steve Block6ded16b2010-05-10 14:33:55 +0100383 template <class S> inline Persistent<S> As() {
384 return Persistent<S>::Cast(*this);
385 }
386
Steve Blocka7e24c12009-10-30 11:49:00 +0000387 /**
388 * Creates a new persistent handle for an existing local or
389 * persistent handle.
390 */
391 inline static Persistent<T> New(Handle<T> that);
392
393 /**
394 * Releases the storage cell referenced by this persistent handle.
395 * Does not remove the reference to the cell from any handles.
396 * This handle's reference, and any any other references to the storage
397 * cell remain and IsEmpty will still return false.
398 */
399 inline void Dispose();
400
401 /**
402 * Make the reference to this object weak. When only weak handles
403 * refer to the object, the garbage collector will perform a
404 * callback to the given V8::WeakReferenceCallback function, passing
405 * it the object reference and the given parameters.
406 */
407 inline void MakeWeak(void* parameters, WeakReferenceCallback callback);
408
409 /** Clears the weak reference to this object.*/
410 inline void ClearWeak();
411
412 /**
413 *Checks if the handle holds the only reference to an object.
414 */
415 inline bool IsNearDeath() const;
416
417 /**
418 * Returns true if the handle's reference is weak.
419 */
420 inline bool IsWeak() const;
421
422 private:
423 friend class ImplementationUtilities;
424 friend class ObjectTemplate;
425};
426
427
428 /**
429 * A stack-allocated class that governs a number of local handles.
430 * After a handle scope has been created, all local handles will be
431 * allocated within that handle scope until either the handle scope is
432 * deleted or another handle scope is created. If there is already a
433 * handle scope and a new one is created, all allocations will take
434 * place in the new handle scope until it is deleted. After that,
435 * new handles will again be allocated in the original handle scope.
436 *
437 * After the handle scope of a local handle has been deleted the
438 * garbage collector will no longer track the object stored in the
439 * handle and may deallocate it. The behavior of accessing a handle
440 * for which the handle scope has been deleted is undefined.
441 */
442class V8EXPORT HandleScope {
443 public:
444 HandleScope();
445
446 ~HandleScope();
447
448 /**
449 * Closes the handle scope and returns the value as a handle in the
450 * previous scope, which is the new current scope after the call.
451 */
452 template <class T> Local<T> Close(Handle<T> value);
453
454 /**
455 * Counts the number of allocated handles.
456 */
457 static int NumberOfHandles();
458
459 /**
460 * Creates a new handle with the given value.
461 */
462 static internal::Object** CreateHandle(internal::Object* value);
463
464 private:
465 // Make it impossible to create heap-allocated or illegal handle
466 // scopes by disallowing certain operations.
467 HandleScope(const HandleScope&);
468 void operator=(const HandleScope&);
469 void* operator new(size_t size);
470 void operator delete(void*, size_t);
471
Steve Blockd0582a62009-12-15 09:54:21 +0000472 // This Data class is accessible internally as HandleScopeData through a
473 // typedef in the ImplementationUtilities class.
Steve Blocka7e24c12009-10-30 11:49:00 +0000474 class V8EXPORT Data {
475 public:
476 int extensions;
477 internal::Object** next;
478 internal::Object** limit;
479 inline void Initialize() {
480 extensions = -1;
481 next = limit = NULL;
482 }
483 };
484
485 Data previous_;
486
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
496// --- S p e c i a l o b j e c t s ---
497
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 */
566class V8EXPORT ScriptOrigin {
567 public:
568 ScriptOrigin(Handle<Value> resource_name,
569 Handle<Integer> resource_line_offset = Handle<Integer>(),
570 Handle<Integer> resource_column_offset = Handle<Integer>())
571 : resource_name_(resource_name),
572 resource_line_offset_(resource_line_offset),
573 resource_column_offset_(resource_column_offset) { }
574 inline Handle<Value> ResourceName() const;
575 inline Handle<Integer> ResourceLineOffset() const;
576 inline Handle<Integer> ResourceColumnOffset() const;
577 private:
578 Handle<Value> resource_name_;
579 Handle<Integer> resource_line_offset_;
580 Handle<Integer> resource_column_offset_;
581};
582
583
584/**
585 * A compiled JavaScript script.
586 */
587class V8EXPORT Script {
588 public:
589
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 /**
705 * Returns the number, 1-based, of the line where the error occurred.
706 */
707 int GetLineNumber() const;
708
709 /**
710 * Returns the index within the script of the first character where
711 * the error occurred.
712 */
713 int GetStartPosition() const;
714
715 /**
716 * Returns the index within the script of the last character where
717 * the error occurred.
718 */
719 int GetEndPosition() const;
720
721 /**
722 * Returns the index within the line of the first character where
723 * the error occurred.
724 */
725 int GetStartColumn() const;
726
727 /**
728 * Returns the index within the line of the last character where
729 * the error occurred.
730 */
731 int GetEndColumn() const;
732
733 // TODO(1245381): Print to a string instead of on a FILE.
734 static void PrintCurrentStackTrace(FILE* out);
Kristian Monsen25f61362010-05-21 11:50:48 +0100735
736 static const int kNoLineNumberInfo = 0;
737 static const int kNoColumnInfo = 0;
738};
739
740
741/**
742 * Representation of a JavaScript stack trace. The information collected is a
743 * snapshot of the execution stack and the information remains valid after
744 * execution continues.
745 */
746class V8EXPORT StackTrace {
747 public:
748 /**
749 * Flags that determine what information is placed captured for each
750 * StackFrame when grabbing the current stack trace.
751 */
752 enum StackTraceOptions {
753 kLineNumber = 1,
754 kColumnOffset = 1 << 1 | kLineNumber,
755 kScriptName = 1 << 2,
756 kFunctionName = 1 << 3,
757 kIsEval = 1 << 4,
758 kIsConstructor = 1 << 5,
759 kOverview = kLineNumber | kColumnOffset | kScriptName | kFunctionName,
760 kDetailed = kOverview | kIsEval | kIsConstructor
761 };
762
763 /**
764 * Returns a StackFrame at a particular index.
765 */
766 Local<StackFrame> GetFrame(uint32_t index) const;
767
768 /**
769 * Returns the number of StackFrames.
770 */
771 int GetFrameCount() const;
772
773 /**
774 * Returns StackTrace as a v8::Array that contains StackFrame objects.
775 */
776 Local<Array> AsArray();
777
778 /**
779 * Grab a snapshot of the the current JavaScript execution stack.
780 *
781 * \param frame_limit The maximum number of stack frames we want to capture.
782 * \param options Enumerates the set of things we will capture for each
783 * StackFrame.
784 */
785 static Local<StackTrace> CurrentStackTrace(
786 int frame_limit,
787 StackTraceOptions options = kOverview);
788};
789
790
791/**
792 * A single JavaScript stack frame.
793 */
794class V8EXPORT StackFrame {
795 public:
796 /**
797 * Returns the number, 1-based, of the line for the associate function call.
798 * This method will return Message::kNoLineNumberInfo if it is unable to
799 * retrieve the line number, or if kLineNumber was not passed as an option
800 * when capturing the StackTrace.
801 */
802 int GetLineNumber() const;
803
804 /**
805 * Returns the 1-based column offset on the line for the associated function
806 * call.
807 * This method will return Message::kNoColumnInfo if it is unable to retrieve
808 * the column number, or if kColumnOffset was not passed as an option when
809 * capturing the StackTrace.
810 */
811 int GetColumn() const;
812
813 /**
814 * Returns the name of the resource that contains the script for the
815 * function for this StackFrame.
816 */
817 Local<String> GetScriptName() const;
818
819 /**
820 * Returns the name of the function associated with this stack frame.
821 */
822 Local<String> GetFunctionName() const;
823
824 /**
825 * Returns whether or not the associated function is compiled via a call to
826 * eval().
827 */
828 bool IsEval() const;
829
830 /**
831 * Returns whther or not the associated function is called as a
832 * constructor via "new".
833 */
834 bool IsConstructor() const;
Steve Blocka7e24c12009-10-30 11:49:00 +0000835};
836
837
838// --- V a l u e ---
839
840
841/**
842 * The superclass of all JavaScript values and objects.
843 */
844class V8EXPORT Value : public Data {
845 public:
846
847 /**
848 * Returns true if this value is the undefined value. See ECMA-262
849 * 4.3.10.
850 */
851 bool IsUndefined() const;
852
853 /**
854 * Returns true if this value is the null value. See ECMA-262
855 * 4.3.11.
856 */
857 bool IsNull() const;
858
859 /**
860 * Returns true if this value is true.
861 */
862 bool IsTrue() const;
863
864 /**
865 * Returns true if this value is false.
866 */
867 bool IsFalse() const;
868
869 /**
870 * Returns true if this value is an instance of the String type.
871 * See ECMA-262 8.4.
872 */
873 inline bool IsString() const;
874
875 /**
876 * Returns true if this value is a function.
877 */
878 bool IsFunction() const;
879
880 /**
881 * Returns true if this value is an array.
882 */
883 bool IsArray() const;
884
885 /**
886 * Returns true if this value is an object.
887 */
888 bool IsObject() const;
889
890 /**
891 * Returns true if this value is boolean.
892 */
893 bool IsBoolean() const;
894
895 /**
896 * Returns true if this value is a number.
897 */
898 bool IsNumber() const;
899
900 /**
901 * Returns true if this value is external.
902 */
903 bool IsExternal() const;
904
905 /**
906 * Returns true if this value is a 32-bit signed integer.
907 */
908 bool IsInt32() const;
909
910 /**
Steve Block6ded16b2010-05-10 14:33:55 +0100911 * Returns true if this value is a 32-bit unsigned integer.
912 */
913 bool IsUint32() const;
914
915 /**
Steve Blocka7e24c12009-10-30 11:49:00 +0000916 * Returns true if this value is a Date.
917 */
918 bool IsDate() const;
919
920 Local<Boolean> ToBoolean() const;
921 Local<Number> ToNumber() const;
922 Local<String> ToString() const;
923 Local<String> ToDetailString() const;
924 Local<Object> ToObject() const;
925 Local<Integer> ToInteger() const;
926 Local<Uint32> ToUint32() const;
927 Local<Int32> ToInt32() const;
928
929 /**
930 * Attempts to convert a string to an array index.
931 * Returns an empty handle if the conversion fails.
932 */
933 Local<Uint32> ToArrayIndex() const;
934
935 bool BooleanValue() const;
936 double NumberValue() const;
937 int64_t IntegerValue() const;
938 uint32_t Uint32Value() const;
939 int32_t Int32Value() const;
940
941 /** JS == */
942 bool Equals(Handle<Value> that) const;
943 bool StrictEquals(Handle<Value> that) const;
Steve Block3ce2e202009-11-05 08:53:23 +0000944
Steve Blocka7e24c12009-10-30 11:49:00 +0000945 private:
946 inline bool QuickIsString() const;
947 bool FullIsString() const;
948};
949
950
951/**
952 * The superclass of primitive values. See ECMA-262 4.3.2.
953 */
954class V8EXPORT Primitive : public Value { };
955
956
957/**
958 * A primitive boolean value (ECMA-262, 4.3.14). Either the true
959 * or false value.
960 */
961class V8EXPORT Boolean : public Primitive {
962 public:
963 bool Value() const;
964 static inline Handle<Boolean> New(bool value);
965};
966
967
968/**
969 * A JavaScript string value (ECMA-262, 4.3.17).
970 */
971class V8EXPORT String : public Primitive {
972 public:
973
974 /**
975 * Returns the number of characters in this string.
976 */
977 int Length() const;
978
979 /**
980 * Returns the number of bytes in the UTF-8 encoded
981 * representation of this string.
982 */
983 int Utf8Length() const;
984
985 /**
986 * Write the contents of the string to an external buffer.
987 * If no arguments are given, expects the buffer to be large
988 * enough to hold the entire string and NULL terminator. Copies
989 * the contents of the string and the NULL terminator into the
990 * buffer.
991 *
992 * Copies up to length characters into the output buffer.
993 * Only null-terminates if there is enough space in the buffer.
994 *
995 * \param buffer The buffer into which the string will be copied.
996 * \param start The starting position within the string at which
997 * copying begins.
998 * \param length The number of bytes to copy from the string.
Steve Block6ded16b2010-05-10 14:33:55 +0100999 * \param nchars_ref The number of characters written, can be NULL.
1000 * \param hints Various hints that might affect performance of this or
1001 * subsequent operations.
1002 * \return The number of bytes copied to the buffer
Steve Blocka7e24c12009-10-30 11:49:00 +00001003 * excluding the NULL terminator.
1004 */
Steve Block6ded16b2010-05-10 14:33:55 +01001005 enum WriteHints {
1006 NO_HINTS = 0,
1007 HINT_MANY_WRITES_EXPECTED = 1
1008 };
1009
1010 int Write(uint16_t* buffer,
1011 int start = 0,
1012 int length = -1,
1013 WriteHints hints = NO_HINTS) const; // UTF-16
1014 int WriteAscii(char* buffer,
1015 int start = 0,
1016 int length = -1,
1017 WriteHints hints = NO_HINTS) const; // ASCII
1018 int WriteUtf8(char* buffer,
1019 int length = -1,
1020 int* nchars_ref = NULL,
1021 WriteHints hints = NO_HINTS) const; // UTF-8
Steve Blocka7e24c12009-10-30 11:49:00 +00001022
1023 /**
1024 * A zero length string.
1025 */
1026 static v8::Local<v8::String> Empty();
1027
1028 /**
1029 * Returns true if the string is external
1030 */
1031 bool IsExternal() const;
1032
1033 /**
1034 * Returns true if the string is both external and ascii
1035 */
1036 bool IsExternalAscii() const;
Leon Clarkee46be812010-01-19 14:06:41 +00001037
1038 class V8EXPORT ExternalStringResourceBase {
1039 public:
1040 virtual ~ExternalStringResourceBase() {}
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001041
Leon Clarkee46be812010-01-19 14:06:41 +00001042 protected:
1043 ExternalStringResourceBase() {}
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001044
1045 /**
1046 * Internally V8 will call this Dispose method when the external string
1047 * resource is no longer needed. The default implementation will use the
1048 * delete operator. This method can be overridden in subclasses to
1049 * control how allocated external string resources are disposed.
1050 */
1051 virtual void Dispose() { delete this; }
1052
Leon Clarkee46be812010-01-19 14:06:41 +00001053 private:
1054 // Disallow copying and assigning.
1055 ExternalStringResourceBase(const ExternalStringResourceBase&);
1056 void operator=(const ExternalStringResourceBase&);
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001057
1058 friend class v8::internal::Heap;
Leon Clarkee46be812010-01-19 14:06:41 +00001059 };
1060
Steve Blocka7e24c12009-10-30 11:49:00 +00001061 /**
1062 * An ExternalStringResource is a wrapper around a two-byte string
1063 * buffer that resides outside V8's heap. Implement an
1064 * ExternalStringResource to manage the life cycle of the underlying
1065 * buffer. Note that the string data must be immutable.
1066 */
Leon Clarkee46be812010-01-19 14:06:41 +00001067 class V8EXPORT ExternalStringResource
1068 : public ExternalStringResourceBase {
Steve Blocka7e24c12009-10-30 11:49:00 +00001069 public:
1070 /**
1071 * Override the destructor to manage the life cycle of the underlying
1072 * buffer.
1073 */
1074 virtual ~ExternalStringResource() {}
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001075
1076 /**
1077 * The string data from the underlying buffer.
1078 */
Steve Blocka7e24c12009-10-30 11:49:00 +00001079 virtual const uint16_t* data() const = 0;
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001080
1081 /**
1082 * The length of the string. That is, the number of two-byte characters.
1083 */
Steve Blocka7e24c12009-10-30 11:49:00 +00001084 virtual size_t length() const = 0;
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001085
Steve Blocka7e24c12009-10-30 11:49:00 +00001086 protected:
1087 ExternalStringResource() {}
Steve Blocka7e24c12009-10-30 11:49:00 +00001088 };
1089
1090 /**
1091 * An ExternalAsciiStringResource is a wrapper around an ascii
1092 * string buffer that resides outside V8's heap. Implement an
1093 * ExternalAsciiStringResource to manage the life cycle of the
1094 * underlying buffer. Note that the string data must be immutable
1095 * and that the data must be strict 7-bit ASCII, not Latin1 or
1096 * UTF-8, which would require special treatment internally in the
1097 * engine and, in the case of UTF-8, do not allow efficient indexing.
1098 * Use String::New or convert to 16 bit data for non-ASCII.
1099 */
1100
Leon Clarkee46be812010-01-19 14:06:41 +00001101 class V8EXPORT ExternalAsciiStringResource
1102 : public ExternalStringResourceBase {
Steve Blocka7e24c12009-10-30 11:49:00 +00001103 public:
1104 /**
1105 * Override the destructor to manage the life cycle of the underlying
1106 * buffer.
1107 */
1108 virtual ~ExternalAsciiStringResource() {}
1109 /** The string data from the underlying buffer.*/
1110 virtual const char* data() const = 0;
1111 /** The number of ascii characters in the string.*/
1112 virtual size_t length() const = 0;
1113 protected:
1114 ExternalAsciiStringResource() {}
Steve Blocka7e24c12009-10-30 11:49:00 +00001115 };
1116
1117 /**
1118 * Get the ExternalStringResource for an external string. Returns
1119 * NULL if IsExternal() doesn't return true.
1120 */
1121 inline ExternalStringResource* GetExternalStringResource() const;
1122
1123 /**
1124 * Get the ExternalAsciiStringResource for an external ascii string.
1125 * Returns NULL if IsExternalAscii() doesn't return true.
1126 */
1127 ExternalAsciiStringResource* GetExternalAsciiStringResource() const;
1128
1129 static inline String* Cast(v8::Value* obj);
1130
1131 /**
1132 * Allocates a new string from either utf-8 encoded or ascii data.
1133 * The second parameter 'length' gives the buffer length.
1134 * If the data is utf-8 encoded, the caller must
1135 * be careful to supply the length parameter.
1136 * If it is not given, the function calls
1137 * 'strlen' to determine the buffer length, it might be
1138 * wrong if 'data' contains a null character.
1139 */
1140 static Local<String> New(const char* data, int length = -1);
1141
1142 /** Allocates a new string from utf16 data.*/
1143 static Local<String> New(const uint16_t* data, int length = -1);
1144
1145 /** Creates a symbol. Returns one if it exists already.*/
1146 static Local<String> NewSymbol(const char* data, int length = -1);
1147
1148 /**
Steve Block3ce2e202009-11-05 08:53:23 +00001149 * Creates a new string by concatenating the left and the right strings
1150 * passed in as parameters.
1151 */
1152 static Local<String> Concat(Handle<String> left, Handle<String>right);
1153
1154 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00001155 * Creates a new external string using the data defined in the given
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001156 * resource. When the external string is no longer live on V8's heap the
1157 * resource will be disposed by calling its Dispose method. The caller of
1158 * this function should not otherwise delete or modify the resource. Neither
1159 * should the underlying buffer be deallocated or modified except through the
1160 * destructor of the external string resource.
Steve Blocka7e24c12009-10-30 11:49:00 +00001161 */
1162 static Local<String> NewExternal(ExternalStringResource* resource);
1163
1164 /**
1165 * Associate an external string resource with this string by transforming it
1166 * in place so that existing references to this string in the JavaScript heap
1167 * will use the external string resource. The external string resource's
1168 * character contents needs to be equivalent to this string.
1169 * Returns true if the string has been changed to be an external string.
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001170 * The string is not modified if the operation fails. See NewExternal for
1171 * information on the lifetime of the resource.
Steve Blocka7e24c12009-10-30 11:49:00 +00001172 */
1173 bool MakeExternal(ExternalStringResource* resource);
1174
1175 /**
1176 * Creates a new external string using the ascii data defined in the given
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001177 * resource. When the external string is no longer live on V8's heap the
1178 * resource will be disposed by calling its Dispose method. The caller of
1179 * this function should not otherwise delete or modify the resource. Neither
1180 * should the underlying buffer be deallocated or modified except through the
1181 * destructor of the external string resource.
Steve Blocka7e24c12009-10-30 11:49:00 +00001182 */
1183 static Local<String> NewExternal(ExternalAsciiStringResource* resource);
1184
1185 /**
1186 * Associate an external string resource with this string by transforming it
1187 * in place so that existing references to this string in the JavaScript heap
1188 * will use the external string resource. The external string resource's
1189 * character contents needs to be equivalent to this string.
1190 * Returns true if the string has been changed to be an external string.
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001191 * The string is not modified if the operation fails. See NewExternal for
1192 * information on the lifetime of the resource.
Steve Blocka7e24c12009-10-30 11:49:00 +00001193 */
1194 bool MakeExternal(ExternalAsciiStringResource* resource);
1195
1196 /**
1197 * Returns true if this string can be made external.
1198 */
1199 bool CanMakeExternal();
1200
1201 /** Creates an undetectable string from the supplied ascii or utf-8 data.*/
1202 static Local<String> NewUndetectable(const char* data, int length = -1);
1203
1204 /** Creates an undetectable string from the supplied utf-16 data.*/
1205 static Local<String> NewUndetectable(const uint16_t* data, int length = -1);
1206
1207 /**
1208 * Converts an object to a utf8-encoded character array. Useful if
1209 * you want to print the object. If conversion to a string fails
1210 * (eg. due to an exception in the toString() method of the object)
1211 * then the length() method returns 0 and the * operator returns
1212 * NULL.
1213 */
1214 class V8EXPORT Utf8Value {
1215 public:
1216 explicit Utf8Value(Handle<v8::Value> obj);
1217 ~Utf8Value();
1218 char* operator*() { return str_; }
1219 const char* operator*() const { return str_; }
1220 int length() const { return length_; }
1221 private:
1222 char* str_;
1223 int length_;
1224
1225 // Disallow copying and assigning.
1226 Utf8Value(const Utf8Value&);
1227 void operator=(const Utf8Value&);
1228 };
1229
1230 /**
1231 * Converts an object to an ascii string.
1232 * Useful if you want to print the object.
1233 * If conversion to a string fails (eg. due to an exception in the toString()
1234 * method of the object) then the length() method returns 0 and the * operator
1235 * returns NULL.
1236 */
1237 class V8EXPORT AsciiValue {
1238 public:
1239 explicit AsciiValue(Handle<v8::Value> obj);
1240 ~AsciiValue();
1241 char* operator*() { return str_; }
1242 const char* operator*() const { return str_; }
1243 int length() const { return length_; }
1244 private:
1245 char* str_;
1246 int length_;
1247
1248 // Disallow copying and assigning.
1249 AsciiValue(const AsciiValue&);
1250 void operator=(const AsciiValue&);
1251 };
1252
1253 /**
1254 * Converts an object to a two-byte string.
1255 * If conversion to a string fails (eg. due to an exception in the toString()
1256 * method of the object) then the length() method returns 0 and the * operator
1257 * returns NULL.
1258 */
1259 class V8EXPORT Value {
1260 public:
1261 explicit Value(Handle<v8::Value> obj);
1262 ~Value();
1263 uint16_t* operator*() { return str_; }
1264 const uint16_t* operator*() const { return str_; }
1265 int length() const { return length_; }
1266 private:
1267 uint16_t* str_;
1268 int length_;
1269
1270 // Disallow copying and assigning.
1271 Value(const Value&);
1272 void operator=(const Value&);
1273 };
Steve Block3ce2e202009-11-05 08:53:23 +00001274
Steve Blocka7e24c12009-10-30 11:49:00 +00001275 private:
1276 void VerifyExternalStringResource(ExternalStringResource* val) const;
1277 static void CheckCast(v8::Value* obj);
1278};
1279
1280
1281/**
1282 * A JavaScript number value (ECMA-262, 4.3.20)
1283 */
1284class V8EXPORT Number : public Primitive {
1285 public:
1286 double Value() const;
1287 static Local<Number> New(double value);
1288 static inline Number* Cast(v8::Value* obj);
1289 private:
1290 Number();
1291 static void CheckCast(v8::Value* obj);
1292};
1293
1294
1295/**
1296 * A JavaScript value representing a signed integer.
1297 */
1298class V8EXPORT Integer : public Number {
1299 public:
1300 static Local<Integer> New(int32_t value);
Steve Block3ce2e202009-11-05 08:53:23 +00001301 static Local<Integer> NewFromUnsigned(uint32_t value);
Steve Blocka7e24c12009-10-30 11:49:00 +00001302 int64_t Value() const;
1303 static inline Integer* Cast(v8::Value* obj);
1304 private:
1305 Integer();
1306 static void CheckCast(v8::Value* obj);
1307};
1308
1309
1310/**
1311 * A JavaScript value representing a 32-bit signed integer.
1312 */
1313class V8EXPORT Int32 : public Integer {
1314 public:
1315 int32_t Value() const;
1316 private:
1317 Int32();
1318};
1319
1320
1321/**
1322 * A JavaScript value representing a 32-bit unsigned integer.
1323 */
1324class V8EXPORT Uint32 : public Integer {
1325 public:
1326 uint32_t Value() const;
1327 private:
1328 Uint32();
1329};
1330
1331
1332/**
1333 * An instance of the built-in Date constructor (ECMA-262, 15.9).
1334 */
1335class V8EXPORT Date : public Value {
1336 public:
1337 static Local<Value> New(double time);
1338
1339 /**
1340 * A specialization of Value::NumberValue that is more efficient
1341 * because we know the structure of this object.
1342 */
1343 double NumberValue() const;
1344
1345 static inline Date* Cast(v8::Value* obj);
1346 private:
1347 static void CheckCast(v8::Value* obj);
1348};
1349
1350
1351enum PropertyAttribute {
1352 None = 0,
1353 ReadOnly = 1 << 0,
1354 DontEnum = 1 << 1,
1355 DontDelete = 1 << 2
1356};
1357
Steve Block3ce2e202009-11-05 08:53:23 +00001358enum ExternalArrayType {
1359 kExternalByteArray = 1,
1360 kExternalUnsignedByteArray,
1361 kExternalShortArray,
1362 kExternalUnsignedShortArray,
1363 kExternalIntArray,
1364 kExternalUnsignedIntArray,
1365 kExternalFloatArray
1366};
1367
Steve Blocka7e24c12009-10-30 11:49:00 +00001368/**
Leon Clarkef7060e22010-06-03 12:02:55 +01001369 * Accessor[Getter|Setter] are used as callback functions when
1370 * setting|getting a particular property. See Object and ObjectTemplate's
1371 * method SetAccessor.
1372 */
1373typedef Handle<Value> (*AccessorGetter)(Local<String> property,
1374 const AccessorInfo& info);
1375
1376
1377typedef void (*AccessorSetter)(Local<String> property,
1378 Local<Value> value,
1379 const AccessorInfo& info);
1380
1381
1382/**
1383 * Access control specifications.
1384 *
1385 * Some accessors should be accessible across contexts. These
1386 * accessors have an explicit access control parameter which specifies
1387 * the kind of cross-context access that should be allowed.
1388 *
1389 * Additionally, for security, accessors can prohibit overwriting by
1390 * accessors defined in JavaScript. For objects that have such
1391 * accessors either locally or in their prototype chain it is not
1392 * possible to overwrite the accessor by using __defineGetter__ or
1393 * __defineSetter__ from JavaScript code.
1394 */
1395enum AccessControl {
1396 DEFAULT = 0,
1397 ALL_CAN_READ = 1,
1398 ALL_CAN_WRITE = 1 << 1,
1399 PROHIBITS_OVERWRITING = 1 << 2
1400};
1401
1402
1403/**
Steve Blocka7e24c12009-10-30 11:49:00 +00001404 * A JavaScript object (ECMA-262, 4.3.3)
1405 */
1406class V8EXPORT Object : public Value {
1407 public:
1408 bool Set(Handle<Value> key,
1409 Handle<Value> value,
1410 PropertyAttribute attribs = None);
1411
Steve Block6ded16b2010-05-10 14:33:55 +01001412 bool Set(uint32_t index,
1413 Handle<Value> value);
1414
Steve Blocka7e24c12009-10-30 11:49:00 +00001415 // Sets a local property on this object bypassing interceptors and
1416 // overriding accessors or read-only properties.
1417 //
1418 // Note that if the object has an interceptor the property will be set
1419 // locally, but since the interceptor takes precedence the local property
1420 // will only be returned if the interceptor doesn't return a value.
1421 //
1422 // Note also that this only works for named properties.
1423 bool ForceSet(Handle<Value> key,
1424 Handle<Value> value,
1425 PropertyAttribute attribs = None);
1426
1427 Local<Value> Get(Handle<Value> key);
1428
Steve Block6ded16b2010-05-10 14:33:55 +01001429 Local<Value> Get(uint32_t index);
1430
Steve Blocka7e24c12009-10-30 11:49:00 +00001431 // TODO(1245389): Replace the type-specific versions of these
1432 // functions with generic ones that accept a Handle<Value> key.
1433 bool Has(Handle<String> key);
1434
1435 bool Delete(Handle<String> key);
1436
1437 // Delete a property on this object bypassing interceptors and
1438 // ignoring dont-delete attributes.
1439 bool ForceDelete(Handle<Value> key);
1440
1441 bool Has(uint32_t index);
1442
1443 bool Delete(uint32_t index);
1444
Leon Clarkef7060e22010-06-03 12:02:55 +01001445 bool SetAccessor(Handle<String> name,
1446 AccessorGetter getter,
1447 AccessorSetter setter = 0,
1448 Handle<Value> data = Handle<Value>(),
1449 AccessControl settings = DEFAULT,
1450 PropertyAttribute attribute = None);
1451
Steve Blocka7e24c12009-10-30 11:49:00 +00001452 /**
1453 * Returns an array containing the names of the enumerable properties
1454 * of this object, including properties from prototype objects. The
1455 * array returned by this method contains the same values as would
1456 * be enumerated by a for-in statement over this object.
1457 */
1458 Local<Array> GetPropertyNames();
1459
1460 /**
1461 * Get the prototype object. This does not skip objects marked to
1462 * be skipped by __proto__ and it does not consult the security
1463 * handler.
1464 */
1465 Local<Value> GetPrototype();
1466
1467 /**
Andrei Popescu402d9372010-02-26 13:31:12 +00001468 * Set the prototype object. This does not skip objects marked to
1469 * be skipped by __proto__ and it does not consult the security
1470 * handler.
1471 */
1472 bool SetPrototype(Handle<Value> prototype);
1473
1474 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00001475 * Finds an instance of the given function template in the prototype
1476 * chain.
1477 */
1478 Local<Object> FindInstanceInPrototypeChain(Handle<FunctionTemplate> tmpl);
1479
1480 /**
1481 * Call builtin Object.prototype.toString on this object.
1482 * This is different from Value::ToString() that may call
1483 * user-defined toString function. This one does not.
1484 */
1485 Local<String> ObjectProtoToString();
1486
1487 /** Gets the number of internal fields for this Object. */
1488 int InternalFieldCount();
1489 /** Gets the value in an internal field. */
1490 inline Local<Value> GetInternalField(int index);
1491 /** Sets the value in an internal field. */
1492 void SetInternalField(int index, Handle<Value> value);
1493
1494 /** Gets a native pointer from an internal field. */
1495 inline void* GetPointerFromInternalField(int index);
Steve Block3ce2e202009-11-05 08:53:23 +00001496
Steve Blocka7e24c12009-10-30 11:49:00 +00001497 /** Sets a native pointer in an internal field. */
1498 void SetPointerInInternalField(int index, void* value);
1499
1500 // Testers for local properties.
1501 bool HasRealNamedProperty(Handle<String> key);
1502 bool HasRealIndexedProperty(uint32_t index);
1503 bool HasRealNamedCallbackProperty(Handle<String> key);
1504
1505 /**
1506 * If result.IsEmpty() no real property was located in the prototype chain.
1507 * This means interceptors in the prototype chain are not called.
1508 */
1509 Local<Value> GetRealNamedPropertyInPrototypeChain(Handle<String> key);
1510
1511 /**
1512 * If result.IsEmpty() no real property was located on the object or
1513 * in the prototype chain.
1514 * This means interceptors in the prototype chain are not called.
1515 */
1516 Local<Value> GetRealNamedProperty(Handle<String> key);
1517
1518 /** Tests for a named lookup interceptor.*/
1519 bool HasNamedLookupInterceptor();
1520
1521 /** Tests for an index lookup interceptor.*/
1522 bool HasIndexedLookupInterceptor();
1523
1524 /**
1525 * Turns on access check on the object if the object is an instance of
1526 * a template that has access check callbacks. If an object has no
1527 * access check info, the object cannot be accessed by anyone.
1528 */
1529 void TurnOnAccessCheck();
1530
1531 /**
1532 * Returns the identity hash for this object. The current implemenation uses
1533 * a hidden property on the object to store the identity hash.
1534 *
1535 * The return value will never be 0. Also, it is not guaranteed to be
1536 * unique.
1537 */
1538 int GetIdentityHash();
1539
1540 /**
1541 * Access hidden properties on JavaScript objects. These properties are
1542 * hidden from the executing JavaScript and only accessible through the V8
1543 * C++ API. Hidden properties introduced by V8 internally (for example the
1544 * identity hash) are prefixed with "v8::".
1545 */
1546 bool SetHiddenValue(Handle<String> key, Handle<Value> value);
1547 Local<Value> GetHiddenValue(Handle<String> key);
1548 bool DeleteHiddenValue(Handle<String> key);
Steve Block3ce2e202009-11-05 08:53:23 +00001549
Steve Blocka7e24c12009-10-30 11:49:00 +00001550 /**
1551 * Returns true if this is an instance of an api function (one
1552 * created from a function created from a function template) and has
1553 * been modified since it was created. Note that this method is
1554 * conservative and may return true for objects that haven't actually
1555 * been modified.
1556 */
1557 bool IsDirty();
1558
1559 /**
1560 * Clone this object with a fast but shallow copy. Values will point
1561 * to the same values as the original object.
1562 */
1563 Local<Object> Clone();
1564
1565 /**
1566 * Set the backing store of the indexed properties to be managed by the
1567 * embedding layer. Access to the indexed properties will follow the rules
1568 * spelled out in CanvasPixelArray.
1569 * Note: The embedding program still owns the data and needs to ensure that
1570 * the backing store is preserved while V8 has a reference.
1571 */
1572 void SetIndexedPropertiesToPixelData(uint8_t* data, int length);
Kristian Monsen9dcf7e22010-06-28 14:14:28 +01001573 bool HasIndexedPropertiesInPixelData();
1574 uint8_t* GetIndexedPropertiesPixelData();
1575 int GetIndexedPropertiesPixelDataLength();
Steve Blocka7e24c12009-10-30 11:49:00 +00001576
Steve Block3ce2e202009-11-05 08:53:23 +00001577 /**
1578 * Set the backing store of the indexed properties to be managed by the
1579 * embedding layer. Access to the indexed properties will follow the rules
1580 * spelled out for the CanvasArray subtypes in the WebGL specification.
1581 * Note: The embedding program still owns the data and needs to ensure that
1582 * the backing store is preserved while V8 has a reference.
1583 */
1584 void SetIndexedPropertiesToExternalArrayData(void* data,
1585 ExternalArrayType array_type,
1586 int number_of_elements);
Kristian Monsen9dcf7e22010-06-28 14:14:28 +01001587 bool HasIndexedPropertiesInExternalArrayData();
1588 void* GetIndexedPropertiesExternalArrayData();
1589 ExternalArrayType GetIndexedPropertiesExternalArrayDataType();
1590 int GetIndexedPropertiesExternalArrayDataLength();
Steve Block3ce2e202009-11-05 08:53:23 +00001591
Steve Blocka7e24c12009-10-30 11:49:00 +00001592 static Local<Object> New();
1593 static inline Object* Cast(Value* obj);
1594 private:
1595 Object();
1596 static void CheckCast(Value* obj);
1597 Local<Value> CheckedGetInternalField(int index);
Steve Block3ce2e202009-11-05 08:53:23 +00001598 void* SlowGetPointerFromInternalField(int index);
Steve Blocka7e24c12009-10-30 11:49:00 +00001599
1600 /**
1601 * If quick access to the internal field is possible this method
Steve Block3ce2e202009-11-05 08:53:23 +00001602 * returns the value. Otherwise an empty handle is returned.
Steve Blocka7e24c12009-10-30 11:49:00 +00001603 */
1604 inline Local<Value> UncheckedGetInternalField(int index);
1605};
1606
1607
1608/**
1609 * An instance of the built-in array constructor (ECMA-262, 15.4.2).
1610 */
1611class V8EXPORT Array : public Object {
1612 public:
1613 uint32_t Length() const;
1614
1615 /**
1616 * Clones an element at index |index|. Returns an empty
1617 * handle if cloning fails (for any reason).
1618 */
1619 Local<Object> CloneElementAt(uint32_t index);
1620
1621 static Local<Array> New(int length = 0);
1622 static inline Array* Cast(Value* obj);
1623 private:
1624 Array();
1625 static void CheckCast(Value* obj);
1626};
1627
1628
1629/**
1630 * A JavaScript function object (ECMA-262, 15.3).
1631 */
1632class V8EXPORT Function : public Object {
1633 public:
1634 Local<Object> NewInstance() const;
1635 Local<Object> NewInstance(int argc, Handle<Value> argv[]) const;
1636 Local<Value> Call(Handle<Object> recv, int argc, Handle<Value> argv[]);
1637 void SetName(Handle<String> name);
1638 Handle<Value> GetName() const;
Andrei Popescu402d9372010-02-26 13:31:12 +00001639
1640 /**
1641 * Returns zero based line number of function body and
1642 * kLineOffsetNotFound if no information available.
1643 */
1644 int GetScriptLineNumber() const;
1645 ScriptOrigin GetScriptOrigin() const;
Steve Blocka7e24c12009-10-30 11:49:00 +00001646 static inline Function* Cast(Value* obj);
Andrei Popescu402d9372010-02-26 13:31:12 +00001647 static const int kLineOffsetNotFound;
Steve Blocka7e24c12009-10-30 11:49:00 +00001648 private:
1649 Function();
1650 static void CheckCast(Value* obj);
1651};
1652
1653
1654/**
1655 * A JavaScript value that wraps a C++ void*. This type of value is
1656 * mainly used to associate C++ data structures with JavaScript
1657 * objects.
1658 *
1659 * The Wrap function V8 will return the most optimal Value object wrapping the
1660 * C++ void*. The type of the value is not guaranteed to be an External object
1661 * and no assumptions about its type should be made. To access the wrapped
1662 * value Unwrap should be used, all other operations on that object will lead
1663 * to unpredictable results.
1664 */
1665class V8EXPORT External : public Value {
1666 public:
1667 static Local<Value> Wrap(void* data);
1668 static inline void* Unwrap(Handle<Value> obj);
1669
1670 static Local<External> New(void* value);
1671 static inline External* Cast(Value* obj);
1672 void* Value() const;
1673 private:
1674 External();
1675 static void CheckCast(v8::Value* obj);
1676 static inline void* QuickUnwrap(Handle<v8::Value> obj);
1677 static void* FullUnwrap(Handle<v8::Value> obj);
1678};
1679
1680
1681// --- T e m p l a t e s ---
1682
1683
1684/**
1685 * The superclass of object and function templates.
1686 */
1687class V8EXPORT Template : public Data {
1688 public:
1689 /** Adds a property to each instance created by this template.*/
1690 void Set(Handle<String> name, Handle<Data> value,
1691 PropertyAttribute attributes = None);
1692 inline void Set(const char* name, Handle<Data> value);
1693 private:
1694 Template();
1695
1696 friend class ObjectTemplate;
1697 friend class FunctionTemplate;
1698};
1699
1700
1701/**
1702 * The argument information given to function call callbacks. This
1703 * class provides access to information about the context of the call,
1704 * including the receiver, the number and values of arguments, and
1705 * the holder of the function.
1706 */
1707class V8EXPORT Arguments {
1708 public:
1709 inline int Length() const;
1710 inline Local<Value> operator[](int i) const;
1711 inline Local<Function> Callee() const;
1712 inline Local<Object> This() const;
1713 inline Local<Object> Holder() const;
1714 inline bool IsConstructCall() const;
1715 inline Local<Value> Data() const;
1716 private:
1717 Arguments();
1718 friend class ImplementationUtilities;
1719 inline Arguments(Local<Value> data,
1720 Local<Object> holder,
1721 Local<Function> callee,
1722 bool is_construct_call,
1723 void** values, int length);
1724 Local<Value> data_;
1725 Local<Object> holder_;
1726 Local<Function> callee_;
1727 bool is_construct_call_;
1728 void** values_;
1729 int length_;
1730};
1731
1732
1733/**
1734 * The information passed to an accessor callback about the context
1735 * of the property access.
1736 */
1737class V8EXPORT AccessorInfo {
1738 public:
1739 inline AccessorInfo(internal::Object** args)
1740 : args_(args) { }
1741 inline Local<Value> Data() const;
1742 inline Local<Object> This() const;
1743 inline Local<Object> Holder() const;
1744 private:
1745 internal::Object** args_;
1746};
1747
1748
1749typedef Handle<Value> (*InvocationCallback)(const Arguments& args);
1750
1751typedef int (*LookupCallback)(Local<Object> self, Local<String> name);
1752
1753/**
Steve Blocka7e24c12009-10-30 11:49:00 +00001754 * NamedProperty[Getter|Setter] are used as interceptors on object.
1755 * See ObjectTemplate::SetNamedPropertyHandler.
1756 */
1757typedef Handle<Value> (*NamedPropertyGetter)(Local<String> property,
1758 const AccessorInfo& info);
1759
1760
1761/**
1762 * Returns the value if the setter intercepts the request.
1763 * Otherwise, returns an empty handle.
1764 */
1765typedef Handle<Value> (*NamedPropertySetter)(Local<String> property,
1766 Local<Value> value,
1767 const AccessorInfo& info);
1768
Steve Blocka7e24c12009-10-30 11:49:00 +00001769/**
1770 * Returns a non-empty handle if the interceptor intercepts the request.
Kristian Monsen9dcf7e22010-06-28 14:14:28 +01001771 * The result is an integer encoding property attributes (like v8::None,
1772 * v8::DontEnum, etc.)
Steve Blocka7e24c12009-10-30 11:49:00 +00001773 */
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01001774typedef Handle<Integer> (*NamedPropertyQuery)(Local<String> property,
1775 const AccessorInfo& info);
Steve Blocka7e24c12009-10-30 11:49:00 +00001776
1777
1778/**
1779 * Returns a non-empty handle if the deleter intercepts the request.
1780 * The return value is true if the property could be deleted and false
1781 * otherwise.
1782 */
1783typedef Handle<Boolean> (*NamedPropertyDeleter)(Local<String> property,
1784 const AccessorInfo& info);
1785
1786/**
1787 * Returns an array containing the names of the properties the named
1788 * property getter intercepts.
1789 */
1790typedef Handle<Array> (*NamedPropertyEnumerator)(const AccessorInfo& info);
1791
1792
1793/**
1794 * Returns the value of the property if the getter intercepts the
1795 * request. Otherwise, returns an empty handle.
1796 */
1797typedef Handle<Value> (*IndexedPropertyGetter)(uint32_t index,
1798 const AccessorInfo& info);
1799
1800
1801/**
1802 * Returns the value if the setter intercepts the request.
1803 * Otherwise, returns an empty handle.
1804 */
1805typedef Handle<Value> (*IndexedPropertySetter)(uint32_t index,
1806 Local<Value> value,
1807 const AccessorInfo& info);
1808
1809
1810/**
1811 * Returns a non-empty handle if the interceptor intercepts the request.
1812 * The result is true if the property exists and false otherwise.
1813 */
1814typedef Handle<Boolean> (*IndexedPropertyQuery)(uint32_t index,
1815 const AccessorInfo& info);
1816
1817/**
1818 * Returns a non-empty handle if the deleter intercepts the request.
1819 * The return value is true if the property could be deleted and false
1820 * otherwise.
1821 */
1822typedef Handle<Boolean> (*IndexedPropertyDeleter)(uint32_t index,
1823 const AccessorInfo& info);
1824
1825/**
1826 * Returns an array containing the indices of the properties the
1827 * indexed property getter intercepts.
1828 */
1829typedef Handle<Array> (*IndexedPropertyEnumerator)(const AccessorInfo& info);
1830
1831
1832/**
Steve Blocka7e24c12009-10-30 11:49:00 +00001833 * Access type specification.
1834 */
1835enum AccessType {
1836 ACCESS_GET,
1837 ACCESS_SET,
1838 ACCESS_HAS,
1839 ACCESS_DELETE,
1840 ACCESS_KEYS
1841};
1842
1843
1844/**
1845 * Returns true if cross-context access should be allowed to the named
1846 * property with the given key on the host object.
1847 */
1848typedef bool (*NamedSecurityCallback)(Local<Object> host,
1849 Local<Value> key,
1850 AccessType type,
1851 Local<Value> data);
1852
1853
1854/**
1855 * Returns true if cross-context access should be allowed to the indexed
1856 * property with the given index on the host object.
1857 */
1858typedef bool (*IndexedSecurityCallback)(Local<Object> host,
1859 uint32_t index,
1860 AccessType type,
1861 Local<Value> data);
1862
1863
1864/**
1865 * A FunctionTemplate is used to create functions at runtime. There
1866 * can only be one function created from a FunctionTemplate in a
1867 * context. The lifetime of the created function is equal to the
1868 * lifetime of the context. So in case the embedder needs to create
1869 * temporary functions that can be collected using Scripts is
1870 * preferred.
1871 *
1872 * A FunctionTemplate can have properties, these properties are added to the
1873 * function object when it is created.
1874 *
1875 * A FunctionTemplate has a corresponding instance template which is
1876 * used to create object instances when the function is used as a
1877 * constructor. Properties added to the instance template are added to
1878 * each object instance.
1879 *
1880 * A FunctionTemplate can have a prototype template. The prototype template
1881 * is used to create the prototype object of the function.
1882 *
1883 * The following example shows how to use a FunctionTemplate:
1884 *
1885 * \code
1886 * v8::Local<v8::FunctionTemplate> t = v8::FunctionTemplate::New();
1887 * t->Set("func_property", v8::Number::New(1));
1888 *
1889 * v8::Local<v8::Template> proto_t = t->PrototypeTemplate();
1890 * proto_t->Set("proto_method", v8::FunctionTemplate::New(InvokeCallback));
1891 * proto_t->Set("proto_const", v8::Number::New(2));
1892 *
1893 * v8::Local<v8::ObjectTemplate> instance_t = t->InstanceTemplate();
1894 * instance_t->SetAccessor("instance_accessor", InstanceAccessorCallback);
1895 * instance_t->SetNamedPropertyHandler(PropertyHandlerCallback, ...);
1896 * instance_t->Set("instance_property", Number::New(3));
1897 *
1898 * v8::Local<v8::Function> function = t->GetFunction();
1899 * v8::Local<v8::Object> instance = function->NewInstance();
1900 * \endcode
1901 *
1902 * Let's use "function" as the JS variable name of the function object
1903 * and "instance" for the instance object created above. The function
1904 * and the instance will have the following properties:
1905 *
1906 * \code
1907 * func_property in function == true;
1908 * function.func_property == 1;
1909 *
1910 * function.prototype.proto_method() invokes 'InvokeCallback'
1911 * function.prototype.proto_const == 2;
1912 *
1913 * instance instanceof function == true;
1914 * instance.instance_accessor calls 'InstanceAccessorCallback'
1915 * instance.instance_property == 3;
1916 * \endcode
1917 *
1918 * A FunctionTemplate can inherit from another one by calling the
1919 * FunctionTemplate::Inherit method. The following graph illustrates
1920 * the semantics of inheritance:
1921 *
1922 * \code
1923 * FunctionTemplate Parent -> Parent() . prototype -> { }
1924 * ^ ^
1925 * | Inherit(Parent) | .__proto__
1926 * | |
1927 * FunctionTemplate Child -> Child() . prototype -> { }
1928 * \endcode
1929 *
1930 * A FunctionTemplate 'Child' inherits from 'Parent', the prototype
1931 * object of the Child() function has __proto__ pointing to the
1932 * Parent() function's prototype object. An instance of the Child
1933 * function has all properties on Parent's instance templates.
1934 *
1935 * Let Parent be the FunctionTemplate initialized in the previous
1936 * section and create a Child FunctionTemplate by:
1937 *
1938 * \code
1939 * Local<FunctionTemplate> parent = t;
1940 * Local<FunctionTemplate> child = FunctionTemplate::New();
1941 * child->Inherit(parent);
1942 *
1943 * Local<Function> child_function = child->GetFunction();
1944 * Local<Object> child_instance = child_function->NewInstance();
1945 * \endcode
1946 *
1947 * The Child function and Child instance will have the following
1948 * properties:
1949 *
1950 * \code
1951 * child_func.prototype.__proto__ == function.prototype;
1952 * child_instance.instance_accessor calls 'InstanceAccessorCallback'
1953 * child_instance.instance_property == 3;
1954 * \endcode
1955 */
1956class V8EXPORT FunctionTemplate : public Template {
1957 public:
1958 /** Creates a function template.*/
1959 static Local<FunctionTemplate> New(
1960 InvocationCallback callback = 0,
1961 Handle<Value> data = Handle<Value>(),
1962 Handle<Signature> signature = Handle<Signature>());
1963 /** Returns the unique function instance in the current execution context.*/
1964 Local<Function> GetFunction();
1965
1966 /**
1967 * Set the call-handler callback for a FunctionTemplate. This
1968 * callback is called whenever the function created from this
1969 * FunctionTemplate is called.
1970 */
1971 void SetCallHandler(InvocationCallback callback,
1972 Handle<Value> data = Handle<Value>());
1973
1974 /** Get the InstanceTemplate. */
1975 Local<ObjectTemplate> InstanceTemplate();
1976
1977 /** Causes the function template to inherit from a parent function template.*/
1978 void Inherit(Handle<FunctionTemplate> parent);
1979
1980 /**
1981 * A PrototypeTemplate is the template used to create the prototype object
1982 * of the function created by this template.
1983 */
1984 Local<ObjectTemplate> PrototypeTemplate();
1985
1986
1987 /**
1988 * Set the class name of the FunctionTemplate. This is used for
1989 * printing objects created with the function created from the
1990 * FunctionTemplate as its constructor.
1991 */
1992 void SetClassName(Handle<String> name);
1993
1994 /**
1995 * Determines whether the __proto__ accessor ignores instances of
1996 * the function template. If instances of the function template are
1997 * ignored, __proto__ skips all instances and instead returns the
1998 * next object in the prototype chain.
1999 *
2000 * Call with a value of true to make the __proto__ accessor ignore
2001 * instances of the function template. Call with a value of false
2002 * to make the __proto__ accessor not ignore instances of the
2003 * function template. By default, instances of a function template
2004 * are not ignored.
2005 */
2006 void SetHiddenPrototype(bool value);
2007
2008 /**
2009 * Returns true if the given object is an instance of this function
2010 * template.
2011 */
2012 bool HasInstance(Handle<Value> object);
2013
2014 private:
2015 FunctionTemplate();
2016 void AddInstancePropertyAccessor(Handle<String> name,
2017 AccessorGetter getter,
2018 AccessorSetter setter,
2019 Handle<Value> data,
2020 AccessControl settings,
2021 PropertyAttribute attributes);
2022 void SetNamedInstancePropertyHandler(NamedPropertyGetter getter,
2023 NamedPropertySetter setter,
2024 NamedPropertyQuery query,
2025 NamedPropertyDeleter remover,
2026 NamedPropertyEnumerator enumerator,
Kristian Monsen9dcf7e22010-06-28 14:14:28 +01002027 Handle<Value> data);
Steve Blocka7e24c12009-10-30 11:49:00 +00002028 void SetIndexedInstancePropertyHandler(IndexedPropertyGetter getter,
2029 IndexedPropertySetter setter,
2030 IndexedPropertyQuery query,
2031 IndexedPropertyDeleter remover,
2032 IndexedPropertyEnumerator enumerator,
2033 Handle<Value> data);
2034 void SetInstanceCallAsFunctionHandler(InvocationCallback callback,
2035 Handle<Value> data);
2036
2037 friend class Context;
2038 friend class ObjectTemplate;
2039};
2040
2041
2042/**
2043 * An ObjectTemplate is used to create objects at runtime.
2044 *
2045 * Properties added to an ObjectTemplate are added to each object
2046 * created from the ObjectTemplate.
2047 */
2048class V8EXPORT ObjectTemplate : public Template {
2049 public:
2050 /** Creates an ObjectTemplate. */
2051 static Local<ObjectTemplate> New();
2052
2053 /** Creates a new instance of this template.*/
2054 Local<Object> NewInstance();
2055
2056 /**
2057 * Sets an accessor on the object template.
2058 *
2059 * Whenever the property with the given name is accessed on objects
2060 * created from this ObjectTemplate the getter and setter callbacks
2061 * are called instead of getting and setting the property directly
2062 * on the JavaScript object.
2063 *
2064 * \param name The name of the property for which an accessor is added.
2065 * \param getter The callback to invoke when getting the property.
2066 * \param setter The callback to invoke when setting the property.
2067 * \param data A piece of data that will be passed to the getter and setter
2068 * callbacks whenever they are invoked.
2069 * \param settings Access control settings for the accessor. This is a bit
2070 * field consisting of one of more of
2071 * DEFAULT = 0, ALL_CAN_READ = 1, or ALL_CAN_WRITE = 2.
2072 * The default is to not allow cross-context access.
2073 * ALL_CAN_READ means that all cross-context reads are allowed.
2074 * ALL_CAN_WRITE means that all cross-context writes are allowed.
2075 * The combination ALL_CAN_READ | ALL_CAN_WRITE can be used to allow all
2076 * cross-context access.
2077 * \param attribute The attributes of the property for which an accessor
2078 * is added.
2079 */
2080 void SetAccessor(Handle<String> name,
2081 AccessorGetter getter,
2082 AccessorSetter setter = 0,
2083 Handle<Value> data = Handle<Value>(),
2084 AccessControl settings = DEFAULT,
2085 PropertyAttribute attribute = None);
2086
2087 /**
2088 * Sets a named property handler on the object template.
2089 *
2090 * Whenever a named property is accessed on objects created from
2091 * this object template, the provided callback is invoked instead of
2092 * accessing the property directly on the JavaScript object.
2093 *
2094 * \param getter The callback to invoke when getting a property.
2095 * \param setter The callback to invoke when setting a property.
Kristian Monsen9dcf7e22010-06-28 14:14:28 +01002096 * \param query The callback to invoke to check if a property is present,
2097 * and if present, get its attributes.
Steve Blocka7e24c12009-10-30 11:49:00 +00002098 * \param deleter The callback to invoke when deleting a property.
2099 * \param enumerator The callback to invoke to enumerate all the named
2100 * properties of an object.
2101 * \param data A piece of data that will be passed to the callbacks
2102 * whenever they are invoked.
2103 */
2104 void SetNamedPropertyHandler(NamedPropertyGetter getter,
2105 NamedPropertySetter setter = 0,
2106 NamedPropertyQuery query = 0,
2107 NamedPropertyDeleter deleter = 0,
2108 NamedPropertyEnumerator enumerator = 0,
Kristian Monsen9dcf7e22010-06-28 14:14:28 +01002109 Handle<Value> data = Handle<Value>());
Steve Blocka7e24c12009-10-30 11:49:00 +00002110
2111 /**
2112 * Sets an indexed property handler on the object template.
2113 *
2114 * Whenever an indexed property is accessed on objects created from
2115 * this object template, the provided callback is invoked instead of
2116 * accessing the property directly on the JavaScript object.
2117 *
2118 * \param getter The callback to invoke when getting a property.
2119 * \param setter The callback to invoke when setting a property.
2120 * \param query The callback to invoke to check is an object has a property.
2121 * \param deleter The callback to invoke when deleting a property.
2122 * \param enumerator The callback to invoke to enumerate all the indexed
2123 * properties of an object.
2124 * \param data A piece of data that will be passed to the callbacks
2125 * whenever they are invoked.
2126 */
2127 void SetIndexedPropertyHandler(IndexedPropertyGetter getter,
2128 IndexedPropertySetter setter = 0,
2129 IndexedPropertyQuery query = 0,
2130 IndexedPropertyDeleter deleter = 0,
2131 IndexedPropertyEnumerator enumerator = 0,
2132 Handle<Value> data = Handle<Value>());
2133 /**
2134 * Sets the callback to be used when calling instances created from
2135 * this template as a function. If no callback is set, instances
2136 * behave like normal JavaScript objects that cannot be called as a
2137 * function.
2138 */
2139 void SetCallAsFunctionHandler(InvocationCallback callback,
2140 Handle<Value> data = Handle<Value>());
2141
2142 /**
2143 * Mark object instances of the template as undetectable.
2144 *
2145 * In many ways, undetectable objects behave as though they are not
2146 * there. They behave like 'undefined' in conditionals and when
2147 * printed. However, properties can be accessed and called as on
2148 * normal objects.
2149 */
2150 void MarkAsUndetectable();
2151
2152 /**
2153 * Sets access check callbacks on the object template.
2154 *
2155 * When accessing properties on instances of this object template,
2156 * the access check callback will be called to determine whether or
2157 * not to allow cross-context access to the properties.
2158 * The last parameter specifies whether access checks are turned
2159 * on by default on instances. If access checks are off by default,
2160 * they can be turned on on individual instances by calling
2161 * Object::TurnOnAccessCheck().
2162 */
2163 void SetAccessCheckCallbacks(NamedSecurityCallback named_handler,
2164 IndexedSecurityCallback indexed_handler,
2165 Handle<Value> data = Handle<Value>(),
2166 bool turned_on_by_default = true);
2167
2168 /**
2169 * Gets the number of internal fields for objects generated from
2170 * this template.
2171 */
2172 int InternalFieldCount();
2173
2174 /**
2175 * Sets the number of internal fields for objects generated from
2176 * this template.
2177 */
2178 void SetInternalFieldCount(int value);
2179
2180 private:
2181 ObjectTemplate();
2182 static Local<ObjectTemplate> New(Handle<FunctionTemplate> constructor);
2183 friend class FunctionTemplate;
2184};
2185
2186
2187/**
2188 * A Signature specifies which receivers and arguments a function can
2189 * legally be called with.
2190 */
2191class V8EXPORT Signature : public Data {
2192 public:
2193 static Local<Signature> New(Handle<FunctionTemplate> receiver =
2194 Handle<FunctionTemplate>(),
2195 int argc = 0,
2196 Handle<FunctionTemplate> argv[] = 0);
2197 private:
2198 Signature();
2199};
2200
2201
2202/**
2203 * A utility for determining the type of objects based on the template
2204 * they were constructed from.
2205 */
2206class V8EXPORT TypeSwitch : public Data {
2207 public:
2208 static Local<TypeSwitch> New(Handle<FunctionTemplate> type);
2209 static Local<TypeSwitch> New(int argc, Handle<FunctionTemplate> types[]);
2210 int match(Handle<Value> value);
2211 private:
2212 TypeSwitch();
2213};
2214
2215
2216// --- E x t e n s i o n s ---
2217
2218
2219/**
2220 * Ignore
2221 */
2222class V8EXPORT Extension { // NOLINT
2223 public:
2224 Extension(const char* name,
2225 const char* source = 0,
2226 int dep_count = 0,
2227 const char** deps = 0);
2228 virtual ~Extension() { }
2229 virtual v8::Handle<v8::FunctionTemplate>
2230 GetNativeFunction(v8::Handle<v8::String> name) {
2231 return v8::Handle<v8::FunctionTemplate>();
2232 }
2233
2234 const char* name() { return name_; }
2235 const char* source() { return source_; }
2236 int dependency_count() { return dep_count_; }
2237 const char** dependencies() { return deps_; }
2238 void set_auto_enable(bool value) { auto_enable_ = value; }
2239 bool auto_enable() { return auto_enable_; }
2240
2241 private:
2242 const char* name_;
2243 const char* source_;
2244 int dep_count_;
2245 const char** deps_;
2246 bool auto_enable_;
2247
2248 // Disallow copying and assigning.
2249 Extension(const Extension&);
2250 void operator=(const Extension&);
2251};
2252
2253
2254void V8EXPORT RegisterExtension(Extension* extension);
2255
2256
2257/**
2258 * Ignore
2259 */
2260class V8EXPORT DeclareExtension {
2261 public:
2262 inline DeclareExtension(Extension* extension) {
2263 RegisterExtension(extension);
2264 }
2265};
2266
2267
2268// --- S t a t i c s ---
2269
2270
2271Handle<Primitive> V8EXPORT Undefined();
2272Handle<Primitive> V8EXPORT Null();
2273Handle<Boolean> V8EXPORT True();
2274Handle<Boolean> V8EXPORT False();
2275
2276
2277/**
2278 * A set of constraints that specifies the limits of the runtime's memory use.
2279 * You must set the heap size before initializing the VM - the size cannot be
2280 * adjusted after the VM is initialized.
2281 *
2282 * If you are using threads then you should hold the V8::Locker lock while
2283 * setting the stack limit and you must set a non-default stack limit separately
2284 * for each thread.
2285 */
2286class V8EXPORT ResourceConstraints {
2287 public:
2288 ResourceConstraints();
2289 int max_young_space_size() const { return max_young_space_size_; }
2290 void set_max_young_space_size(int value) { max_young_space_size_ = value; }
2291 int max_old_space_size() const { return max_old_space_size_; }
2292 void set_max_old_space_size(int value) { max_old_space_size_ = value; }
2293 uint32_t* stack_limit() const { return stack_limit_; }
2294 // Sets an address beyond which the VM's stack may not grow.
2295 void set_stack_limit(uint32_t* value) { stack_limit_ = value; }
2296 private:
2297 int max_young_space_size_;
2298 int max_old_space_size_;
2299 uint32_t* stack_limit_;
2300};
2301
2302
Kristian Monsen25f61362010-05-21 11:50:48 +01002303bool V8EXPORT SetResourceConstraints(ResourceConstraints* constraints);
Steve Blocka7e24c12009-10-30 11:49:00 +00002304
2305
2306// --- E x c e p t i o n s ---
2307
2308
2309typedef void (*FatalErrorCallback)(const char* location, const char* message);
2310
2311
2312typedef void (*MessageCallback)(Handle<Message> message, Handle<Value> data);
2313
2314
2315/**
2316 * Schedules an exception to be thrown when returning to JavaScript. When an
2317 * exception has been scheduled it is illegal to invoke any JavaScript
2318 * operation; the caller must return immediately and only after the exception
2319 * has been handled does it become legal to invoke JavaScript operations.
2320 */
2321Handle<Value> V8EXPORT ThrowException(Handle<Value> exception);
2322
2323/**
2324 * Create new error objects by calling the corresponding error object
2325 * constructor with the message.
2326 */
2327class V8EXPORT Exception {
2328 public:
2329 static Local<Value> RangeError(Handle<String> message);
2330 static Local<Value> ReferenceError(Handle<String> message);
2331 static Local<Value> SyntaxError(Handle<String> message);
2332 static Local<Value> TypeError(Handle<String> message);
2333 static Local<Value> Error(Handle<String> message);
2334};
2335
2336
2337// --- C o u n t e r s C a l l b a c k s ---
2338
2339typedef int* (*CounterLookupCallback)(const char* name);
2340
2341typedef void* (*CreateHistogramCallback)(const char* name,
2342 int min,
2343 int max,
2344 size_t buckets);
2345
2346typedef void (*AddHistogramSampleCallback)(void* histogram, int sample);
2347
2348// --- F a i l e d A c c e s s C h e c k C a l l b a c k ---
2349typedef void (*FailedAccessCheckCallback)(Local<Object> target,
2350 AccessType type,
2351 Local<Value> data);
2352
2353// --- G a r b a g e C o l l e c t i o n C a l l b a c k s
2354
2355/**
Steve Block6ded16b2010-05-10 14:33:55 +01002356 * Applications can register callback functions which will be called
2357 * before and after a garbage collection. Allocations are not
2358 * allowed in the callback functions, you therefore cannot manipulate
Steve Blocka7e24c12009-10-30 11:49:00 +00002359 * objects (set or delete properties for example) since it is possible
2360 * such operations will result in the allocation of objects.
2361 */
Steve Block6ded16b2010-05-10 14:33:55 +01002362enum GCType {
2363 kGCTypeScavenge = 1 << 0,
2364 kGCTypeMarkSweepCompact = 1 << 1,
2365 kGCTypeAll = kGCTypeScavenge | kGCTypeMarkSweepCompact
2366};
2367
2368enum GCCallbackFlags {
2369 kNoGCCallbackFlags = 0,
2370 kGCCallbackFlagCompacted = 1 << 0
2371};
2372
2373typedef void (*GCPrologueCallback)(GCType type, GCCallbackFlags flags);
2374typedef void (*GCEpilogueCallback)(GCType type, GCCallbackFlags flags);
2375
Steve Blocka7e24c12009-10-30 11:49:00 +00002376typedef void (*GCCallback)();
2377
2378
Steve Blocka7e24c12009-10-30 11:49:00 +00002379/**
2380 * Profiler modules.
2381 *
2382 * In V8, profiler consists of several modules: CPU profiler, and different
2383 * kinds of heap profiling. Each can be turned on / off independently.
2384 * When PROFILER_MODULE_HEAP_SNAPSHOT flag is passed to ResumeProfilerEx,
2385 * modules are enabled only temporarily for making a snapshot of the heap.
2386 */
2387enum ProfilerModules {
2388 PROFILER_MODULE_NONE = 0,
2389 PROFILER_MODULE_CPU = 1,
2390 PROFILER_MODULE_HEAP_STATS = 1 << 1,
2391 PROFILER_MODULE_JS_CONSTRUCTORS = 1 << 2,
2392 PROFILER_MODULE_HEAP_SNAPSHOT = 1 << 16
2393};
2394
2395
2396/**
Steve Block3ce2e202009-11-05 08:53:23 +00002397 * Collection of V8 heap information.
2398 *
2399 * Instances of this class can be passed to v8::V8::HeapStatistics to
2400 * get heap statistics from V8.
2401 */
2402class V8EXPORT HeapStatistics {
2403 public:
2404 HeapStatistics();
2405 size_t total_heap_size() { return total_heap_size_; }
2406 size_t used_heap_size() { return used_heap_size_; }
2407
2408 private:
2409 void set_total_heap_size(size_t size) { total_heap_size_ = size; }
2410 void set_used_heap_size(size_t size) { used_heap_size_ = size; }
2411
2412 size_t total_heap_size_;
2413 size_t used_heap_size_;
2414
2415 friend class V8;
2416};
2417
2418
2419/**
Steve Blocka7e24c12009-10-30 11:49:00 +00002420 * Container class for static utility functions.
2421 */
2422class V8EXPORT V8 {
2423 public:
2424 /** Set the callback to invoke in case of fatal errors. */
2425 static void SetFatalErrorHandler(FatalErrorCallback that);
2426
2427 /**
2428 * Ignore out-of-memory exceptions.
2429 *
2430 * V8 running out of memory is treated as a fatal error by default.
2431 * This means that the fatal error handler is called and that V8 is
2432 * terminated.
2433 *
2434 * IgnoreOutOfMemoryException can be used to not treat a
2435 * out-of-memory situation as a fatal error. This way, the contexts
2436 * that did not cause the out of memory problem might be able to
2437 * continue execution.
2438 */
2439 static void IgnoreOutOfMemoryException();
2440
2441 /**
2442 * Check if V8 is dead and therefore unusable. This is the case after
2443 * fatal errors such as out-of-memory situations.
2444 */
2445 static bool IsDead();
2446
2447 /**
2448 * Adds a message listener.
2449 *
2450 * The same message listener can be added more than once and it that
2451 * case it will be called more than once for each message.
2452 */
2453 static bool AddMessageListener(MessageCallback that,
2454 Handle<Value> data = Handle<Value>());
2455
2456 /**
2457 * Remove all message listeners from the specified callback function.
2458 */
2459 static void RemoveMessageListeners(MessageCallback that);
2460
2461 /**
2462 * Sets V8 flags from a string.
2463 */
2464 static void SetFlagsFromString(const char* str, int length);
2465
2466 /**
2467 * Sets V8 flags from the command line.
2468 */
2469 static void SetFlagsFromCommandLine(int* argc,
2470 char** argv,
2471 bool remove_flags);
2472
2473 /** Get the version string. */
2474 static const char* GetVersion();
2475
2476 /**
2477 * Enables the host application to provide a mechanism for recording
2478 * statistics counters.
2479 */
2480 static void SetCounterFunction(CounterLookupCallback);
2481
2482 /**
2483 * Enables the host application to provide a mechanism for recording
2484 * histograms. The CreateHistogram function returns a
2485 * histogram which will later be passed to the AddHistogramSample
2486 * function.
2487 */
2488 static void SetCreateHistogramFunction(CreateHistogramCallback);
2489 static void SetAddHistogramSampleFunction(AddHistogramSampleCallback);
2490
2491 /**
2492 * Enables the computation of a sliding window of states. The sliding
2493 * window information is recorded in statistics counters.
2494 */
2495 static void EnableSlidingStateWindow();
2496
2497 /** Callback function for reporting failed access checks.*/
2498 static void SetFailedAccessCheckCallbackFunction(FailedAccessCheckCallback);
2499
2500 /**
2501 * Enables the host application to receive a notification before a
Steve Block6ded16b2010-05-10 14:33:55 +01002502 * garbage collection. Allocations are not allowed in the
2503 * callback function, you therefore cannot manipulate objects (set
2504 * or delete properties for example) since it is possible such
2505 * operations will result in the allocation of objects. It is possible
2506 * to specify the GCType filter for your callback. But it is not possible to
2507 * register the same callback function two times with different
2508 * GCType filters.
2509 */
2510 static void AddGCPrologueCallback(
2511 GCPrologueCallback callback, GCType gc_type_filter = kGCTypeAll);
2512
2513 /**
2514 * This function removes callback which was installed by
2515 * AddGCPrologueCallback function.
2516 */
2517 static void RemoveGCPrologueCallback(GCPrologueCallback callback);
2518
2519 /**
2520 * The function is deprecated. Please use AddGCPrologueCallback instead.
2521 * Enables the host application to receive a notification before a
2522 * garbage collection. Allocations are not allowed in the
Steve Blocka7e24c12009-10-30 11:49:00 +00002523 * callback function, you therefore cannot manipulate objects (set
2524 * or delete properties for example) since it is possible such
2525 * operations will result in the allocation of objects.
2526 */
2527 static void SetGlobalGCPrologueCallback(GCCallback);
2528
2529 /**
2530 * Enables the host application to receive a notification after a
Steve Block6ded16b2010-05-10 14:33:55 +01002531 * garbage collection. Allocations are not allowed in the
2532 * callback function, you therefore cannot manipulate objects (set
2533 * or delete properties for example) since it is possible such
2534 * operations will result in the allocation of objects. It is possible
2535 * to specify the GCType filter for your callback. But it is not possible to
2536 * register the same callback function two times with different
2537 * GCType filters.
2538 */
2539 static void AddGCEpilogueCallback(
2540 GCEpilogueCallback callback, GCType gc_type_filter = kGCTypeAll);
2541
2542 /**
2543 * This function removes callback which was installed by
2544 * AddGCEpilogueCallback function.
2545 */
2546 static void RemoveGCEpilogueCallback(GCEpilogueCallback callback);
2547
2548 /**
2549 * The function is deprecated. Please use AddGCEpilogueCallback instead.
2550 * Enables the host application to receive a notification after a
Steve Blocka7e24c12009-10-30 11:49:00 +00002551 * major garbage collection. Allocations are not allowed in the
2552 * callback function, you therefore cannot manipulate objects (set
2553 * or delete properties for example) since it is possible such
2554 * operations will result in the allocation of objects.
2555 */
2556 static void SetGlobalGCEpilogueCallback(GCCallback);
2557
2558 /**
2559 * Allows the host application to group objects together. If one
2560 * object in the group is alive, all objects in the group are alive.
2561 * After each garbage collection, object groups are removed. It is
2562 * intended to be used in the before-garbage-collection callback
2563 * function, for instance to simulate DOM tree connections among JS
2564 * wrapper objects.
2565 */
2566 static void AddObjectGroup(Persistent<Value>* objects, size_t length);
2567
2568 /**
2569 * Initializes from snapshot if possible. Otherwise, attempts to
2570 * initialize from scratch. This function is called implicitly if
2571 * you use the API without calling it first.
2572 */
2573 static bool Initialize();
2574
2575 /**
2576 * Adjusts the amount of registered external memory. Used to give
2577 * V8 an indication of the amount of externally allocated memory
2578 * that is kept alive by JavaScript objects. V8 uses this to decide
2579 * when to perform global garbage collections. Registering
2580 * externally allocated memory will trigger global garbage
2581 * collections more often than otherwise in an attempt to garbage
2582 * collect the JavaScript objects keeping the externally allocated
2583 * memory alive.
2584 *
2585 * \param change_in_bytes the change in externally allocated memory
2586 * that is kept alive by JavaScript objects.
2587 * \returns the adjusted value.
2588 */
2589 static int AdjustAmountOfExternalAllocatedMemory(int change_in_bytes);
2590
2591 /**
2592 * Suspends recording of tick samples in the profiler.
2593 * When the V8 profiling mode is enabled (usually via command line
2594 * switches) this function suspends recording of tick samples.
2595 * Profiling ticks are discarded until ResumeProfiler() is called.
2596 *
2597 * See also the --prof and --prof_auto command line switches to
2598 * enable V8 profiling.
2599 */
2600 static void PauseProfiler();
2601
2602 /**
2603 * Resumes recording of tick samples in the profiler.
2604 * See also PauseProfiler().
2605 */
2606 static void ResumeProfiler();
2607
2608 /**
2609 * Return whether profiler is currently paused.
2610 */
2611 static bool IsProfilerPaused();
2612
2613 /**
Andrei Popescu402d9372010-02-26 13:31:12 +00002614 * Resumes specified profiler modules. Can be called several times to
2615 * mark the opening of a profiler events block with the given tag.
2616 *
Steve Blocka7e24c12009-10-30 11:49:00 +00002617 * "ResumeProfiler" is equivalent to "ResumeProfilerEx(PROFILER_MODULE_CPU)".
2618 * See ProfilerModules enum.
2619 *
2620 * \param flags Flags specifying profiler modules.
Andrei Popescu402d9372010-02-26 13:31:12 +00002621 * \param tag Profile tag.
Steve Blocka7e24c12009-10-30 11:49:00 +00002622 */
Andrei Popescu402d9372010-02-26 13:31:12 +00002623 static void ResumeProfilerEx(int flags, int tag = 0);
Steve Blocka7e24c12009-10-30 11:49:00 +00002624
2625 /**
Andrei Popescu402d9372010-02-26 13:31:12 +00002626 * Pauses specified profiler modules. Each call to "PauseProfilerEx" closes
2627 * a block of profiler events opened by a call to "ResumeProfilerEx" with the
2628 * same tag value. There is no need for blocks to be properly nested.
2629 * The profiler is paused when the last opened block is closed.
2630 *
Steve Blocka7e24c12009-10-30 11:49:00 +00002631 * "PauseProfiler" is equivalent to "PauseProfilerEx(PROFILER_MODULE_CPU)".
2632 * See ProfilerModules enum.
2633 *
2634 * \param flags Flags specifying profiler modules.
Andrei Popescu402d9372010-02-26 13:31:12 +00002635 * \param tag Profile tag.
Steve Blocka7e24c12009-10-30 11:49:00 +00002636 */
Andrei Popescu402d9372010-02-26 13:31:12 +00002637 static void PauseProfilerEx(int flags, int tag = 0);
Steve Blocka7e24c12009-10-30 11:49:00 +00002638
2639 /**
2640 * Returns active (resumed) profiler modules.
2641 * See ProfilerModules enum.
2642 *
2643 * \returns active profiler modules.
2644 */
2645 static int GetActiveProfilerModules();
2646
2647 /**
2648 * If logging is performed into a memory buffer (via --logfile=*), allows to
2649 * retrieve previously written messages. This can be used for retrieving
2650 * profiler log data in the application. This function is thread-safe.
2651 *
2652 * Caller provides a destination buffer that must exist during GetLogLines
2653 * call. Only whole log lines are copied into the buffer.
2654 *
2655 * \param from_pos specified a point in a buffer to read from, 0 is the
2656 * beginning of a buffer. It is assumed that caller updates its current
2657 * position using returned size value from the previous call.
2658 * \param dest_buf destination buffer for log data.
2659 * \param max_size size of the destination buffer.
2660 * \returns actual size of log data copied into buffer.
2661 */
2662 static int GetLogLines(int from_pos, char* dest_buf, int max_size);
2663
2664 /**
Steve Block6ded16b2010-05-10 14:33:55 +01002665 * The minimum allowed size for a log lines buffer. If the size of
2666 * the buffer given will not be enough to hold a line of the maximum
2667 * length, an attempt to find a log line end in GetLogLines will
2668 * fail, and an empty result will be returned.
2669 */
2670 static const int kMinimumSizeForLogLinesBuffer = 2048;
2671
2672 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00002673 * Retrieve the V8 thread id of the calling thread.
2674 *
2675 * The thread id for a thread should only be retrieved after the V8
2676 * lock has been acquired with a Locker object with that thread.
2677 */
2678 static int GetCurrentThreadId();
2679
2680 /**
2681 * Forcefully terminate execution of a JavaScript thread. This can
2682 * be used to terminate long-running scripts.
2683 *
2684 * TerminateExecution should only be called when then V8 lock has
2685 * been acquired with a Locker object. Therefore, in order to be
2686 * able to terminate long-running threads, preemption must be
2687 * enabled to allow the user of TerminateExecution to acquire the
2688 * lock.
2689 *
2690 * The termination is achieved by throwing an exception that is
2691 * uncatchable by JavaScript exception handlers. Termination
2692 * exceptions act as if they were caught by a C++ TryCatch exception
2693 * handlers. If forceful termination is used, any C++ TryCatch
2694 * exception handler that catches an exception should check if that
2695 * exception is a termination exception and immediately return if
2696 * that is the case. Returning immediately in that case will
2697 * continue the propagation of the termination exception if needed.
2698 *
2699 * The thread id passed to TerminateExecution must have been
2700 * obtained by calling GetCurrentThreadId on the thread in question.
2701 *
2702 * \param thread_id The thread id of the thread to terminate.
2703 */
2704 static void TerminateExecution(int thread_id);
2705
2706 /**
2707 * Forcefully terminate the current thread of JavaScript execution.
2708 *
2709 * This method can be used by any thread even if that thread has not
2710 * acquired the V8 lock with a Locker object.
2711 */
2712 static void TerminateExecution();
2713
2714 /**
Steve Block6ded16b2010-05-10 14:33:55 +01002715 * Is V8 terminating JavaScript execution.
2716 *
2717 * Returns true if JavaScript execution is currently terminating
2718 * because of a call to TerminateExecution. In that case there are
2719 * still JavaScript frames on the stack and the termination
2720 * exception is still active.
2721 */
2722 static bool IsExecutionTerminating();
2723
2724 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00002725 * Releases any resources used by v8 and stops any utility threads
2726 * that may be running. Note that disposing v8 is permanent, it
2727 * cannot be reinitialized.
2728 *
2729 * It should generally not be necessary to dispose v8 before exiting
2730 * a process, this should happen automatically. It is only necessary
2731 * to use if the process needs the resources taken up by v8.
2732 */
2733 static bool Dispose();
2734
Steve Block3ce2e202009-11-05 08:53:23 +00002735 /**
2736 * Get statistics about the heap memory usage.
2737 */
2738 static void GetHeapStatistics(HeapStatistics* heap_statistics);
Steve Blocka7e24c12009-10-30 11:49:00 +00002739
2740 /**
2741 * Optional notification that the embedder is idle.
2742 * V8 uses the notification to reduce memory footprint.
2743 * This call can be used repeatedly if the embedder remains idle.
Steve Blocka7e24c12009-10-30 11:49:00 +00002744 * Returns true if the embedder should stop calling IdleNotification
2745 * until real work has been done. This indicates that V8 has done
2746 * as much cleanup as it will be able to do.
2747 */
Steve Block3ce2e202009-11-05 08:53:23 +00002748 static bool IdleNotification();
Steve Blocka7e24c12009-10-30 11:49:00 +00002749
2750 /**
2751 * Optional notification that the system is running low on memory.
2752 * V8 uses these notifications to attempt to free memory.
2753 */
2754 static void LowMemoryNotification();
2755
Steve Block6ded16b2010-05-10 14:33:55 +01002756 /**
2757 * Optional notification that a context has been disposed. V8 uses
2758 * these notifications to guide the GC heuristic. Returns the number
2759 * of context disposals - including this one - since the last time
2760 * V8 had a chance to clean up.
2761 */
2762 static int ContextDisposedNotification();
2763
Steve Blocka7e24c12009-10-30 11:49:00 +00002764 private:
2765 V8();
2766
2767 static internal::Object** GlobalizeReference(internal::Object** handle);
2768 static void DisposeGlobal(internal::Object** global_handle);
2769 static void MakeWeak(internal::Object** global_handle,
2770 void* data,
2771 WeakReferenceCallback);
2772 static void ClearWeak(internal::Object** global_handle);
2773 static bool IsGlobalNearDeath(internal::Object** global_handle);
2774 static bool IsGlobalWeak(internal::Object** global_handle);
2775
2776 template <class T> friend class Handle;
2777 template <class T> friend class Local;
2778 template <class T> friend class Persistent;
2779 friend class Context;
2780};
2781
2782
2783/**
2784 * An external exception handler.
2785 */
2786class V8EXPORT TryCatch {
2787 public:
2788
2789 /**
2790 * Creates a new try/catch block and registers it with v8.
2791 */
2792 TryCatch();
2793
2794 /**
2795 * Unregisters and deletes this try/catch block.
2796 */
2797 ~TryCatch();
2798
2799 /**
2800 * Returns true if an exception has been caught by this try/catch block.
2801 */
2802 bool HasCaught() const;
2803
2804 /**
2805 * For certain types of exceptions, it makes no sense to continue
2806 * execution.
2807 *
2808 * Currently, the only type of exception that can be caught by a
2809 * TryCatch handler and for which it does not make sense to continue
2810 * is termination exception. Such exceptions are thrown when the
2811 * TerminateExecution methods are called to terminate a long-running
2812 * script.
2813 *
2814 * If CanContinue returns false, the correct action is to perform
2815 * any C++ cleanup needed and then return.
2816 */
2817 bool CanContinue() const;
2818
2819 /**
Steve Blockd0582a62009-12-15 09:54:21 +00002820 * Throws the exception caught by this TryCatch in a way that avoids
2821 * it being caught again by this same TryCatch. As with ThrowException
2822 * it is illegal to execute any JavaScript operations after calling
2823 * ReThrow; the caller must return immediately to where the exception
2824 * is caught.
2825 */
2826 Handle<Value> ReThrow();
2827
2828 /**
Steve Blocka7e24c12009-10-30 11:49:00 +00002829 * Returns the exception caught by this try/catch block. If no exception has
2830 * been caught an empty handle is returned.
2831 *
2832 * The returned handle is valid until this TryCatch block has been destroyed.
2833 */
2834 Local<Value> Exception() const;
2835
2836 /**
2837 * Returns the .stack property of the thrown object. If no .stack
2838 * property is present an empty handle is returned.
2839 */
2840 Local<Value> StackTrace() const;
2841
2842 /**
2843 * Returns the message associated with this exception. If there is
2844 * no message associated an empty handle is returned.
2845 *
2846 * The returned handle is valid until this TryCatch block has been
2847 * destroyed.
2848 */
2849 Local<v8::Message> Message() const;
2850
2851 /**
2852 * Clears any exceptions that may have been caught by this try/catch block.
2853 * After this method has been called, HasCaught() will return false.
2854 *
2855 * It is not necessary to clear a try/catch block before using it again; if
2856 * another exception is thrown the previously caught exception will just be
2857 * overwritten. However, it is often a good idea since it makes it easier
2858 * to determine which operation threw a given exception.
2859 */
2860 void Reset();
2861
2862 /**
2863 * Set verbosity of the external exception handler.
2864 *
2865 * By default, exceptions that are caught by an external exception
2866 * handler are not reported. Call SetVerbose with true on an
2867 * external exception handler to have exceptions caught by the
2868 * handler reported as if they were not caught.
2869 */
2870 void SetVerbose(bool value);
2871
2872 /**
2873 * Set whether or not this TryCatch should capture a Message object
2874 * which holds source information about where the exception
2875 * occurred. True by default.
2876 */
2877 void SetCaptureMessage(bool value);
2878
Steve Blockd0582a62009-12-15 09:54:21 +00002879 private:
2880 void* next_;
Steve Blocka7e24c12009-10-30 11:49:00 +00002881 void* exception_;
2882 void* message_;
Steve Blockd0582a62009-12-15 09:54:21 +00002883 bool is_verbose_ : 1;
2884 bool can_continue_ : 1;
2885 bool capture_message_ : 1;
2886 bool rethrow_ : 1;
2887
2888 friend class v8::internal::Top;
Steve Blocka7e24c12009-10-30 11:49:00 +00002889};
2890
2891
2892// --- C o n t e x t ---
2893
2894
2895/**
2896 * Ignore
2897 */
2898class V8EXPORT ExtensionConfiguration {
2899 public:
2900 ExtensionConfiguration(int name_count, const char* names[])
2901 : name_count_(name_count), names_(names) { }
2902 private:
2903 friend class ImplementationUtilities;
2904 int name_count_;
2905 const char** names_;
2906};
2907
2908
2909/**
2910 * A sandboxed execution context with its own set of built-in objects
2911 * and functions.
2912 */
2913class V8EXPORT Context {
2914 public:
2915 /** Returns the global object of the context. */
2916 Local<Object> Global();
2917
2918 /**
2919 * Detaches the global object from its context before
2920 * the global object can be reused to create a new context.
2921 */
2922 void DetachGlobal();
2923
Andrei Popescu74b3c142010-03-29 12:03:09 +01002924 /**
2925 * Reattaches a global object to a context. This can be used to
2926 * restore the connection between a global object and a context
2927 * after DetachGlobal has been called.
2928 *
2929 * \param global_object The global object to reattach to the
2930 * context. For this to work, the global object must be the global
2931 * object that was associated with this context before a call to
2932 * DetachGlobal.
2933 */
2934 void ReattachGlobal(Handle<Object> global_object);
2935
Leon Clarkef7060e22010-06-03 12:02:55 +01002936 /** Creates a new context.
2937 *
2938 * Returns a persistent handle to the newly allocated context. This
2939 * persistent handle has to be disposed when the context is no
2940 * longer used so the context can be garbage collected.
2941 */
Steve Blocka7e24c12009-10-30 11:49:00 +00002942 static Persistent<Context> New(
Andrei Popescu31002712010-02-23 13:46:05 +00002943 ExtensionConfiguration* extensions = NULL,
Steve Blocka7e24c12009-10-30 11:49:00 +00002944 Handle<ObjectTemplate> global_template = Handle<ObjectTemplate>(),
2945 Handle<Value> global_object = Handle<Value>());
2946
2947 /** Returns the last entered context. */
2948 static Local<Context> GetEntered();
2949
2950 /** Returns the context that is on the top of the stack. */
2951 static Local<Context> GetCurrent();
2952
2953 /**
2954 * Returns the context of the calling JavaScript code. That is the
2955 * context of the top-most JavaScript frame. If there are no
2956 * JavaScript frames an empty handle is returned.
2957 */
2958 static Local<Context> GetCalling();
2959
2960 /**
2961 * Sets the security token for the context. To access an object in
2962 * another context, the security tokens must match.
2963 */
2964 void SetSecurityToken(Handle<Value> token);
2965
2966 /** Restores the security token to the default value. */
2967 void UseDefaultSecurityToken();
2968
2969 /** Returns the security token of this context.*/
2970 Handle<Value> GetSecurityToken();
2971
2972 /**
2973 * Enter this context. After entering a context, all code compiled
2974 * and run is compiled and run in this context. If another context
2975 * is already entered, this old context is saved so it can be
2976 * restored when the new context is exited.
2977 */
2978 void Enter();
2979
2980 /**
2981 * Exit this context. Exiting the current context restores the
2982 * context that was in place when entering the current context.
2983 */
2984 void Exit();
2985
2986 /** Returns true if the context has experienced an out of memory situation. */
2987 bool HasOutOfMemoryException();
2988
2989 /** Returns true if V8 has a current context. */
2990 static bool InContext();
2991
2992 /**
2993 * Associate an additional data object with the context. This is mainly used
2994 * with the debugger to provide additional information on the context through
2995 * the debugger API.
2996 */
Steve Blockd0582a62009-12-15 09:54:21 +00002997 void SetData(Handle<String> data);
Steve Blocka7e24c12009-10-30 11:49:00 +00002998 Local<Value> GetData();
2999
3000 /**
3001 * Stack-allocated class which sets the execution context for all
3002 * operations executed within a local scope.
3003 */
3004 class V8EXPORT Scope {
3005 public:
3006 inline Scope(Handle<Context> context) : context_(context) {
3007 context_->Enter();
3008 }
3009 inline ~Scope() { context_->Exit(); }
3010 private:
3011 Handle<Context> context_;
3012 };
3013
3014 private:
3015 friend class Value;
3016 friend class Script;
3017 friend class Object;
3018 friend class Function;
3019};
3020
3021
3022/**
3023 * Multiple threads in V8 are allowed, but only one thread at a time
3024 * is allowed to use V8. The definition of 'using V8' includes
3025 * accessing handles or holding onto object pointers obtained from V8
3026 * handles. It is up to the user of V8 to ensure (perhaps with
3027 * locking) that this constraint is not violated.
3028 *
3029 * If you wish to start using V8 in a thread you can do this by constructing
3030 * a v8::Locker object. After the code using V8 has completed for the
3031 * current thread you can call the destructor. This can be combined
3032 * with C++ scope-based construction as follows:
3033 *
3034 * \code
3035 * ...
3036 * {
3037 * v8::Locker locker;
3038 * ...
3039 * // Code using V8 goes here.
3040 * ...
3041 * } // Destructor called here
3042 * \endcode
3043 *
3044 * If you wish to stop using V8 in a thread A you can do this by either
3045 * by destroying the v8::Locker object as above or by constructing a
3046 * v8::Unlocker object:
3047 *
3048 * \code
3049 * {
3050 * v8::Unlocker unlocker;
3051 * ...
3052 * // Code not using V8 goes here while V8 can run in another thread.
3053 * ...
3054 * } // Destructor called here.
3055 * \endcode
3056 *
3057 * The Unlocker object is intended for use in a long-running callback
3058 * from V8, where you want to release the V8 lock for other threads to
3059 * use.
3060 *
3061 * The v8::Locker is a recursive lock. That is, you can lock more than
3062 * once in a given thread. This can be useful if you have code that can
3063 * be called either from code that holds the lock or from code that does
3064 * not. The Unlocker is not recursive so you can not have several
3065 * Unlockers on the stack at once, and you can not use an Unlocker in a
3066 * thread that is not inside a Locker's scope.
3067 *
3068 * An unlocker will unlock several lockers if it has to and reinstate
3069 * the correct depth of locking on its destruction. eg.:
3070 *
3071 * \code
3072 * // V8 not locked.
3073 * {
3074 * v8::Locker locker;
3075 * // V8 locked.
3076 * {
3077 * v8::Locker another_locker;
3078 * // V8 still locked (2 levels).
3079 * {
3080 * v8::Unlocker unlocker;
3081 * // V8 not locked.
3082 * }
3083 * // V8 locked again (2 levels).
3084 * }
3085 * // V8 still locked (1 level).
3086 * }
3087 * // V8 Now no longer locked.
3088 * \endcode
3089 */
3090class V8EXPORT Unlocker {
3091 public:
3092 Unlocker();
3093 ~Unlocker();
3094};
3095
3096
3097class V8EXPORT Locker {
3098 public:
3099 Locker();
3100 ~Locker();
3101
3102 /**
3103 * Start preemption.
3104 *
3105 * When preemption is started, a timer is fired every n milli seconds
3106 * that will switch between multiple threads that are in contention
3107 * for the V8 lock.
3108 */
3109 static void StartPreemption(int every_n_ms);
3110
3111 /**
3112 * Stop preemption.
3113 */
3114 static void StopPreemption();
3115
3116 /**
3117 * Returns whether or not the locker is locked by the current thread.
3118 */
3119 static bool IsLocked();
3120
3121 /**
3122 * Returns whether v8::Locker is being used by this V8 instance.
3123 */
3124 static bool IsActive() { return active_; }
3125
3126 private:
3127 bool has_lock_;
3128 bool top_level_;
3129
3130 static bool active_;
3131
3132 // Disallow copying and assigning.
3133 Locker(const Locker&);
3134 void operator=(const Locker&);
3135};
3136
3137
3138
3139// --- I m p l e m e n t a t i o n ---
3140
3141
3142namespace internal {
3143
3144
3145// Tag information for HeapObject.
3146const int kHeapObjectTag = 1;
3147const int kHeapObjectTagSize = 2;
3148const intptr_t kHeapObjectTagMask = (1 << kHeapObjectTagSize) - 1;
3149
Steve Blocka7e24c12009-10-30 11:49:00 +00003150// Tag information for Smi.
3151const int kSmiTag = 0;
3152const int kSmiTagSize = 1;
3153const intptr_t kSmiTagMask = (1 << kSmiTagSize) - 1;
3154
Steve Block3ce2e202009-11-05 08:53:23 +00003155template <size_t ptr_size> struct SmiConstants;
3156
3157// Smi constants for 32-bit systems.
3158template <> struct SmiConstants<4> {
3159 static const int kSmiShiftSize = 0;
3160 static const int kSmiValueSize = 31;
3161 static inline int SmiToInt(internal::Object* value) {
3162 int shift_bits = kSmiTagSize + kSmiShiftSize;
3163 // Throw away top 32 bits and shift down (requires >> to be sign extending).
3164 return static_cast<int>(reinterpret_cast<intptr_t>(value)) >> shift_bits;
3165 }
3166};
3167
3168// Smi constants for 64-bit systems.
3169template <> struct SmiConstants<8> {
3170 static const int kSmiShiftSize = 31;
3171 static const int kSmiValueSize = 32;
3172 static inline int SmiToInt(internal::Object* value) {
3173 int shift_bits = kSmiTagSize + kSmiShiftSize;
3174 // Shift down and throw away top 32 bits.
3175 return static_cast<int>(reinterpret_cast<intptr_t>(value) >> shift_bits);
3176 }
3177};
3178
3179const int kSmiShiftSize = SmiConstants<sizeof(void*)>::kSmiShiftSize;
3180const int kSmiValueSize = SmiConstants<sizeof(void*)>::kSmiValueSize;
Steve Blocka7e24c12009-10-30 11:49:00 +00003181
Steve Blockd0582a62009-12-15 09:54:21 +00003182template <size_t ptr_size> struct InternalConstants;
3183
3184// Internal constants for 32-bit systems.
3185template <> struct InternalConstants<4> {
3186 static const int kStringResourceOffset = 3 * sizeof(void*);
3187};
3188
3189// Internal constants for 64-bit systems.
3190template <> struct InternalConstants<8> {
Steve Block6ded16b2010-05-10 14:33:55 +01003191 static const int kStringResourceOffset = 3 * sizeof(void*);
Steve Blockd0582a62009-12-15 09:54:21 +00003192};
3193
Steve Blocka7e24c12009-10-30 11:49:00 +00003194/**
3195 * This class exports constants and functionality from within v8 that
3196 * is necessary to implement inline functions in the v8 api. Don't
3197 * depend on functions and constants defined here.
3198 */
3199class Internals {
3200 public:
3201
3202 // These values match non-compiler-dependent values defined within
3203 // the implementation of v8.
3204 static const int kHeapObjectMapOffset = 0;
3205 static const int kMapInstanceTypeOffset = sizeof(void*) + sizeof(int);
Steve Blockd0582a62009-12-15 09:54:21 +00003206 static const int kStringResourceOffset =
3207 InternalConstants<sizeof(void*)>::kStringResourceOffset;
3208
Steve Blocka7e24c12009-10-30 11:49:00 +00003209 static const int kProxyProxyOffset = sizeof(void*);
3210 static const int kJSObjectHeaderSize = 3 * sizeof(void*);
3211 static const int kFullStringRepresentationMask = 0x07;
Ben Murdoch7f4d5bd2010-06-15 11:15:29 +01003212 static const int kExternalTwoByteRepresentationTag = 0x02;
Steve Blocka7e24c12009-10-30 11:49:00 +00003213
Kristian Monsen9dcf7e22010-06-28 14:14:28 +01003214 static const int kJSObjectType = 0x9f;
3215 static const int kFirstNonstringType = 0x80;
3216 static const int kProxyType = 0x85;
Steve Blocka7e24c12009-10-30 11:49:00 +00003217
3218 static inline bool HasHeapObjectTag(internal::Object* value) {
3219 return ((reinterpret_cast<intptr_t>(value) & kHeapObjectTagMask) ==
3220 kHeapObjectTag);
3221 }
3222
3223 static inline bool HasSmiTag(internal::Object* value) {
3224 return ((reinterpret_cast<intptr_t>(value) & kSmiTagMask) == kSmiTag);
3225 }
3226
3227 static inline int SmiValue(internal::Object* value) {
Steve Block3ce2e202009-11-05 08:53:23 +00003228 return SmiConstants<sizeof(void*)>::SmiToInt(value);
3229 }
3230
3231 static inline int GetInstanceType(internal::Object* obj) {
3232 typedef internal::Object O;
3233 O* map = ReadField<O*>(obj, kHeapObjectMapOffset);
3234 return ReadField<uint8_t>(map, kMapInstanceTypeOffset);
3235 }
3236
3237 static inline void* GetExternalPointer(internal::Object* obj) {
3238 if (HasSmiTag(obj)) {
3239 return obj;
3240 } else if (GetInstanceType(obj) == kProxyType) {
3241 return ReadField<void*>(obj, kProxyProxyOffset);
3242 } else {
3243 return NULL;
3244 }
Steve Blocka7e24c12009-10-30 11:49:00 +00003245 }
3246
3247 static inline bool IsExternalTwoByteString(int instance_type) {
3248 int representation = (instance_type & kFullStringRepresentationMask);
3249 return representation == kExternalTwoByteRepresentationTag;
3250 }
3251
3252 template <typename T>
3253 static inline T ReadField(Object* ptr, int offset) {
3254 uint8_t* addr = reinterpret_cast<uint8_t*>(ptr) + offset - kHeapObjectTag;
3255 return *reinterpret_cast<T*>(addr);
3256 }
3257
3258};
3259
3260}
3261
3262
3263template <class T>
3264Handle<T>::Handle() : val_(0) { }
3265
3266
3267template <class T>
3268Local<T>::Local() : Handle<T>() { }
3269
3270
3271template <class T>
3272Local<T> Local<T>::New(Handle<T> that) {
3273 if (that.IsEmpty()) return Local<T>();
3274 internal::Object** p = reinterpret_cast<internal::Object**>(*that);
3275 return Local<T>(reinterpret_cast<T*>(HandleScope::CreateHandle(*p)));
3276}
3277
3278
3279template <class T>
3280Persistent<T> Persistent<T>::New(Handle<T> that) {
3281 if (that.IsEmpty()) return Persistent<T>();
3282 internal::Object** p = reinterpret_cast<internal::Object**>(*that);
3283 return Persistent<T>(reinterpret_cast<T*>(V8::GlobalizeReference(p)));
3284}
3285
3286
3287template <class T>
3288bool Persistent<T>::IsNearDeath() const {
3289 if (this->IsEmpty()) return false;
3290 return V8::IsGlobalNearDeath(reinterpret_cast<internal::Object**>(**this));
3291}
3292
3293
3294template <class T>
3295bool Persistent<T>::IsWeak() const {
3296 if (this->IsEmpty()) return false;
3297 return V8::IsGlobalWeak(reinterpret_cast<internal::Object**>(**this));
3298}
3299
3300
3301template <class T>
3302void Persistent<T>::Dispose() {
3303 if (this->IsEmpty()) return;
3304 V8::DisposeGlobal(reinterpret_cast<internal::Object**>(**this));
3305}
3306
3307
3308template <class T>
3309Persistent<T>::Persistent() : Handle<T>() { }
3310
3311template <class T>
3312void Persistent<T>::MakeWeak(void* parameters, WeakReferenceCallback callback) {
3313 V8::MakeWeak(reinterpret_cast<internal::Object**>(**this),
3314 parameters,
3315 callback);
3316}
3317
3318template <class T>
3319void Persistent<T>::ClearWeak() {
3320 V8::ClearWeak(reinterpret_cast<internal::Object**>(**this));
3321}
3322
3323Local<Value> Arguments::operator[](int i) const {
3324 if (i < 0 || length_ <= i) return Local<Value>(*Undefined());
3325 return Local<Value>(reinterpret_cast<Value*>(values_ - i));
3326}
3327
3328
3329Local<Function> Arguments::Callee() const {
3330 return callee_;
3331}
3332
3333
3334Local<Object> Arguments::This() const {
3335 return Local<Object>(reinterpret_cast<Object*>(values_ + 1));
3336}
3337
3338
3339Local<Object> Arguments::Holder() const {
3340 return holder_;
3341}
3342
3343
3344Local<Value> Arguments::Data() const {
3345 return data_;
3346}
3347
3348
3349bool Arguments::IsConstructCall() const {
3350 return is_construct_call_;
3351}
3352
3353
3354int Arguments::Length() const {
3355 return length_;
3356}
3357
3358
3359template <class T>
3360Local<T> HandleScope::Close(Handle<T> value) {
3361 internal::Object** before = reinterpret_cast<internal::Object**>(*value);
3362 internal::Object** after = RawClose(before);
3363 return Local<T>(reinterpret_cast<T*>(after));
3364}
3365
3366Handle<Value> ScriptOrigin::ResourceName() const {
3367 return resource_name_;
3368}
3369
3370
3371Handle<Integer> ScriptOrigin::ResourceLineOffset() const {
3372 return resource_line_offset_;
3373}
3374
3375
3376Handle<Integer> ScriptOrigin::ResourceColumnOffset() const {
3377 return resource_column_offset_;
3378}
3379
3380
3381Handle<Boolean> Boolean::New(bool value) {
3382 return value ? True() : False();
3383}
3384
3385
3386void Template::Set(const char* name, v8::Handle<Data> value) {
3387 Set(v8::String::New(name), value);
3388}
3389
3390
3391Local<Value> Object::GetInternalField(int index) {
3392#ifndef V8_ENABLE_CHECKS
3393 Local<Value> quick_result = UncheckedGetInternalField(index);
3394 if (!quick_result.IsEmpty()) return quick_result;
3395#endif
3396 return CheckedGetInternalField(index);
3397}
3398
3399
3400Local<Value> Object::UncheckedGetInternalField(int index) {
3401 typedef internal::Object O;
3402 typedef internal::Internals I;
3403 O* obj = *reinterpret_cast<O**>(this);
Steve Block3ce2e202009-11-05 08:53:23 +00003404 if (I::GetInstanceType(obj) == I::kJSObjectType) {
Steve Blocka7e24c12009-10-30 11:49:00 +00003405 // If the object is a plain JSObject, which is the common case,
3406 // we know where to find the internal fields and can return the
3407 // value directly.
3408 int offset = I::kJSObjectHeaderSize + (sizeof(void*) * index);
3409 O* value = I::ReadField<O*>(obj, offset);
3410 O** result = HandleScope::CreateHandle(value);
3411 return Local<Value>(reinterpret_cast<Value*>(result));
3412 } else {
3413 return Local<Value>();
3414 }
3415}
3416
3417
3418void* External::Unwrap(Handle<v8::Value> obj) {
3419#ifdef V8_ENABLE_CHECKS
3420 return FullUnwrap(obj);
3421#else
3422 return QuickUnwrap(obj);
3423#endif
3424}
3425
3426
3427void* External::QuickUnwrap(Handle<v8::Value> wrapper) {
3428 typedef internal::Object O;
Steve Blocka7e24c12009-10-30 11:49:00 +00003429 O* obj = *reinterpret_cast<O**>(const_cast<v8::Value*>(*wrapper));
Steve Block3ce2e202009-11-05 08:53:23 +00003430 return internal::Internals::GetExternalPointer(obj);
Steve Blocka7e24c12009-10-30 11:49:00 +00003431}
3432
3433
3434void* Object::GetPointerFromInternalField(int index) {
Steve Block3ce2e202009-11-05 08:53:23 +00003435 typedef internal::Object O;
3436 typedef internal::Internals I;
3437
3438 O* obj = *reinterpret_cast<O**>(this);
3439
3440 if (I::GetInstanceType(obj) == I::kJSObjectType) {
3441 // If the object is a plain JSObject, which is the common case,
3442 // we know where to find the internal fields and can return the
3443 // value directly.
3444 int offset = I::kJSObjectHeaderSize + (sizeof(void*) * index);
3445 O* value = I::ReadField<O*>(obj, offset);
3446 return I::GetExternalPointer(value);
3447 }
3448
3449 return SlowGetPointerFromInternalField(index);
Steve Blocka7e24c12009-10-30 11:49:00 +00003450}
3451
3452
3453String* String::Cast(v8::Value* value) {
3454#ifdef V8_ENABLE_CHECKS
3455 CheckCast(value);
3456#endif
3457 return static_cast<String*>(value);
3458}
3459
3460
3461String::ExternalStringResource* String::GetExternalStringResource() const {
3462 typedef internal::Object O;
3463 typedef internal::Internals I;
3464 O* obj = *reinterpret_cast<O**>(const_cast<String*>(this));
Steve Blocka7e24c12009-10-30 11:49:00 +00003465 String::ExternalStringResource* result;
Steve Block3ce2e202009-11-05 08:53:23 +00003466 if (I::IsExternalTwoByteString(I::GetInstanceType(obj))) {
Steve Blocka7e24c12009-10-30 11:49:00 +00003467 void* value = I::ReadField<void*>(obj, I::kStringResourceOffset);
3468 result = reinterpret_cast<String::ExternalStringResource*>(value);
3469 } else {
3470 result = NULL;
3471 }
3472#ifdef V8_ENABLE_CHECKS
3473 VerifyExternalStringResource(result);
3474#endif
3475 return result;
3476}
3477
3478
3479bool Value::IsString() const {
3480#ifdef V8_ENABLE_CHECKS
3481 return FullIsString();
3482#else
3483 return QuickIsString();
3484#endif
3485}
3486
3487bool Value::QuickIsString() const {
3488 typedef internal::Object O;
3489 typedef internal::Internals I;
3490 O* obj = *reinterpret_cast<O**>(const_cast<Value*>(this));
3491 if (!I::HasHeapObjectTag(obj)) return false;
Steve Block3ce2e202009-11-05 08:53:23 +00003492 return (I::GetInstanceType(obj) < I::kFirstNonstringType);
Steve Blocka7e24c12009-10-30 11:49:00 +00003493}
3494
3495
3496Number* Number::Cast(v8::Value* value) {
3497#ifdef V8_ENABLE_CHECKS
3498 CheckCast(value);
3499#endif
3500 return static_cast<Number*>(value);
3501}
3502
3503
3504Integer* Integer::Cast(v8::Value* value) {
3505#ifdef V8_ENABLE_CHECKS
3506 CheckCast(value);
3507#endif
3508 return static_cast<Integer*>(value);
3509}
3510
3511
3512Date* Date::Cast(v8::Value* value) {
3513#ifdef V8_ENABLE_CHECKS
3514 CheckCast(value);
3515#endif
3516 return static_cast<Date*>(value);
3517}
3518
3519
3520Object* Object::Cast(v8::Value* value) {
3521#ifdef V8_ENABLE_CHECKS
3522 CheckCast(value);
3523#endif
3524 return static_cast<Object*>(value);
3525}
3526
3527
3528Array* Array::Cast(v8::Value* value) {
3529#ifdef V8_ENABLE_CHECKS
3530 CheckCast(value);
3531#endif
3532 return static_cast<Array*>(value);
3533}
3534
3535
3536Function* Function::Cast(v8::Value* value) {
3537#ifdef V8_ENABLE_CHECKS
3538 CheckCast(value);
3539#endif
3540 return static_cast<Function*>(value);
3541}
3542
3543
3544External* External::Cast(v8::Value* value) {
3545#ifdef V8_ENABLE_CHECKS
3546 CheckCast(value);
3547#endif
3548 return static_cast<External*>(value);
3549}
3550
3551
3552Local<Value> AccessorInfo::Data() const {
Steve Block6ded16b2010-05-10 14:33:55 +01003553 return Local<Value>(reinterpret_cast<Value*>(&args_[-2]));
Steve Blocka7e24c12009-10-30 11:49:00 +00003554}
3555
3556
3557Local<Object> AccessorInfo::This() const {
3558 return Local<Object>(reinterpret_cast<Object*>(&args_[0]));
3559}
3560
3561
3562Local<Object> AccessorInfo::Holder() const {
3563 return Local<Object>(reinterpret_cast<Object*>(&args_[-1]));
3564}
3565
3566
3567/**
3568 * \example shell.cc
3569 * A simple shell that takes a list of expressions on the
3570 * command-line and executes them.
3571 */
3572
3573
3574/**
3575 * \example process.cc
3576 */
3577
3578
3579} // namespace v8
3580
3581
3582#undef V8EXPORT
3583#undef V8EXPORT_INLINE
3584#undef TYPE_CHECK
3585
3586
3587#endif // V8_H_