blob: ac26061498fbb412aa44ebe4dcdba650996ce35e [file] [log] [blame]
sgjesse@chromium.org8e8294a2011-05-02 14:30:53 +00001// Copyright 2011 the V8 project authors. All rights reserved.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002// Redistribution and use in source and binary forms, with or without
3// modification, are permitted provided that the following conditions are
4// met:
5//
6// * Redistributions of source code must retain the above copyright
7// notice, this list of conditions and the following disclaimer.
8// * Redistributions in binary form must reproduce the above
9// copyright notice, this list of conditions and the following
10// disclaimer in the documentation and/or other materials provided
11// with the distribution.
12// * Neither the name of Google Inc. nor the names of its
13// contributors may be used to endorse or promote products derived
14// from this software without specific prior written permission.
15//
16// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
v8.team.kasperl727e9952008-09-02 14:56:44 +000028/** \mainpage V8 API Reference Guide
ager@chromium.org9258b6b2008-09-11 09:11:10 +000029 *
30 * V8 is Google's open source JavaScript engine.
v8.team.kasperl727e9952008-09-02 14:56:44 +000031 *
32 * This set of documents provides reference material generated from the
33 * V8 header file, include/v8.h.
34 *
35 * For other documentation see http://code.google.com/apis/v8/
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000036 */
v8.team.kasperl727e9952008-09-02 14:56:44 +000037
ager@chromium.org9258b6b2008-09-11 09:11:10 +000038#ifndef V8_H_
39#define V8_H_
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000040
whesse@chromium.orgf0ac72d2010-11-08 12:47:26 +000041#include "v8stdint.h"
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000042
43#ifdef _WIN32
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000044
45// Setup for Windows DLL export/import. When building the V8 DLL the
46// BUILDING_V8_SHARED needs to be defined. When building a program which uses
47// the V8 DLL USING_V8_SHARED needs to be defined. When either building the V8
48// static library or building a program which uses the V8 static library neither
49// BUILDING_V8_SHARED nor USING_V8_SHARED should be defined.
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000050#if defined(BUILDING_V8_SHARED) && defined(USING_V8_SHARED)
51#error both BUILDING_V8_SHARED and USING_V8_SHARED are set - please check the\
52 build configuration to ensure that at most one of these is set
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000053#endif
54
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000055#ifdef BUILDING_V8_SHARED
ager@chromium.orgbb29dc92009-03-24 13:25:23 +000056#define V8EXPORT __declspec(dllexport)
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000057#elif USING_V8_SHARED
ager@chromium.orgbb29dc92009-03-24 13:25:23 +000058#define V8EXPORT __declspec(dllimport)
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000059#else
ager@chromium.orgbb29dc92009-03-24 13:25:23 +000060#define V8EXPORT
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000061#endif // BUILDING_V8_SHARED
62
63#else // _WIN32
ager@chromium.org9085a012009-05-11 19:22:57 +000064
sgjesse@chromium.orgb9d7da12009-08-05 08:38:10 +000065// Setup for Linux shared library export. There is no need to distinguish
66// between building or using the V8 shared library, but we should not
67// export symbols when we are building a static library.
68#if defined(__GNUC__) && (__GNUC__ >= 4) && defined(V8_SHARED)
ager@chromium.orgbb29dc92009-03-24 13:25:23 +000069#define V8EXPORT __attribute__ ((visibility("default")))
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000070#else // defined(__GNUC__) && (__GNUC__ >= 4)
ager@chromium.orgbb29dc92009-03-24 13:25:23 +000071#define V8EXPORT
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000072#endif // defined(__GNUC__) && (__GNUC__ >= 4)
73
74#endif // _WIN32
75
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000076/**
v8.team.kasperl727e9952008-09-02 14:56:44 +000077 * The v8 JavaScript engine.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000078 */
79namespace v8 {
80
81class Context;
82class String;
svenpanne@chromium.org84bcc552011-07-18 09:50:57 +000083class StringObject;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000084class Value;
85class Utils;
86class Number;
svenpanne@chromium.org84bcc552011-07-18 09:50:57 +000087class NumberObject;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000088class Object;
89class Array;
90class Int32;
91class Uint32;
92class External;
93class Primitive;
94class Boolean;
svenpanne@chromium.org84bcc552011-07-18 09:50:57 +000095class BooleanObject;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000096class Integer;
97class Function;
98class Date;
99class ImplementationUtilities;
100class Signature;
101template <class T> class Handle;
102template <class T> class Local;
103template <class T> class Persistent;
104class FunctionTemplate;
105class ObjectTemplate;
106class Data;
kmillikin@chromium.org9155e252010-05-26 13:27:57 +0000107class AccessorInfo;
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +0000108class StackTrace;
109class StackFrame;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000110
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000111namespace internal {
112
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +0000113class Arguments;
ager@chromium.orgc4c92722009-11-18 14:12:51 +0000114class Object;
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +0000115class Heap;
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +0000116class HeapObject;
117class Isolate;
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000118}
119
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000120
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +0000121// --- Weak Handles ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000122
123
124/**
125 * A weak reference callback function.
126 *
fschneider@chromium.orged78ffd2010-07-21 11:05:19 +0000127 * This callback should either explicitly invoke Dispose on |object| if
128 * V8 wrapper is not needed anymore, or 'revive' it by invocation of MakeWeak.
129 *
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000130 * \param object the weak global object to be reclaimed by the garbage collector
131 * \param parameter the value passed in when making the weak global object
132 */
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000133typedef void (*WeakReferenceCallback)(Persistent<Value> object,
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000134 void* parameter);
135
136
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +0000137// --- Handles ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000138
fschneider@chromium.orged78ffd2010-07-21 11:05:19 +0000139#define TYPE_CHECK(T, S) \
140 while (false) { \
141 *(static_cast<T* volatile*>(0)) = static_cast<S*>(0); \
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000142 }
143
144/**
145 * An object reference managed by the v8 garbage collector.
146 *
147 * All objects returned from v8 have to be tracked by the garbage
148 * collector so that it knows that the objects are still alive. Also,
149 * because the garbage collector may move objects, it is unsafe to
150 * point directly to an object. Instead, all objects are stored in
151 * handles which are known by the garbage collector and updated
152 * whenever an object moves. Handles should always be passed by value
153 * (except in cases like out-parameters) and they should never be
154 * allocated on the heap.
155 *
156 * There are two types of handles: local and persistent handles.
157 * Local handles are light-weight and transient and typically used in
158 * local operations. They are managed by HandleScopes. Persistent
159 * handles can be used when storing objects across several independent
160 * operations and have to be explicitly deallocated when they're no
161 * longer used.
162 *
163 * It is safe to extract the object stored in the handle by
164 * dereferencing the handle (for instance, to extract the Object* from
vegorov@chromium.org7304bca2011-05-16 12:14:13 +0000165 * a Handle<Object>); the value will still be governed by a handle
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000166 * behind the scenes and the same rules apply to these values as to
167 * their handles.
168 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000169template <class T> class Handle {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000170 public:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000171 /**
172 * Creates an empty handle.
173 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000174 inline Handle();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000175
176 /**
177 * Creates a new handle for the specified value.
178 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000179 inline explicit Handle(T* val) : val_(val) { }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000180
181 /**
182 * Creates a handle for the contents of the specified handle. This
183 * constructor allows you to pass handles as arguments by value and
v8.team.kasperl727e9952008-09-02 14:56:44 +0000184 * to assign between handles. However, if you try to assign between
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000185 * incompatible handles, for instance from a Handle<String> to a
vegorov@chromium.org7304bca2011-05-16 12:14:13 +0000186 * Handle<Number> it will cause a compile-time error. Assigning
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000187 * between compatible handles, for instance assigning a
188 * Handle<String> to a variable declared as Handle<Value>, is legal
189 * because String is a subclass of Value.
190 */
191 template <class S> inline Handle(Handle<S> that)
192 : val_(reinterpret_cast<T*>(*that)) {
193 /**
194 * This check fails when trying to convert between incompatible
195 * handles. For example, converting from a Handle<String> to a
196 * Handle<Number>.
197 */
198 TYPE_CHECK(T, S);
199 }
200
201 /**
202 * Returns true if the handle is empty.
203 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000204 inline bool IsEmpty() const { return val_ == 0; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000205
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000206 inline T* operator->() const { return val_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000207
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000208 inline T* operator*() const { return val_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000209
210 /**
211 * Sets the handle to be empty. IsEmpty() will then return true.
212 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000213 inline void Clear() { this->val_ = 0; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000214
215 /**
216 * Checks whether two handles are the same.
217 * Returns true if both are empty, or if the objects
218 * to which they refer are identical.
219 * The handles' references are not checked.
220 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000221 template <class S> inline bool operator==(Handle<S> that) const {
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000222 internal::Object** a = reinterpret_cast<internal::Object**>(**this);
223 internal::Object** b = reinterpret_cast<internal::Object**>(*that);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000224 if (a == 0) return b == 0;
225 if (b == 0) return false;
226 return *a == *b;
227 }
228
229 /**
230 * Checks whether two handles are different.
231 * Returns true if only one of the handles is empty, or if
232 * the objects to which they refer are different.
233 * The handles' references are not checked.
234 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000235 template <class S> inline bool operator!=(Handle<S> that) const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000236 return !operator==(that);
237 }
238
239 template <class S> static inline Handle<T> Cast(Handle<S> that) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000240#ifdef V8_ENABLE_CHECKS
241 // If we're going to perform the type check then we have to check
242 // that the handle isn't empty before doing the checked cast.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000243 if (that.IsEmpty()) return Handle<T>();
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000244#endif
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000245 return Handle<T>(T::Cast(*that));
246 }
247
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000248 template <class S> inline Handle<S> As() {
249 return Handle<S>::Cast(*this);
250 }
251
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000252 private:
253 T* val_;
254};
255
256
257/**
258 * A light-weight stack-allocated object handle. All operations
259 * that return objects from within v8 return them in local handles. They
260 * are created within HandleScopes, and all local handles allocated within a
261 * handle scope are destroyed when the handle scope is destroyed. Hence it
262 * is not necessary to explicitly deallocate local handles.
263 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000264template <class T> class Local : public Handle<T> {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000265 public:
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000266 inline Local();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000267 template <class S> inline Local(Local<S> that)
268 : Handle<T>(reinterpret_cast<T*>(*that)) {
269 /**
270 * This check fails when trying to convert between incompatible
271 * handles. For example, converting from a Handle<String> to a
272 * Handle<Number>.
273 */
274 TYPE_CHECK(T, S);
275 }
276 template <class S> inline Local(S* that) : Handle<T>(that) { }
277 template <class S> static inline Local<T> Cast(Local<S> that) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000278#ifdef V8_ENABLE_CHECKS
279 // If we're going to perform the type check then we have to check
280 // that the handle isn't empty before doing the checked cast.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000281 if (that.IsEmpty()) return Local<T>();
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000282#endif
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000283 return Local<T>(T::Cast(*that));
284 }
285
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000286 template <class S> inline Local<S> As() {
287 return Local<S>::Cast(*this);
288 }
289
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000290 /** Create a local handle for the content of another handle.
291 * The referee is kept alive by the local handle even when
292 * the original handle is destroyed/disposed.
293 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000294 inline static Local<T> New(Handle<T> that);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000295};
296
297
298/**
299 * An object reference that is independent of any handle scope. Where
v8.team.kasperl727e9952008-09-02 14:56:44 +0000300 * a Local handle only lives as long as the HandleScope in which it was
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000301 * allocated, a Persistent handle remains valid until it is explicitly
302 * disposed.
303 *
304 * A persistent handle contains a reference to a storage cell within
305 * the v8 engine which holds an object value and which is updated by
306 * the garbage collector whenever the object is moved. A new storage
307 * cell can be created using Persistent::New and existing handles can
308 * be disposed using Persistent::Dispose. Since persistent handles
309 * are passed by value you may have many persistent handle objects
310 * that point to the same storage cell. For instance, if you pass a
311 * persistent handle as an argument to a function you will not get two
312 * different storage cells but rather two references to the same
313 * storage cell.
314 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000315template <class T> class Persistent : public Handle<T> {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000316 public:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000317 /**
318 * Creates an empty persistent handle that doesn't point to any
319 * storage cell.
320 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000321 inline Persistent();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000322
323 /**
324 * Creates a persistent handle for the same storage cell as the
325 * specified handle. This constructor allows you to pass persistent
326 * handles as arguments by value and to assign between persistent
v8.team.kasperl727e9952008-09-02 14:56:44 +0000327 * handles. However, attempting to assign between incompatible
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000328 * persistent handles, for instance from a Persistent<String> to a
vegorov@chromium.org7304bca2011-05-16 12:14:13 +0000329 * Persistent<Number> will cause a compile-time error. Assigning
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000330 * between compatible persistent handles, for instance assigning a
331 * Persistent<String> to a variable declared as Persistent<Value>,
v8.team.kasperl727e9952008-09-02 14:56:44 +0000332 * is allowed as String is a subclass of Value.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000333 */
334 template <class S> inline Persistent(Persistent<S> that)
335 : Handle<T>(reinterpret_cast<T*>(*that)) {
336 /**
337 * This check fails when trying to convert between incompatible
338 * handles. For example, converting from a Handle<String> to a
339 * Handle<Number>.
340 */
341 TYPE_CHECK(T, S);
342 }
343
344 template <class S> inline Persistent(S* that) : Handle<T>(that) { }
345
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000346 /**
347 * "Casts" a plain handle which is known to be a persistent handle
348 * to a persistent handle.
349 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000350 template <class S> explicit inline Persistent(Handle<S> that)
351 : Handle<T>(*that) { }
352
353 template <class S> static inline Persistent<T> Cast(Persistent<S> that) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000354#ifdef V8_ENABLE_CHECKS
355 // If we're going to perform the type check then we have to check
356 // that the handle isn't empty before doing the checked cast.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000357 if (that.IsEmpty()) return Persistent<T>();
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000358#endif
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000359 return Persistent<T>(T::Cast(*that));
360 }
361
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000362 template <class S> inline Persistent<S> As() {
363 return Persistent<S>::Cast(*this);
364 }
365
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000366 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +0000367 * Creates a new persistent handle for an existing local or
368 * persistent handle.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000369 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000370 inline static Persistent<T> New(Handle<T> that);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000371
372 /**
373 * Releases the storage cell referenced by this persistent handle.
374 * Does not remove the reference to the cell from any handles.
vegorov@chromium.org7304bca2011-05-16 12:14:13 +0000375 * This handle's reference, and any other references to the storage
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000376 * cell remain and IsEmpty will still return false.
377 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000378 inline void Dispose();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000379
380 /**
381 * Make the reference to this object weak. When only weak handles
382 * refer to the object, the garbage collector will perform a
383 * callback to the given V8::WeakReferenceCallback function, passing
384 * it the object reference and the given parameters.
385 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000386 inline void MakeWeak(void* parameters, WeakReferenceCallback callback);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000387
388 /** Clears the weak reference to this object.*/
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000389 inline void ClearWeak();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000390
391 /**
kmillikin@chromium.orgc53e10d2011-05-18 09:12:58 +0000392 * Marks the reference to this object independent. Garbage collector
393 * is free to ignore any object groups containing this object.
394 * Weak callback for an independent handle should not
395 * assume that it will be preceded by a global GC prologue callback
396 * or followed by a global GC epilogue callback.
397 */
398 inline void MarkIndependent();
399
400 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000401 *Checks if the handle holds the only reference to an object.
402 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000403 inline bool IsNearDeath() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000404
405 /**
406 * Returns true if the handle's reference is weak.
407 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000408 inline bool IsWeak() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000409
whesse@chromium.orgb08986c2011-03-14 16:13:42 +0000410 /**
411 * Assigns a wrapper class ID to the handle. See RetainedObjectInfo
412 * interface description in v8-profiler.h for details.
413 */
414 inline void SetWrapperClassId(uint16_t class_id);
415
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000416 private:
417 friend class ImplementationUtilities;
418 friend class ObjectTemplate;
419};
420
421
v8.team.kasperl727e9952008-09-02 14:56:44 +0000422 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000423 * A stack-allocated class that governs a number of local handles.
424 * After a handle scope has been created, all local handles will be
425 * allocated within that handle scope until either the handle scope is
426 * deleted or another handle scope is created. If there is already a
427 * handle scope and a new one is created, all allocations will take
v8.team.kasperl727e9952008-09-02 14:56:44 +0000428 * place in the new handle scope until it is deleted. After that,
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000429 * new handles will again be allocated in the original handle scope.
430 *
431 * After the handle scope of a local handle has been deleted the
432 * garbage collector will no longer track the object stored in the
433 * handle and may deallocate it. The behavior of accessing a handle
434 * for which the handle scope has been deleted is undefined.
435 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000436class V8EXPORT HandleScope {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000437 public:
ager@chromium.orgddb913d2009-01-27 10:01:48 +0000438 HandleScope();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000439
ager@chromium.orgddb913d2009-01-27 10:01:48 +0000440 ~HandleScope();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000441
442 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000443 * Closes the handle scope and returns the value as a handle in the
444 * previous scope, which is the new current scope after the call.
445 */
446 template <class T> Local<T> Close(Handle<T> value);
447
448 /**
449 * Counts the number of allocated handles.
450 */
451 static int NumberOfHandles();
452
453 /**
454 * Creates a new handle with the given value.
455 */
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000456 static internal::Object** CreateHandle(internal::Object* value);
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +0000457 // Faster version, uses HeapObject to obtain the current Isolate.
458 static internal::Object** CreateHandle(internal::HeapObject* value);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000459
460 private:
461 // Make it impossible to create heap-allocated or illegal handle
462 // scopes by disallowing certain operations.
463 HandleScope(const HandleScope&);
464 void operator=(const HandleScope&);
465 void* operator new(size_t size);
466 void operator delete(void*, size_t);
467
ager@chromium.org3811b432009-10-28 14:53:37 +0000468 // This Data class is accessible internally as HandleScopeData through a
469 // typedef in the ImplementationUtilities class.
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000470 class V8EXPORT Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000471 public:
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000472 internal::Object** next;
473 internal::Object** limit;
lrn@chromium.org303ada72010-10-27 09:33:13 +0000474 int level;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000475 inline void Initialize() {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000476 next = limit = NULL;
lrn@chromium.org303ada72010-10-27 09:33:13 +0000477 level = 0;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000478 }
479 };
whesse@chromium.orgf0ac72d2010-11-08 12:47:26 +0000480
lrn@chromium.org303ada72010-10-27 09:33:13 +0000481 void Leave();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000482
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +0000483 internal::Isolate* isolate_;
lrn@chromium.org303ada72010-10-27 09:33:13 +0000484 internal::Object** prev_next_;
485 internal::Object** prev_limit_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000486
ager@chromium.orgddb913d2009-01-27 10:01:48 +0000487 // Allow for the active closing of HandleScopes which allows to pass a handle
488 // from the HandleScope being closed to the next top most HandleScope.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000489 bool is_closed_;
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000490 internal::Object** RawClose(internal::Object** value);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000491
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000492 friend class ImplementationUtilities;
493};
494
495
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +0000496// --- Special objects ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000497
498
499/**
500 * The superclass of values and API object templates.
501 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000502class V8EXPORT Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000503 private:
504 Data();
505};
506
507
508/**
509 * Pre-compilation data that can be associated with a script. This
510 * data can be calculated for a script in advance of actually
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000511 * compiling it, and can be stored between compilations. When script
v8.team.kasperl727e9952008-09-02 14:56:44 +0000512 * data is given to the compile method compilation will be faster.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000513 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000514class V8EXPORT ScriptData { // NOLINT
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000515 public:
516 virtual ~ScriptData() { }
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +0000517
kmillikin@chromium.org9155e252010-05-26 13:27:57 +0000518 /**
519 * Pre-compiles the specified script (context-independent).
520 *
521 * \param input Pointer to UTF-8 script source code.
522 * \param length Length of UTF-8 script source code.
523 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000524 static ScriptData* PreCompile(const char* input, int length);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000525
kmillikin@chromium.org9155e252010-05-26 13:27:57 +0000526 /**
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +0000527 * Pre-compiles the specified script (context-independent).
528 *
529 * NOTE: Pre-compilation using this method cannot happen on another thread
530 * without using Lockers.
531 *
532 * \param source Script source code.
533 */
534 static ScriptData* PreCompile(Handle<String> source);
535
536 /**
kmillikin@chromium.org9155e252010-05-26 13:27:57 +0000537 * Load previous pre-compilation data.
538 *
539 * \param data Pointer to data returned by a call to Data() of a previous
540 * ScriptData. Ownership is not transferred.
541 * \param length Length of data.
542 */
543 static ScriptData* New(const char* data, int length);
544
545 /**
546 * Returns the length of Data().
547 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000548 virtual int Length() = 0;
kmillikin@chromium.org9155e252010-05-26 13:27:57 +0000549
550 /**
551 * Returns a serialized representation of this ScriptData that can later be
552 * passed to New(). NOTE: Serialized data is platform-dependent.
553 */
554 virtual const char* Data() = 0;
555
556 /**
557 * Returns true if the source code could not be parsed.
558 */
fschneider@chromium.org0c20e672010-01-14 15:28:53 +0000559 virtual bool HasError() = 0;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000560};
561
562
563/**
564 * The origin, within a file, of a script.
565 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000566class ScriptOrigin {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000567 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000568 inline ScriptOrigin(
569 Handle<Value> resource_name,
570 Handle<Integer> resource_line_offset = Handle<Integer>(),
571 Handle<Integer> resource_column_offset = Handle<Integer>())
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000572 : resource_name_(resource_name),
573 resource_line_offset_(resource_line_offset),
574 resource_column_offset_(resource_column_offset) { }
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000575 inline Handle<Value> ResourceName() const;
576 inline Handle<Integer> ResourceLineOffset() const;
577 inline Handle<Integer> ResourceColumnOffset() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000578 private:
mads.s.agercbaa0602008-08-14 13:41:48 +0000579 Handle<Value> resource_name_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000580 Handle<Integer> resource_line_offset_;
581 Handle<Integer> resource_column_offset_;
582};
583
584
585/**
v8.team.kasperl727e9952008-09-02 14:56:44 +0000586 * A compiled JavaScript script.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000587 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000588class V8EXPORT Script {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000589 public:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000590 /**
ager@chromium.org5c838252010-02-19 08:53:10 +0000591 * Compiles the specified script (context-independent).
sgjesse@chromium.org911335c2009-08-19 12:59:44 +0000592 *
ager@chromium.org5c838252010-02-19 08:53:10 +0000593 * \param source Script source code.
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000594 * \param origin Script origin, owned by caller, no references are kept
ager@chromium.org5c838252010-02-19 08:53:10 +0000595 * when New() returns
596 * \param pre_data Pre-parsing data, as obtained by ScriptData::PreCompile()
597 * using pre_data speeds compilation if it's done multiple times.
598 * Owned by caller, no references are kept when New() returns.
599 * \param script_data Arbitrary data associated with script. Using
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000600 * this has same effect as calling SetData(), but allows data to be
ager@chromium.org5c838252010-02-19 08:53:10 +0000601 * available to compile event handlers.
602 * \return Compiled script object (context independent; when run it
603 * will use the currently entered context).
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000604 */
ager@chromium.org5c838252010-02-19 08:53:10 +0000605 static Local<Script> New(Handle<String> source,
606 ScriptOrigin* origin = NULL,
607 ScriptData* pre_data = NULL,
608 Handle<String> script_data = Handle<String>());
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000609
mads.s.agercbaa0602008-08-14 13:41:48 +0000610 /**
611 * Compiles the specified script using the specified file name
612 * object (typically a string) as the script's origin.
sgjesse@chromium.org911335c2009-08-19 12:59:44 +0000613 *
ager@chromium.org5c838252010-02-19 08:53:10 +0000614 * \param source Script source code.
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000615 * \param file_name file name object (typically a string) to be used
ager@chromium.org5c838252010-02-19 08:53:10 +0000616 * as the script's origin.
617 * \return Compiled script object (context independent; when run it
618 * will use the currently entered context).
619 */
620 static Local<Script> New(Handle<String> source,
621 Handle<Value> file_name);
622
623 /**
624 * Compiles the specified script (bound to current context).
625 *
626 * \param source Script source code.
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000627 * \param origin Script origin, owned by caller, no references are kept
ager@chromium.org5c838252010-02-19 08:53:10 +0000628 * when Compile() returns
629 * \param pre_data Pre-parsing data, as obtained by ScriptData::PreCompile()
630 * using pre_data speeds compilation if it's done multiple times.
631 * Owned by caller, no references are kept when Compile() returns.
632 * \param script_data Arbitrary data associated with script. Using
633 * this has same effect as calling SetData(), but makes data available
634 * earlier (i.e. to compile event handlers).
635 * \return Compiled script object, bound to the context that was active
636 * when this function was called. When run it will always use this
637 * context.
mads.s.agercbaa0602008-08-14 13:41:48 +0000638 */
639 static Local<Script> Compile(Handle<String> source,
ager@chromium.org5c838252010-02-19 08:53:10 +0000640 ScriptOrigin* origin = NULL,
641 ScriptData* pre_data = NULL,
642 Handle<String> script_data = Handle<String>());
643
644 /**
645 * Compiles the specified script using the specified file name
646 * object (typically a string) as the script's origin.
647 *
648 * \param source Script source code.
649 * \param file_name File name to use as script's origin
650 * \param script_data Arbitrary data associated with script. Using
651 * this has same effect as calling SetData(), but makes data available
652 * earlier (i.e. to compile event handlers).
653 * \return Compiled script object, bound to the context that was active
654 * when this function was called. When run it will always use this
655 * context.
656 */
657 static Local<Script> Compile(Handle<String> source,
658 Handle<Value> file_name,
659 Handle<String> script_data = Handle<String>());
mads.s.agercbaa0602008-08-14 13:41:48 +0000660
v8.team.kasperl727e9952008-09-02 14:56:44 +0000661 /**
sgjesse@chromium.org911335c2009-08-19 12:59:44 +0000662 * Runs the script returning the resulting value. If the script is
663 * context independent (created using ::New) it will be run in the
664 * currently entered context. If it is context specific (created
665 * using ::Compile) it will be run in the context in which it was
666 * compiled.
v8.team.kasperl727e9952008-09-02 14:56:44 +0000667 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000668 Local<Value> Run();
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000669
670 /**
671 * Returns the script id value.
672 */
673 Local<Value> Id();
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000674
675 /**
676 * Associate an additional data object with the script. This is mainly used
677 * with the debugger as this data object is only available through the
678 * debugger API.
679 */
sgjesse@chromium.org499aaa52009-11-30 08:07:20 +0000680 void SetData(Handle<String> data);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000681};
682
683
684/**
685 * An error message.
686 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000687class V8EXPORT Message {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000688 public:
ager@chromium.org32912102009-01-16 10:38:43 +0000689 Local<String> Get() const;
690 Local<String> GetSourceLine() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000691
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000692 /**
693 * Returns the resource name for the script from where the function causing
694 * the error originates.
695 */
ager@chromium.org32912102009-01-16 10:38:43 +0000696 Handle<Value> GetScriptResourceName() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000697
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000698 /**
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000699 * Returns the resource data for the script from where the function causing
700 * the error originates.
701 */
702 Handle<Value> GetScriptData() const;
703
704 /**
ager@chromium.org6a2b0aa2010-07-13 20:58:03 +0000705 * Exception stack trace. By default stack traces are not captured for
706 * uncaught exceptions. SetCaptureStackTraceForUncaughtExceptions allows
707 * to change this option.
708 */
709 Handle<StackTrace> GetStackTrace() const;
710
711 /**
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000712 * Returns the number, 1-based, of the line where the error occurred.
713 */
ager@chromium.org32912102009-01-16 10:38:43 +0000714 int GetLineNumber() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000715
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000716 /**
717 * Returns the index within the script of the first character where
718 * the error occurred.
719 */
ager@chromium.org32912102009-01-16 10:38:43 +0000720 int GetStartPosition() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000721
722 /**
723 * Returns the index within the script of the last character where
724 * the error occurred.
725 */
ager@chromium.org32912102009-01-16 10:38:43 +0000726 int GetEndPosition() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000727
728 /**
729 * Returns the index within the line of the first character where
730 * the error occurred.
731 */
ager@chromium.org32912102009-01-16 10:38:43 +0000732 int GetStartColumn() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000733
734 /**
735 * Returns the index within the line of the last character where
736 * the error occurred.
737 */
ager@chromium.org32912102009-01-16 10:38:43 +0000738 int GetEndColumn() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000739
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000740 // TODO(1245381): Print to a string instead of on a FILE.
741 static void PrintCurrentStackTrace(FILE* out);
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +0000742
743 static const int kNoLineNumberInfo = 0;
744 static const int kNoColumnInfo = 0;
745};
746
747
748/**
749 * Representation of a JavaScript stack trace. The information collected is a
750 * snapshot of the execution stack and the information remains valid after
751 * execution continues.
752 */
753class V8EXPORT StackTrace {
754 public:
755 /**
756 * Flags that determine what information is placed captured for each
757 * StackFrame when grabbing the current stack trace.
758 */
759 enum StackTraceOptions {
760 kLineNumber = 1,
761 kColumnOffset = 1 << 1 | kLineNumber,
762 kScriptName = 1 << 2,
763 kFunctionName = 1 << 3,
764 kIsEval = 1 << 4,
765 kIsConstructor = 1 << 5,
ager@chromium.orgb61a0d12010-10-13 08:35:23 +0000766 kScriptNameOrSourceURL = 1 << 6,
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +0000767 kOverview = kLineNumber | kColumnOffset | kScriptName | kFunctionName,
ager@chromium.orgb61a0d12010-10-13 08:35:23 +0000768 kDetailed = kOverview | kIsEval | kIsConstructor | kScriptNameOrSourceURL
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +0000769 };
770
771 /**
772 * Returns a StackFrame at a particular index.
773 */
774 Local<StackFrame> GetFrame(uint32_t index) const;
775
776 /**
777 * Returns the number of StackFrames.
778 */
779 int GetFrameCount() const;
780
781 /**
782 * Returns StackTrace as a v8::Array that contains StackFrame objects.
783 */
784 Local<Array> AsArray();
785
786 /**
vegorov@chromium.org7304bca2011-05-16 12:14:13 +0000787 * Grab a snapshot of the current JavaScript execution stack.
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +0000788 *
789 * \param frame_limit The maximum number of stack frames we want to capture.
790 * \param options Enumerates the set of things we will capture for each
791 * StackFrame.
792 */
793 static Local<StackTrace> CurrentStackTrace(
794 int frame_limit,
795 StackTraceOptions options = kOverview);
796};
797
798
799/**
800 * A single JavaScript stack frame.
801 */
802class V8EXPORT StackFrame {
803 public:
804 /**
805 * Returns the number, 1-based, of the line for the associate function call.
806 * This method will return Message::kNoLineNumberInfo if it is unable to
807 * retrieve the line number, or if kLineNumber was not passed as an option
808 * when capturing the StackTrace.
809 */
810 int GetLineNumber() const;
811
812 /**
813 * Returns the 1-based column offset on the line for the associated function
814 * call.
815 * This method will return Message::kNoColumnInfo if it is unable to retrieve
816 * the column number, or if kColumnOffset was not passed as an option when
817 * capturing the StackTrace.
818 */
819 int GetColumn() const;
820
821 /**
822 * Returns the name of the resource that contains the script for the
823 * function for this StackFrame.
824 */
825 Local<String> GetScriptName() const;
826
827 /**
ager@chromium.orgb61a0d12010-10-13 08:35:23 +0000828 * Returns the name of the resource that contains the script for the
829 * function for this StackFrame or sourceURL value if the script name
830 * is undefined and its source ends with //@ sourceURL=... string.
831 */
832 Local<String> GetScriptNameOrSourceURL() const;
833
834 /**
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +0000835 * Returns the name of the function associated with this stack frame.
836 */
837 Local<String> GetFunctionName() const;
838
839 /**
840 * Returns whether or not the associated function is compiled via a call to
841 * eval().
842 */
843 bool IsEval() const;
844
845 /**
vegorov@chromium.org7304bca2011-05-16 12:14:13 +0000846 * Returns whether or not the associated function is called as a
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +0000847 * constructor via "new".
848 */
849 bool IsConstructor() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000850};
851
852
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +0000853// --- Value ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000854
855
856/**
v8.team.kasperl727e9952008-09-02 14:56:44 +0000857 * The superclass of all JavaScript values and objects.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000858 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000859class Value : public Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000860 public:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000861 /**
862 * Returns true if this value is the undefined value. See ECMA-262
863 * 4.3.10.
864 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000865 V8EXPORT bool IsUndefined() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000866
867 /**
868 * Returns true if this value is the null value. See ECMA-262
869 * 4.3.11.
870 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000871 V8EXPORT bool IsNull() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000872
873 /**
874 * Returns true if this value is true.
875 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000876 V8EXPORT bool IsTrue() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000877
878 /**
879 * Returns true if this value is false.
880 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000881 V8EXPORT bool IsFalse() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000882
883 /**
884 * Returns true if this value is an instance of the String type.
885 * See ECMA-262 8.4.
886 */
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000887 inline bool IsString() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000888
889 /**
890 * Returns true if this value is a function.
891 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000892 V8EXPORT bool IsFunction() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000893
894 /**
895 * Returns true if this value is an array.
896 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000897 V8EXPORT bool IsArray() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000898
v8.team.kasperl727e9952008-09-02 14:56:44 +0000899 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000900 * Returns true if this value is an object.
901 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000902 V8EXPORT bool IsObject() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000903
v8.team.kasperl727e9952008-09-02 14:56:44 +0000904 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000905 * Returns true if this value is boolean.
906 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000907 V8EXPORT bool IsBoolean() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000908
v8.team.kasperl727e9952008-09-02 14:56:44 +0000909 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000910 * Returns true if this value is a number.
911 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000912 V8EXPORT bool IsNumber() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000913
v8.team.kasperl727e9952008-09-02 14:56:44 +0000914 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000915 * Returns true if this value is external.
916 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000917 V8EXPORT bool IsExternal() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000918
v8.team.kasperl727e9952008-09-02 14:56:44 +0000919 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000920 * Returns true if this value is a 32-bit signed integer.
921 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000922 V8EXPORT bool IsInt32() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000923
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000924 /**
lrn@chromium.orgc34f5802010-04-28 12:53:43 +0000925 * Returns true if this value is a 32-bit unsigned integer.
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000926 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000927 V8EXPORT bool IsUint32() const;
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000928
929 /**
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000930 * Returns true if this value is a Date.
931 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000932 V8EXPORT bool IsDate() const;
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000933
vegorov@chromium.org26c16f82010-08-11 13:41:03 +0000934 /**
svenpanne@chromium.org84bcc552011-07-18 09:50:57 +0000935 * Returns true if this value is a Boolean object.
936 */
937 V8EXPORT bool IsBooleanObject() const;
938
939 /**
940 * Returns true if this value is a Number object.
941 */
942 V8EXPORT bool IsNumberObject() const;
943
944 /**
945 * Returns true if this value is a String object.
946 */
947 V8EXPORT bool IsStringObject() const;
948
949 /**
950 * Returns true if this value is a NativeError.
951 */
952 V8EXPORT bool IsNativeError() const;
953
954 /**
vegorov@chromium.org26c16f82010-08-11 13:41:03 +0000955 * Returns true if this value is a RegExp.
956 */
957 V8EXPORT bool IsRegExp() const;
958
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000959 V8EXPORT Local<Boolean> ToBoolean() const;
960 V8EXPORT Local<Number> ToNumber() const;
961 V8EXPORT Local<String> ToString() const;
962 V8EXPORT Local<String> ToDetailString() const;
963 V8EXPORT Local<Object> ToObject() const;
964 V8EXPORT Local<Integer> ToInteger() const;
965 V8EXPORT Local<Uint32> ToUint32() const;
966 V8EXPORT Local<Int32> ToInt32() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000967
968 /**
969 * Attempts to convert a string to an array index.
970 * Returns an empty handle if the conversion fails.
971 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000972 V8EXPORT Local<Uint32> ToArrayIndex() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000973
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000974 V8EXPORT bool BooleanValue() const;
975 V8EXPORT double NumberValue() const;
976 V8EXPORT int64_t IntegerValue() const;
977 V8EXPORT uint32_t Uint32Value() const;
978 V8EXPORT int32_t Int32Value() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000979
980 /** JS == */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000981 V8EXPORT bool Equals(Handle<Value> that) const;
982 V8EXPORT bool StrictEquals(Handle<Value> that) const;
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +0000983
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000984 private:
985 inline bool QuickIsString() const;
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000986 V8EXPORT bool FullIsString() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000987};
988
989
990/**
991 * The superclass of primitive values. See ECMA-262 4.3.2.
992 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000993class Primitive : public Value { };
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000994
995
996/**
997 * A primitive boolean value (ECMA-262, 4.3.14). Either the true
998 * or false value.
999 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001000class Boolean : public Primitive {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001001 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001002 V8EXPORT bool Value() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001003 static inline Handle<Boolean> New(bool value);
1004};
1005
1006
1007/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001008 * A JavaScript string value (ECMA-262, 4.3.17).
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001009 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001010class String : public Primitive {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001011 public:
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001012 /**
1013 * Returns the number of characters in this string.
1014 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001015 V8EXPORT int Length() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001016
v8.team.kasperl727e9952008-09-02 14:56:44 +00001017 /**
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001018 * Returns the number of bytes in the UTF-8 encoded
1019 * representation of this string.
1020 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001021 V8EXPORT int Utf8Length() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001022
1023 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001024 * Write the contents of the string to an external buffer.
1025 * If no arguments are given, expects the buffer to be large
1026 * enough to hold the entire string and NULL terminator. Copies
1027 * the contents of the string and the NULL terminator into the
1028 * buffer.
1029 *
ager@chromium.org5f0c45f2010-12-17 08:51:21 +00001030 * WriteUtf8 will not write partial UTF-8 sequences, preferring to stop
1031 * before the end of the buffer.
1032 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00001033 * Copies up to length characters into the output buffer.
1034 * Only null-terminates if there is enough space in the buffer.
1035 *
1036 * \param buffer The buffer into which the string will be copied.
1037 * \param start The starting position within the string at which
1038 * copying begins.
ager@chromium.org5f0c45f2010-12-17 08:51:21 +00001039 * \param length The number of characters to copy from the string. For
1040 * WriteUtf8 the number of bytes in the buffer.
ager@chromium.org357bf652010-04-12 11:30:10 +00001041 * \param nchars_ref The number of characters written, can be NULL.
ricow@chromium.orgc9c80822010-04-21 08:22:37 +00001042 * \param hints Various hints that might affect performance of this or
1043 * subsequent operations.
ager@chromium.org5f0c45f2010-12-17 08:51:21 +00001044 * \return The number of characters copied to the buffer excluding the null
1045 * terminator. For WriteUtf8: The number of bytes copied to the buffer
1046 * including the null terminator.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001047 */
whesse@chromium.orgb6e43bb2010-04-14 09:36:28 +00001048 enum WriteHints {
1049 NO_HINTS = 0,
1050 HINT_MANY_WRITES_EXPECTED = 1
1051 };
1052
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001053 V8EXPORT int Write(uint16_t* buffer,
1054 int start = 0,
1055 int length = -1,
1056 WriteHints hints = NO_HINTS) const; // UTF-16
1057 V8EXPORT int WriteAscii(char* buffer,
1058 int start = 0,
1059 int length = -1,
1060 WriteHints hints = NO_HINTS) const; // ASCII
1061 V8EXPORT int WriteUtf8(char* buffer,
1062 int length = -1,
1063 int* nchars_ref = NULL,
1064 WriteHints hints = NO_HINTS) const; // UTF-8
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001065
v8.team.kasperl727e9952008-09-02 14:56:44 +00001066 /**
ager@chromium.org563b8dc2009-03-20 14:23:52 +00001067 * A zero length string.
1068 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001069 V8EXPORT static v8::Local<v8::String> Empty();
ager@chromium.org563b8dc2009-03-20 14:23:52 +00001070
1071 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001072 * Returns true if the string is external
1073 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001074 V8EXPORT bool IsExternal() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001075
v8.team.kasperl727e9952008-09-02 14:56:44 +00001076 /**
1077 * Returns true if the string is both external and ascii
1078 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001079 V8EXPORT bool IsExternalAscii() const;
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001080
whesse@chromium.orgf0ac72d2010-11-08 12:47:26 +00001081 class V8EXPORT ExternalStringResourceBase { // NOLINT
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001082 public:
1083 virtual ~ExternalStringResourceBase() {}
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001084
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001085 protected:
1086 ExternalStringResourceBase() {}
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001087
1088 /**
1089 * Internally V8 will call this Dispose method when the external string
1090 * resource is no longer needed. The default implementation will use the
1091 * delete operator. This method can be overridden in subclasses to
1092 * control how allocated external string resources are disposed.
1093 */
1094 virtual void Dispose() { delete this; }
1095
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001096 private:
1097 // Disallow copying and assigning.
1098 ExternalStringResourceBase(const ExternalStringResourceBase&);
1099 void operator=(const ExternalStringResourceBase&);
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001100
1101 friend class v8::internal::Heap;
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001102 };
1103
v8.team.kasperl727e9952008-09-02 14:56:44 +00001104 /**
1105 * An ExternalStringResource is a wrapper around a two-byte string
1106 * buffer that resides outside V8's heap. Implement an
1107 * ExternalStringResource to manage the life cycle of the underlying
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001108 * buffer. Note that the string data must be immutable.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001109 */
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001110 class V8EXPORT ExternalStringResource
1111 : public ExternalStringResourceBase {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001112 public:
1113 /**
1114 * Override the destructor to manage the life cycle of the underlying
1115 * buffer.
1116 */
1117 virtual ~ExternalStringResource() {}
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001118
1119 /**
1120 * The string data from the underlying buffer.
1121 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001122 virtual const uint16_t* data() const = 0;
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001123
1124 /**
1125 * The length of the string. That is, the number of two-byte characters.
1126 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001127 virtual size_t length() const = 0;
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001128
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001129 protected:
1130 ExternalStringResource() {}
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001131 };
1132
1133 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001134 * An ExternalAsciiStringResource is a wrapper around an ascii
1135 * string buffer that resides outside V8's heap. Implement an
1136 * ExternalAsciiStringResource to manage the life cycle of the
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001137 * underlying buffer. Note that the string data must be immutable
1138 * and that the data must be strict 7-bit ASCII, not Latin1 or
1139 * UTF-8, which would require special treatment internally in the
1140 * engine and, in the case of UTF-8, do not allow efficient indexing.
1141 * Use String::New or convert to 16 bit data for non-ASCII.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001142 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001143
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001144 class V8EXPORT ExternalAsciiStringResource
1145 : public ExternalStringResourceBase {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001146 public:
1147 /**
1148 * Override the destructor to manage the life cycle of the underlying
1149 * buffer.
1150 */
1151 virtual ~ExternalAsciiStringResource() {}
1152 /** The string data from the underlying buffer.*/
1153 virtual const char* data() const = 0;
1154 /** The number of ascii characters in the string.*/
1155 virtual size_t length() const = 0;
1156 protected:
1157 ExternalAsciiStringResource() {}
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001158 };
1159
1160 /**
ager@chromium.org9085a012009-05-11 19:22:57 +00001161 * Get the ExternalStringResource for an external string. Returns
1162 * NULL if IsExternal() doesn't return true.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001163 */
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001164 inline ExternalStringResource* GetExternalStringResource() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001165
1166 /**
1167 * Get the ExternalAsciiStringResource for an external ascii string.
ager@chromium.org9085a012009-05-11 19:22:57 +00001168 * Returns NULL if IsExternalAscii() doesn't return true.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001169 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001170 V8EXPORT ExternalAsciiStringResource* GetExternalAsciiStringResource() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001171
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001172 static inline String* Cast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001173
1174 /**
1175 * Allocates a new string from either utf-8 encoded or ascii data.
1176 * The second parameter 'length' gives the buffer length.
1177 * If the data is utf-8 encoded, the caller must
1178 * be careful to supply the length parameter.
1179 * If it is not given, the function calls
1180 * 'strlen' to determine the buffer length, it might be
kasper.lund7276f142008-07-30 08:49:36 +00001181 * wrong if 'data' contains a null character.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001182 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001183 V8EXPORT static Local<String> New(const char* data, int length = -1);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001184
1185 /** Allocates a new string from utf16 data.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001186 V8EXPORT static Local<String> New(const uint16_t* data, int length = -1);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001187
1188 /** Creates a symbol. Returns one if it exists already.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001189 V8EXPORT static Local<String> NewSymbol(const char* data, int length = -1);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001190
v8.team.kasperl727e9952008-09-02 14:56:44 +00001191 /**
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001192 * Creates a new string by concatenating the left and the right strings
1193 * passed in as parameters.
1194 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001195 V8EXPORT static Local<String> Concat(Handle<String> left,
1196 Handle<String>right);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001197
1198 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001199 * Creates a new external string using the data defined in the given
lrn@chromium.org1af7e1b2010-06-07 11:12:01 +00001200 * resource. When the external string is no longer live on V8's heap the
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001201 * resource will be disposed by calling its Dispose method. The caller of
1202 * this function should not otherwise delete or modify the resource. Neither
1203 * should the underlying buffer be deallocated or modified except through the
1204 * destructor of the external string resource.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001205 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001206 V8EXPORT static Local<String> NewExternal(ExternalStringResource* resource);
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001207
ager@chromium.org6f10e412009-02-13 10:11:16 +00001208 /**
1209 * Associate an external string resource with this string by transforming it
1210 * in place so that existing references to this string in the JavaScript heap
1211 * will use the external string resource. The external string resource's
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00001212 * character contents need to be equivalent to this string.
ager@chromium.org6f10e412009-02-13 10:11:16 +00001213 * Returns true if the string has been changed to be an external string.
lrn@chromium.org1af7e1b2010-06-07 11:12:01 +00001214 * The string is not modified if the operation fails. See NewExternal for
1215 * information on the lifetime of the resource.
ager@chromium.org6f10e412009-02-13 10:11:16 +00001216 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001217 V8EXPORT bool MakeExternal(ExternalStringResource* resource);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001218
v8.team.kasperl727e9952008-09-02 14:56:44 +00001219 /**
1220 * Creates a new external string using the ascii data defined in the given
lrn@chromium.org1af7e1b2010-06-07 11:12:01 +00001221 * resource. When the external string is no longer live on V8's heap the
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001222 * resource will be disposed by calling its Dispose method. The caller of
1223 * this function should not otherwise delete or modify the resource. Neither
1224 * should the underlying buffer be deallocated or modified except through the
1225 * destructor of the external string resource.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001226 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001227 V8EXPORT static Local<String> NewExternal(
1228 ExternalAsciiStringResource* resource);
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001229
ager@chromium.org6f10e412009-02-13 10:11:16 +00001230 /**
1231 * Associate an external string resource with this string by transforming it
1232 * in place so that existing references to this string in the JavaScript heap
1233 * will use the external string resource. The external string resource's
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00001234 * character contents need to be equivalent to this string.
ager@chromium.org6f10e412009-02-13 10:11:16 +00001235 * Returns true if the string has been changed to be an external string.
lrn@chromium.org1af7e1b2010-06-07 11:12:01 +00001236 * The string is not modified if the operation fails. See NewExternal for
1237 * information on the lifetime of the resource.
ager@chromium.org6f10e412009-02-13 10:11:16 +00001238 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001239 V8EXPORT bool MakeExternal(ExternalAsciiStringResource* resource);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001240
christian.plesner.hansen@gmail.com5a6af922009-08-12 14:20:51 +00001241 /**
1242 * Returns true if this string can be made external.
1243 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001244 V8EXPORT bool CanMakeExternal();
christian.plesner.hansen@gmail.com5a6af922009-08-12 14:20:51 +00001245
kasper.lund7276f142008-07-30 08:49:36 +00001246 /** Creates an undetectable string from the supplied ascii or utf-8 data.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001247 V8EXPORT static Local<String> NewUndetectable(const char* data,
1248 int length = -1);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001249
kasper.lund7276f142008-07-30 08:49:36 +00001250 /** Creates an undetectable string from the supplied utf-16 data.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001251 V8EXPORT static Local<String> NewUndetectable(const uint16_t* data,
1252 int length = -1);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001253
1254 /**
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001255 * Converts an object to a utf8-encoded character array. Useful if
ager@chromium.org71daaf62009-04-01 07:22:49 +00001256 * you want to print the object. If conversion to a string fails
1257 * (eg. due to an exception in the toString() method of the object)
1258 * then the length() method returns 0 and the * operator returns
1259 * NULL.
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001260 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001261 class V8EXPORT Utf8Value {
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001262 public:
1263 explicit Utf8Value(Handle<v8::Value> obj);
1264 ~Utf8Value();
ager@chromium.orga1645e22009-09-09 19:27:10 +00001265 char* operator*() { return str_; }
1266 const char* operator*() const { return str_; }
1267 int length() const { return length_; }
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001268 private:
1269 char* str_;
1270 int length_;
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00001271
1272 // Disallow copying and assigning.
1273 Utf8Value(const Utf8Value&);
1274 void operator=(const Utf8Value&);
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001275 };
1276
1277 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001278 * Converts an object to an ascii string.
1279 * Useful if you want to print the object.
ager@chromium.org71daaf62009-04-01 07:22:49 +00001280 * If conversion to a string fails (eg. due to an exception in the toString()
1281 * method of the object) then the length() method returns 0 and the * operator
1282 * returns NULL.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001283 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001284 class V8EXPORT AsciiValue {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001285 public:
1286 explicit AsciiValue(Handle<v8::Value> obj);
1287 ~AsciiValue();
ager@chromium.orga1645e22009-09-09 19:27:10 +00001288 char* operator*() { return str_; }
1289 const char* operator*() const { return str_; }
1290 int length() const { return length_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001291 private:
1292 char* str_;
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001293 int length_;
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00001294
1295 // Disallow copying and assigning.
1296 AsciiValue(const AsciiValue&);
1297 void operator=(const AsciiValue&);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001298 };
1299
1300 /**
1301 * Converts an object to a two-byte string.
ager@chromium.org71daaf62009-04-01 07:22:49 +00001302 * If conversion to a string fails (eg. due to an exception in the toString()
1303 * method of the object) then the length() method returns 0 and the * operator
1304 * returns NULL.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001305 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001306 class V8EXPORT Value {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001307 public:
1308 explicit Value(Handle<v8::Value> obj);
1309 ~Value();
ager@chromium.orga1645e22009-09-09 19:27:10 +00001310 uint16_t* operator*() { return str_; }
1311 const uint16_t* operator*() const { return str_; }
1312 int length() const { return length_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001313 private:
1314 uint16_t* str_;
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001315 int length_;
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00001316
1317 // Disallow copying and assigning.
1318 Value(const Value&);
1319 void operator=(const Value&);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001320 };
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001321
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001322 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001323 V8EXPORT void VerifyExternalStringResource(ExternalStringResource* val) const;
1324 V8EXPORT static void CheckCast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001325};
1326
1327
1328/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001329 * A JavaScript number value (ECMA-262, 4.3.20)
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001330 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001331class Number : public Primitive {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001332 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001333 V8EXPORT double Value() const;
1334 V8EXPORT static Local<Number> New(double value);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001335 static inline Number* Cast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001336 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001337 V8EXPORT Number();
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001338 static void CheckCast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001339};
1340
1341
1342/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001343 * A JavaScript value representing a signed integer.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001344 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001345class Integer : public Number {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001346 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001347 V8EXPORT static Local<Integer> New(int32_t value);
1348 V8EXPORT static Local<Integer> NewFromUnsigned(uint32_t value);
1349 V8EXPORT int64_t Value() const;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001350 static inline Integer* Cast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001351 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001352 V8EXPORT Integer();
1353 V8EXPORT static void CheckCast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001354};
1355
1356
1357/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001358 * A JavaScript value representing a 32-bit signed integer.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001359 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001360class Int32 : public Integer {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001361 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001362 V8EXPORT int32_t Value() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001363 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001364 V8EXPORT Int32();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001365};
1366
1367
1368/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001369 * A JavaScript value representing a 32-bit unsigned integer.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001370 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001371class Uint32 : public Integer {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001372 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001373 V8EXPORT uint32_t Value() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001374 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001375 V8EXPORT Uint32();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001376};
1377
1378
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001379enum PropertyAttribute {
1380 None = 0,
1381 ReadOnly = 1 << 0,
1382 DontEnum = 1 << 1,
1383 DontDelete = 1 << 2
1384};
1385
ager@chromium.org3811b432009-10-28 14:53:37 +00001386enum ExternalArrayType {
1387 kExternalByteArray = 1,
1388 kExternalUnsignedByteArray,
1389 kExternalShortArray,
1390 kExternalUnsignedShortArray,
1391 kExternalIntArray,
1392 kExternalUnsignedIntArray,
danno@chromium.org4d3fe4e2011-03-10 10:14:28 +00001393 kExternalFloatArray,
erik.corry@gmail.com3847bd52011-04-27 10:38:56 +00001394 kExternalDoubleArray,
danno@chromium.org4d3fe4e2011-03-10 10:14:28 +00001395 kExternalPixelArray
ager@chromium.org3811b432009-10-28 14:53:37 +00001396};
1397
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001398/**
kmillikin@chromium.org9155e252010-05-26 13:27:57 +00001399 * Accessor[Getter|Setter] are used as callback functions when
1400 * setting|getting a particular property. See Object and ObjectTemplate's
1401 * method SetAccessor.
1402 */
1403typedef Handle<Value> (*AccessorGetter)(Local<String> property,
1404 const AccessorInfo& info);
1405
1406
1407typedef void (*AccessorSetter)(Local<String> property,
1408 Local<Value> value,
1409 const AccessorInfo& info);
1410
1411
1412/**
1413 * Access control specifications.
1414 *
1415 * Some accessors should be accessible across contexts. These
1416 * accessors have an explicit access control parameter which specifies
1417 * the kind of cross-context access that should be allowed.
1418 *
1419 * Additionally, for security, accessors can prohibit overwriting by
1420 * accessors defined in JavaScript. For objects that have such
1421 * accessors either locally or in their prototype chain it is not
1422 * possible to overwrite the accessor by using __defineGetter__ or
1423 * __defineSetter__ from JavaScript code.
1424 */
1425enum AccessControl {
1426 DEFAULT = 0,
1427 ALL_CAN_READ = 1,
1428 ALL_CAN_WRITE = 1 << 1,
1429 PROHIBITS_OVERWRITING = 1 << 2
1430};
1431
1432
1433/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001434 * A JavaScript object (ECMA-262, 4.3.3)
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001435 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001436class Object : public Value {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001437 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001438 V8EXPORT bool Set(Handle<Value> key,
1439 Handle<Value> value,
1440 PropertyAttribute attribs = None);
ager@chromium.org65dad4b2009-04-23 08:48:43 +00001441
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001442 V8EXPORT bool Set(uint32_t index,
1443 Handle<Value> value);
ager@chromium.orgce5e87b2010-03-10 10:24:18 +00001444
ager@chromium.orge2902be2009-06-08 12:21:35 +00001445 // Sets a local property on this object bypassing interceptors and
ager@chromium.org65dad4b2009-04-23 08:48:43 +00001446 // overriding accessors or read-only properties.
1447 //
1448 // Note that if the object has an interceptor the property will be set
1449 // locally, but since the interceptor takes precedence the local property
1450 // will only be returned if the interceptor doesn't return a value.
1451 //
1452 // Note also that this only works for named properties.
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001453 V8EXPORT bool ForceSet(Handle<Value> key,
1454 Handle<Value> value,
1455 PropertyAttribute attribs = None);
ager@chromium.orge2902be2009-06-08 12:21:35 +00001456
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001457 V8EXPORT Local<Value> Get(Handle<Value> key);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001458
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001459 V8EXPORT Local<Value> Get(uint32_t index);
ager@chromium.orgce5e87b2010-03-10 10:24:18 +00001460
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001461 // TODO(1245389): Replace the type-specific versions of these
1462 // functions with generic ones that accept a Handle<Value> key.
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001463 V8EXPORT bool Has(Handle<String> key);
ager@chromium.orge2902be2009-06-08 12:21:35 +00001464
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001465 V8EXPORT bool Delete(Handle<String> key);
ager@chromium.orge2902be2009-06-08 12:21:35 +00001466
1467 // Delete a property on this object bypassing interceptors and
1468 // ignoring dont-delete attributes.
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001469 V8EXPORT bool ForceDelete(Handle<Value> key);
ager@chromium.orge2902be2009-06-08 12:21:35 +00001470
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001471 V8EXPORT bool Has(uint32_t index);
ager@chromium.orge2902be2009-06-08 12:21:35 +00001472
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001473 V8EXPORT bool Delete(uint32_t index);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001474
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001475 V8EXPORT bool SetAccessor(Handle<String> name,
1476 AccessorGetter getter,
1477 AccessorSetter setter = 0,
1478 Handle<Value> data = Handle<Value>(),
1479 AccessControl settings = DEFAULT,
1480 PropertyAttribute attribute = None);
kmillikin@chromium.org9155e252010-05-26 13:27:57 +00001481
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001482 /**
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00001483 * Returns an array containing the names of the enumerable properties
1484 * of this object, including properties from prototype objects. The
1485 * array returned by this method contains the same values as would
1486 * be enumerated by a for-in statement over this object.
1487 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001488 V8EXPORT Local<Array> GetPropertyNames();
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00001489
1490 /**
svenpanne@chromium.org6d786c92011-06-15 10:58:27 +00001491 * This function has the same functionality as GetPropertyNames but
1492 * the returned array doesn't contain the names of properties from
1493 * prototype objects.
1494 */
1495 V8EXPORT Local<Array> GetOwnPropertyNames();
1496
1497 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001498 * Get the prototype object. This does not skip objects marked to
1499 * be skipped by __proto__ and it does not consult the security
1500 * handler.
1501 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001502 V8EXPORT Local<Value> GetPrototype();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001503
1504 /**
ager@chromium.org5c838252010-02-19 08:53:10 +00001505 * Set the prototype object. This does not skip objects marked to
1506 * be skipped by __proto__ and it does not consult the security
1507 * handler.
1508 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001509 V8EXPORT bool SetPrototype(Handle<Value> prototype);
ager@chromium.org5c838252010-02-19 08:53:10 +00001510
1511 /**
sgjesse@chromium.org900d3b72009-08-07 11:24:25 +00001512 * Finds an instance of the given function template in the prototype
1513 * chain.
1514 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001515 V8EXPORT Local<Object> FindInstanceInPrototypeChain(
1516 Handle<FunctionTemplate> tmpl);
sgjesse@chromium.org900d3b72009-08-07 11:24:25 +00001517
1518 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001519 * Call builtin Object.prototype.toString on this object.
1520 * This is different from Value::ToString() that may call
1521 * user-defined toString function. This one does not.
1522 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001523 V8EXPORT Local<String> ObjectProtoToString();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001524
ager@chromium.orgbeb25712010-11-29 08:02:25 +00001525 /**
1526 * Returns the name of the function invoked as a constructor for this object.
1527 */
1528 V8EXPORT Local<String> GetConstructorName();
1529
kasper.lund212ac232008-07-16 07:07:30 +00001530 /** Gets the number of internal fields for this Object. */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001531 V8EXPORT int InternalFieldCount();
kasper.lund212ac232008-07-16 07:07:30 +00001532 /** Gets the value in an internal field. */
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001533 inline Local<Value> GetInternalField(int index);
kasper.lund212ac232008-07-16 07:07:30 +00001534 /** Sets the value in an internal field. */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001535 V8EXPORT void SetInternalField(int index, Handle<Value> value);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001536
kasperl@chromium.orge959c182009-07-27 08:59:04 +00001537 /** Gets a native pointer from an internal field. */
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001538 inline void* GetPointerFromInternalField(int index);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001539
kasperl@chromium.orge959c182009-07-27 08:59:04 +00001540 /** Sets a native pointer in an internal field. */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001541 V8EXPORT void SetPointerInInternalField(int index, void* value);
kasperl@chromium.orge959c182009-07-27 08:59:04 +00001542
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001543 // Testers for local properties.
sgjesse@chromium.org8e8294a2011-05-02 14:30:53 +00001544 V8EXPORT bool HasOwnProperty(Handle<String> key);
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001545 V8EXPORT bool HasRealNamedProperty(Handle<String> key);
1546 V8EXPORT bool HasRealIndexedProperty(uint32_t index);
1547 V8EXPORT bool HasRealNamedCallbackProperty(Handle<String> key);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001548
1549 /**
1550 * If result.IsEmpty() no real property was located in the prototype chain.
1551 * This means interceptors in the prototype chain are not called.
1552 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001553 V8EXPORT Local<Value> GetRealNamedPropertyInPrototypeChain(
1554 Handle<String> key);
sgjesse@chromium.org98aff2f2009-09-30 08:27:10 +00001555
1556 /**
1557 * If result.IsEmpty() no real property was located on the object or
1558 * in the prototype chain.
1559 * This means interceptors in the prototype chain are not called.
1560 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001561 V8EXPORT Local<Value> GetRealNamedProperty(Handle<String> key);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001562
1563 /** Tests for a named lookup interceptor.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001564 V8EXPORT bool HasNamedLookupInterceptor();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001565
kasper.lund212ac232008-07-16 07:07:30 +00001566 /** Tests for an index lookup interceptor.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001567 V8EXPORT bool HasIndexedLookupInterceptor();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001568
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00001569 /**
1570 * Turns on access check on the object if the object is an instance of
1571 * a template that has access check callbacks. If an object has no
1572 * access check info, the object cannot be accessed by anyone.
1573 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001574 V8EXPORT void TurnOnAccessCheck();
ager@chromium.org41826e72009-03-30 13:30:57 +00001575
ager@chromium.org3b45ab52009-03-19 22:21:34 +00001576 /**
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00001577 * Returns the identity hash for this object. The current implementation
1578 * uses a hidden property on the object to store the identity hash.
ager@chromium.org5ec48922009-05-05 07:25:34 +00001579 *
ager@chromium.org9085a012009-05-11 19:22:57 +00001580 * The return value will never be 0. Also, it is not guaranteed to be
ager@chromium.org5ec48922009-05-05 07:25:34 +00001581 * unique.
ager@chromium.org3b45ab52009-03-19 22:21:34 +00001582 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001583 V8EXPORT int GetIdentityHash();
ager@chromium.org41826e72009-03-30 13:30:57 +00001584
ager@chromium.org3b45ab52009-03-19 22:21:34 +00001585 /**
1586 * Access hidden properties on JavaScript objects. These properties are
1587 * hidden from the executing JavaScript and only accessible through the V8
1588 * C++ API. Hidden properties introduced by V8 internally (for example the
1589 * identity hash) are prefixed with "v8::".
1590 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001591 V8EXPORT bool SetHiddenValue(Handle<String> key, Handle<Value> value);
1592 V8EXPORT Local<Value> GetHiddenValue(Handle<String> key);
1593 V8EXPORT bool DeleteHiddenValue(Handle<String> key);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001594
christian.plesner.hansen@gmail.com2bc58ef2009-09-22 10:00:30 +00001595 /**
1596 * Returns true if this is an instance of an api function (one
1597 * created from a function created from a function template) and has
1598 * been modified since it was created. Note that this method is
1599 * conservative and may return true for objects that haven't actually
1600 * been modified.
1601 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001602 V8EXPORT bool IsDirty();
ager@chromium.org3b45ab52009-03-19 22:21:34 +00001603
1604 /**
1605 * Clone this object with a fast but shallow copy. Values will point
1606 * to the same values as the original object.
1607 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001608 V8EXPORT Local<Object> Clone();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001609
sgjesse@chromium.org0b6db592009-07-30 14:48:31 +00001610 /**
kmillikin@chromium.orgc36ce6e2011-04-04 08:25:31 +00001611 * Returns the context in which the object was created.
1612 */
1613 V8EXPORT Local<Context> CreationContext();
1614
1615 /**
sgjesse@chromium.org0b6db592009-07-30 14:48:31 +00001616 * Set the backing store of the indexed properties to be managed by the
1617 * embedding layer. Access to the indexed properties will follow the rules
1618 * spelled out in CanvasPixelArray.
1619 * Note: The embedding program still owns the data and needs to ensure that
1620 * the backing store is preserved while V8 has a reference.
1621 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001622 V8EXPORT void SetIndexedPropertiesToPixelData(uint8_t* data, int length);
lrn@chromium.org5d00b602011-01-05 09:51:43 +00001623 V8EXPORT bool HasIndexedPropertiesInPixelData();
1624 V8EXPORT uint8_t* GetIndexedPropertiesPixelData();
1625 V8EXPORT int GetIndexedPropertiesPixelDataLength();
sgjesse@chromium.org0b6db592009-07-30 14:48:31 +00001626
ager@chromium.org3811b432009-10-28 14:53:37 +00001627 /**
1628 * Set the backing store of the indexed properties to be managed by the
1629 * embedding layer. Access to the indexed properties will follow the rules
1630 * spelled out for the CanvasArray subtypes in the WebGL specification.
1631 * Note: The embedding program still owns the data and needs to ensure that
1632 * the backing store is preserved while V8 has a reference.
1633 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001634 V8EXPORT void SetIndexedPropertiesToExternalArrayData(
1635 void* data,
1636 ExternalArrayType array_type,
1637 int number_of_elements);
lrn@chromium.org5d00b602011-01-05 09:51:43 +00001638 V8EXPORT bool HasIndexedPropertiesInExternalArrayData();
1639 V8EXPORT void* GetIndexedPropertiesExternalArrayData();
1640 V8EXPORT ExternalArrayType GetIndexedPropertiesExternalArrayDataType();
1641 V8EXPORT int GetIndexedPropertiesExternalArrayDataLength();
ager@chromium.org3811b432009-10-28 14:53:37 +00001642
lrn@chromium.org1c092762011-05-09 09:42:16 +00001643 /**
karlklose@chromium.org83a47282011-05-11 11:54:09 +00001644 * Checks whether a callback is set by the
1645 * ObjectTemplate::SetCallAsFunctionHandler method.
1646 * When an Object is callable this method returns true.
1647 */
1648 V8EXPORT bool IsCallable();
1649
1650 /**
lrn@chromium.org1c092762011-05-09 09:42:16 +00001651 * Call an Object as a function if a callback is set by the
1652 * ObjectTemplate::SetCallAsFunctionHandler method.
1653 */
1654 V8EXPORT Local<Value> CallAsFunction(Handle<Object> recv,
1655 int argc,
1656 Handle<Value> argv[]);
1657
1658 /**
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00001659 * Call an Object as a constructor if a callback is set by the
lrn@chromium.org1c092762011-05-09 09:42:16 +00001660 * ObjectTemplate::SetCallAsFunctionHandler method.
1661 * Note: This method behaves like the Function::NewInstance method.
1662 */
1663 V8EXPORT Local<Value> CallAsConstructor(int argc,
1664 Handle<Value> argv[]);
1665
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001666 V8EXPORT static Local<Object> New();
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001667 static inline Object* Cast(Value* obj);
jkummerow@chromium.orge297f592011-06-08 10:05:15 +00001668
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001669 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001670 V8EXPORT Object();
1671 V8EXPORT static void CheckCast(Value* obj);
1672 V8EXPORT Local<Value> CheckedGetInternalField(int index);
1673 V8EXPORT void* SlowGetPointerFromInternalField(int index);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001674
1675 /**
1676 * If quick access to the internal field is possible this method
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001677 * returns the value. Otherwise an empty handle is returned.
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001678 */
1679 inline Local<Value> UncheckedGetInternalField(int index);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001680};
1681
1682
1683/**
1684 * An instance of the built-in array constructor (ECMA-262, 15.4.2).
1685 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001686class Array : public Object {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001687 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001688 V8EXPORT uint32_t Length() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001689
ager@chromium.org3e875802009-06-29 08:26:34 +00001690 /**
1691 * Clones an element at index |index|. Returns an empty
1692 * handle if cloning fails (for any reason).
1693 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001694 V8EXPORT Local<Object> CloneElementAt(uint32_t index);
ager@chromium.org3e875802009-06-29 08:26:34 +00001695
ricow@chromium.orgbadaffc2011-03-17 12:15:27 +00001696 /**
1697 * Creates a JavaScript array with the given length. If the length
1698 * is negative the returned array will have length 0.
1699 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001700 V8EXPORT static Local<Array> New(int length = 0);
ricow@chromium.orgbadaffc2011-03-17 12:15:27 +00001701
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001702 static inline Array* Cast(Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001703 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001704 V8EXPORT Array();
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001705 static void CheckCast(Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001706};
1707
1708
1709/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001710 * A JavaScript function object (ECMA-262, 15.3).
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001711 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001712class Function : public Object {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001713 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001714 V8EXPORT Local<Object> NewInstance() const;
1715 V8EXPORT Local<Object> NewInstance(int argc, Handle<Value> argv[]) const;
1716 V8EXPORT Local<Value> Call(Handle<Object> recv,
1717 int argc,
1718 Handle<Value> argv[]);
1719 V8EXPORT void SetName(Handle<String> name);
1720 V8EXPORT Handle<Value> GetName() const;
ager@chromium.org5c838252010-02-19 08:53:10 +00001721
1722 /**
1723 * Returns zero based line number of function body and
1724 * kLineOffsetNotFound if no information available.
1725 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001726 V8EXPORT int GetScriptLineNumber() const;
1727 V8EXPORT ScriptOrigin GetScriptOrigin() const;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001728 static inline Function* Cast(Value* obj);
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001729 V8EXPORT static const int kLineOffsetNotFound;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001730 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001731 V8EXPORT Function();
1732 V8EXPORT static void CheckCast(Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001733};
1734
1735
1736/**
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00001737 * An instance of the built-in Date constructor (ECMA-262, 15.9).
1738 */
1739class Date : public Object {
1740 public:
1741 V8EXPORT static Local<Value> New(double time);
1742
1743 /**
1744 * A specialization of Value::NumberValue that is more efficient
1745 * because we know the structure of this object.
1746 */
1747 V8EXPORT double NumberValue() const;
1748
1749 static inline Date* Cast(v8::Value* obj);
1750
1751 /**
1752 * Notification that the embedder has changed the time zone,
1753 * daylight savings time, or other date / time configuration
1754 * parameters. V8 keeps a cache of various values used for
1755 * date / time computation. This notification will reset
1756 * those cached values for the current context so that date /
1757 * time configuration changes would be reflected in the Date
1758 * object.
1759 *
1760 * This API should not be called more than needed as it will
1761 * negatively impact the performance of date operations.
1762 */
1763 V8EXPORT static void DateTimeConfigurationChangeNotification();
1764
1765 private:
1766 V8EXPORT static void CheckCast(v8::Value* obj);
1767};
1768
1769
1770/**
svenpanne@chromium.org84bcc552011-07-18 09:50:57 +00001771 * A Number object (ECMA-262, 4.3.21).
1772 */
1773class NumberObject : public Object {
1774 public:
1775 V8EXPORT static Local<Value> New(double value);
1776
1777 /**
1778 * Returns the Number held by the object.
1779 */
1780 V8EXPORT double NumberValue() const;
1781
1782 static inline NumberObject* Cast(v8::Value* obj);
1783
1784 private:
1785 V8EXPORT static void CheckCast(v8::Value* obj);
1786};
1787
1788
1789/**
1790 * A Boolean object (ECMA-262, 4.3.15).
1791 */
1792class BooleanObject : public Object {
1793 public:
1794 V8EXPORT static Local<Value> New(bool value);
1795
1796 /**
1797 * Returns the Boolean held by the object.
1798 */
1799 V8EXPORT bool BooleanValue() const;
1800
1801 static inline BooleanObject* Cast(v8::Value* obj);
1802
1803 private:
1804 V8EXPORT static void CheckCast(v8::Value* obj);
1805};
1806
1807
1808/**
1809 * A String object (ECMA-262, 4.3.18).
1810 */
1811class StringObject : public Object {
1812 public:
1813 V8EXPORT static Local<Value> New(Handle<String> value);
1814
1815 /**
1816 * Returns the String held by the object.
1817 */
1818 V8EXPORT Local<String> StringValue() const;
1819
1820 static inline StringObject* Cast(v8::Value* obj);
1821
1822 private:
1823 V8EXPORT static void CheckCast(v8::Value* obj);
1824};
1825
1826
1827/**
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00001828 * An instance of the built-in RegExp constructor (ECMA-262, 15.10).
1829 */
1830class RegExp : public Object {
1831 public:
1832 /**
1833 * Regular expression flag bits. They can be or'ed to enable a set
1834 * of flags.
1835 */
1836 enum Flags {
1837 kNone = 0,
1838 kGlobal = 1,
1839 kIgnoreCase = 2,
1840 kMultiline = 4
1841 };
1842
1843 /**
1844 * Creates a regular expression from the given pattern string and
1845 * the flags bit field. May throw a JavaScript exception as
1846 * described in ECMA-262, 15.10.4.1.
1847 *
1848 * For example,
1849 * RegExp::New(v8::String::New("foo"),
1850 * static_cast<RegExp::Flags>(kGlobal | kMultiline))
1851 * is equivalent to evaluating "/foo/gm".
1852 */
1853 V8EXPORT static Local<RegExp> New(Handle<String> pattern,
1854 Flags flags);
1855
1856 /**
1857 * Returns the value of the source property: a string representing
1858 * the regular expression.
1859 */
1860 V8EXPORT Local<String> GetSource() const;
1861
1862 /**
1863 * Returns the flags bit field.
1864 */
1865 V8EXPORT Flags GetFlags() const;
1866
1867 static inline RegExp* Cast(v8::Value* obj);
1868
1869 private:
1870 V8EXPORT static void CheckCast(v8::Value* obj);
1871};
1872
1873
1874/**
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001875 * A JavaScript value that wraps a C++ void*. This type of value is
1876 * mainly used to associate C++ data structures with JavaScript
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001877 * objects.
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001878 *
1879 * The Wrap function V8 will return the most optimal Value object wrapping the
1880 * C++ void*. The type of the value is not guaranteed to be an External object
1881 * and no assumptions about its type should be made. To access the wrapped
1882 * value Unwrap should be used, all other operations on that object will lead
1883 * to unpredictable results.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001884 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001885class External : public Value {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001886 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001887 V8EXPORT static Local<Value> Wrap(void* data);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001888 static inline void* Unwrap(Handle<Value> obj);
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001889
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001890 V8EXPORT static Local<External> New(void* value);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001891 static inline External* Cast(Value* obj);
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001892 V8EXPORT void* Value() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001893 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001894 V8EXPORT External();
1895 V8EXPORT static void CheckCast(v8::Value* obj);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001896 static inline void* QuickUnwrap(Handle<v8::Value> obj);
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001897 V8EXPORT static void* FullUnwrap(Handle<v8::Value> obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001898};
1899
1900
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00001901// --- Templates ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001902
1903
1904/**
1905 * The superclass of object and function templates.
1906 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001907class V8EXPORT Template : public Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001908 public:
1909 /** Adds a property to each instance created by this template.*/
1910 void Set(Handle<String> name, Handle<Data> value,
1911 PropertyAttribute attributes = None);
1912 inline void Set(const char* name, Handle<Data> value);
1913 private:
1914 Template();
1915
1916 friend class ObjectTemplate;
1917 friend class FunctionTemplate;
1918};
1919
1920
1921/**
1922 * The argument information given to function call callbacks. This
v8.team.kasperl727e9952008-09-02 14:56:44 +00001923 * class provides access to information about the context of the call,
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001924 * including the receiver, the number and values of arguments, and
1925 * the holder of the function.
1926 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001927class Arguments {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001928 public:
1929 inline int Length() const;
1930 inline Local<Value> operator[](int i) const;
1931 inline Local<Function> Callee() const;
1932 inline Local<Object> This() const;
1933 inline Local<Object> Holder() const;
1934 inline bool IsConstructCall() const;
1935 inline Local<Value> Data() const;
1936 private:
fschneider@chromium.orge03fb642010-11-01 12:34:09 +00001937 static const int kDataIndex = 0;
1938 static const int kCalleeIndex = -1;
1939 static const int kHolderIndex = -2;
1940
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001941 friend class ImplementationUtilities;
fschneider@chromium.orge03fb642010-11-01 12:34:09 +00001942 inline Arguments(internal::Object** implicit_args,
1943 internal::Object** values,
1944 int length,
1945 bool is_construct_call);
1946 internal::Object** implicit_args_;
1947 internal::Object** values_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001948 int length_;
fschneider@chromium.orge03fb642010-11-01 12:34:09 +00001949 bool is_construct_call_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001950};
1951
1952
1953/**
1954 * The information passed to an accessor callback about the context
1955 * of the property access.
1956 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001957class V8EXPORT AccessorInfo {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001958 public:
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00001959 inline AccessorInfo(internal::Object** args)
1960 : args_(args) { }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001961 inline Local<Value> Data() const;
1962 inline Local<Object> This() const;
1963 inline Local<Object> Holder() const;
1964 private:
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00001965 internal::Object** args_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001966};
1967
1968
1969typedef Handle<Value> (*InvocationCallback)(const Arguments& args);
1970
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001971/**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001972 * NamedProperty[Getter|Setter] are used as interceptors on object.
1973 * See ObjectTemplate::SetNamedPropertyHandler.
1974 */
1975typedef Handle<Value> (*NamedPropertyGetter)(Local<String> property,
1976 const AccessorInfo& info);
1977
1978
1979/**
1980 * Returns the value if the setter intercepts the request.
1981 * Otherwise, returns an empty handle.
1982 */
1983typedef Handle<Value> (*NamedPropertySetter)(Local<String> property,
1984 Local<Value> value,
1985 const AccessorInfo& info);
1986
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001987/**
1988 * Returns a non-empty handle if the interceptor intercepts the request.
whesse@chromium.org2c186ca2010-06-16 11:32:39 +00001989 * The result is an integer encoding property attributes (like v8::None,
1990 * v8::DontEnum, etc.)
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001991 */
lrn@chromium.org1af7e1b2010-06-07 11:12:01 +00001992typedef Handle<Integer> (*NamedPropertyQuery)(Local<String> property,
1993 const AccessorInfo& info);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001994
1995
1996/**
1997 * Returns a non-empty handle if the deleter intercepts the request.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001998 * The return value is true if the property could be deleted and false
1999 * otherwise.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002000 */
2001typedef Handle<Boolean> (*NamedPropertyDeleter)(Local<String> property,
2002 const AccessorInfo& info);
2003
2004/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002005 * Returns an array containing the names of the properties the named
2006 * property getter intercepts.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002007 */
2008typedef Handle<Array> (*NamedPropertyEnumerator)(const AccessorInfo& info);
2009
v8.team.kasperl727e9952008-09-02 14:56:44 +00002010
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002011/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002012 * Returns the value of the property if the getter intercepts the
2013 * request. Otherwise, returns an empty handle.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002014 */
2015typedef Handle<Value> (*IndexedPropertyGetter)(uint32_t index,
2016 const AccessorInfo& info);
2017
2018
2019/**
2020 * Returns the value if the setter intercepts the request.
2021 * Otherwise, returns an empty handle.
2022 */
2023typedef Handle<Value> (*IndexedPropertySetter)(uint32_t index,
2024 Local<Value> value,
2025 const AccessorInfo& info);
2026
2027
2028/**
2029 * Returns a non-empty handle if the interceptor intercepts the request.
ager@chromium.orgea4f62e2010-08-16 16:28:43 +00002030 * The result is an integer encoding property attributes.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002031 */
vegorov@chromium.org26c16f82010-08-11 13:41:03 +00002032typedef Handle<Integer> (*IndexedPropertyQuery)(uint32_t index,
2033 const AccessorInfo& info);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002034
2035/**
2036 * Returns a non-empty handle if the deleter intercepts the request.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002037 * The return value is true if the property could be deleted and false
2038 * otherwise.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002039 */
2040typedef Handle<Boolean> (*IndexedPropertyDeleter)(uint32_t index,
2041 const AccessorInfo& info);
2042
v8.team.kasperl727e9952008-09-02 14:56:44 +00002043/**
2044 * Returns an array containing the indices of the properties the
2045 * indexed property getter intercepts.
2046 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002047typedef Handle<Array> (*IndexedPropertyEnumerator)(const AccessorInfo& info);
2048
2049
2050/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002051 * Access type specification.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002052 */
2053enum AccessType {
2054 ACCESS_GET,
2055 ACCESS_SET,
2056 ACCESS_HAS,
2057 ACCESS_DELETE,
2058 ACCESS_KEYS
2059};
2060
v8.team.kasperl727e9952008-09-02 14:56:44 +00002061
2062/**
2063 * Returns true if cross-context access should be allowed to the named
christian.plesner.hansen@gmail.com2bc58ef2009-09-22 10:00:30 +00002064 * property with the given key on the host object.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002065 */
christian.plesner.hansen@gmail.com2bc58ef2009-09-22 10:00:30 +00002066typedef bool (*NamedSecurityCallback)(Local<Object> host,
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002067 Local<Value> key,
2068 AccessType type,
2069 Local<Value> data);
2070
v8.team.kasperl727e9952008-09-02 14:56:44 +00002071
2072/**
2073 * Returns true if cross-context access should be allowed to the indexed
christian.plesner.hansen@gmail.com2bc58ef2009-09-22 10:00:30 +00002074 * property with the given index on the host object.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002075 */
christian.plesner.hansen@gmail.com2bc58ef2009-09-22 10:00:30 +00002076typedef bool (*IndexedSecurityCallback)(Local<Object> host,
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002077 uint32_t index,
2078 AccessType type,
2079 Local<Value> data);
2080
2081
2082/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002083 * A FunctionTemplate is used to create functions at runtime. There
2084 * can only be one function created from a FunctionTemplate in a
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00002085 * context. The lifetime of the created function is equal to the
2086 * lifetime of the context. So in case the embedder needs to create
2087 * temporary functions that can be collected using Scripts is
2088 * preferred.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002089 *
2090 * A FunctionTemplate can have properties, these properties are added to the
v8.team.kasperl727e9952008-09-02 14:56:44 +00002091 * function object when it is created.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002092 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002093 * A FunctionTemplate has a corresponding instance template which is
2094 * used to create object instances when the function is used as a
2095 * constructor. Properties added to the instance template are added to
2096 * each object instance.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002097 *
2098 * A FunctionTemplate can have a prototype template. The prototype template
2099 * is used to create the prototype object of the function.
2100 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002101 * The following example shows how to use a FunctionTemplate:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002102 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002103 * \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002104 * v8::Local<v8::FunctionTemplate> t = v8::FunctionTemplate::New();
2105 * t->Set("func_property", v8::Number::New(1));
2106 *
2107 * v8::Local<v8::Template> proto_t = t->PrototypeTemplate();
2108 * proto_t->Set("proto_method", v8::FunctionTemplate::New(InvokeCallback));
2109 * proto_t->Set("proto_const", v8::Number::New(2));
2110 *
2111 * v8::Local<v8::ObjectTemplate> instance_t = t->InstanceTemplate();
2112 * instance_t->SetAccessor("instance_accessor", InstanceAccessorCallback);
2113 * instance_t->SetNamedPropertyHandler(PropertyHandlerCallback, ...);
2114 * instance_t->Set("instance_property", Number::New(3));
2115 *
2116 * v8::Local<v8::Function> function = t->GetFunction();
2117 * v8::Local<v8::Object> instance = function->NewInstance();
v8.team.kasperl727e9952008-09-02 14:56:44 +00002118 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002119 *
2120 * Let's use "function" as the JS variable name of the function object
v8.team.kasperl727e9952008-09-02 14:56:44 +00002121 * and "instance" for the instance object created above. The function
2122 * and the instance will have the following properties:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002123 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002124 * \code
2125 * func_property in function == true;
2126 * function.func_property == 1;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002127 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002128 * function.prototype.proto_method() invokes 'InvokeCallback'
2129 * function.prototype.proto_const == 2;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002130 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002131 * instance instanceof function == true;
2132 * instance.instance_accessor calls 'InstanceAccessorCallback'
2133 * instance.instance_property == 3;
2134 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002135 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002136 * A FunctionTemplate can inherit from another one by calling the
2137 * FunctionTemplate::Inherit method. The following graph illustrates
2138 * the semantics of inheritance:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002139 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002140 * \code
2141 * FunctionTemplate Parent -> Parent() . prototype -> { }
2142 * ^ ^
2143 * | Inherit(Parent) | .__proto__
2144 * | |
2145 * FunctionTemplate Child -> Child() . prototype -> { }
2146 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002147 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002148 * A FunctionTemplate 'Child' inherits from 'Parent', the prototype
2149 * object of the Child() function has __proto__ pointing to the
2150 * Parent() function's prototype object. An instance of the Child
2151 * function has all properties on Parent's instance templates.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002152 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002153 * Let Parent be the FunctionTemplate initialized in the previous
2154 * section and create a Child FunctionTemplate by:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002155 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002156 * \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002157 * Local<FunctionTemplate> parent = t;
2158 * Local<FunctionTemplate> child = FunctionTemplate::New();
2159 * child->Inherit(parent);
2160 *
2161 * Local<Function> child_function = child->GetFunction();
2162 * Local<Object> child_instance = child_function->NewInstance();
v8.team.kasperl727e9952008-09-02 14:56:44 +00002163 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002164 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00002165 * The Child function and Child instance will have the following
2166 * properties:
2167 *
2168 * \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002169 * child_func.prototype.__proto__ == function.prototype;
v8.team.kasperl727e9952008-09-02 14:56:44 +00002170 * child_instance.instance_accessor calls 'InstanceAccessorCallback'
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002171 * child_instance.instance_property == 3;
v8.team.kasperl727e9952008-09-02 14:56:44 +00002172 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002173 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002174class V8EXPORT FunctionTemplate : public Template {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002175 public:
2176 /** Creates a function template.*/
v8.team.kasperl727e9952008-09-02 14:56:44 +00002177 static Local<FunctionTemplate> New(
2178 InvocationCallback callback = 0,
2179 Handle<Value> data = Handle<Value>(),
2180 Handle<Signature> signature = Handle<Signature>());
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002181 /** Returns the unique function instance in the current execution context.*/
2182 Local<Function> GetFunction();
2183
v8.team.kasperl727e9952008-09-02 14:56:44 +00002184 /**
2185 * Set the call-handler callback for a FunctionTemplate. This
2186 * callback is called whenever the function created from this
2187 * FunctionTemplate is called.
2188 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002189 void SetCallHandler(InvocationCallback callback,
2190 Handle<Value> data = Handle<Value>());
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002191
v8.team.kasperl727e9952008-09-02 14:56:44 +00002192 /** Get the InstanceTemplate. */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002193 Local<ObjectTemplate> InstanceTemplate();
2194
2195 /** Causes the function template to inherit from a parent function template.*/
2196 void Inherit(Handle<FunctionTemplate> parent);
2197
2198 /**
2199 * A PrototypeTemplate is the template used to create the prototype object
2200 * of the function created by this template.
2201 */
2202 Local<ObjectTemplate> PrototypeTemplate();
2203
v8.team.kasperl727e9952008-09-02 14:56:44 +00002204
2205 /**
2206 * Set the class name of the FunctionTemplate. This is used for
2207 * printing objects created with the function created from the
2208 * FunctionTemplate as its constructor.
2209 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002210 void SetClassName(Handle<String> name);
2211
2212 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002213 * Determines whether the __proto__ accessor ignores instances of
2214 * the function template. If instances of the function template are
2215 * ignored, __proto__ skips all instances and instead returns the
2216 * next object in the prototype chain.
2217 *
2218 * Call with a value of true to make the __proto__ accessor ignore
2219 * instances of the function template. Call with a value of false
2220 * to make the __proto__ accessor not ignore instances of the
2221 * function template. By default, instances of a function template
2222 * are not ignored.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002223 */
2224 void SetHiddenPrototype(bool value);
2225
2226 /**
ager@chromium.org04921a82011-06-27 13:21:41 +00002227 * Sets the property attributes of the 'prototype' property of functions
2228 * created from this FunctionTemplate. Can be any combination of ReadOnly,
2229 * DontEnum and DontDelete.
2230 */
2231 void SetPrototypeAttributes(int attributes);
2232
2233 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002234 * Returns true if the given object is an instance of this function
2235 * template.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002236 */
2237 bool HasInstance(Handle<Value> object);
2238
2239 private:
2240 FunctionTemplate();
2241 void AddInstancePropertyAccessor(Handle<String> name,
2242 AccessorGetter getter,
2243 AccessorSetter setter,
2244 Handle<Value> data,
2245 AccessControl settings,
2246 PropertyAttribute attributes);
2247 void SetNamedInstancePropertyHandler(NamedPropertyGetter getter,
2248 NamedPropertySetter setter,
2249 NamedPropertyQuery query,
2250 NamedPropertyDeleter remover,
2251 NamedPropertyEnumerator enumerator,
whesse@chromium.org2c186ca2010-06-16 11:32:39 +00002252 Handle<Value> data);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002253 void SetIndexedInstancePropertyHandler(IndexedPropertyGetter getter,
2254 IndexedPropertySetter setter,
2255 IndexedPropertyQuery query,
2256 IndexedPropertyDeleter remover,
2257 IndexedPropertyEnumerator enumerator,
ager@chromium.orgea4f62e2010-08-16 16:28:43 +00002258 Handle<Value> data);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002259 void SetInstanceCallAsFunctionHandler(InvocationCallback callback,
2260 Handle<Value> data);
2261
2262 friend class Context;
2263 friend class ObjectTemplate;
2264};
2265
2266
2267/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002268 * An ObjectTemplate is used to create objects at runtime.
2269 *
2270 * Properties added to an ObjectTemplate are added to each object
2271 * created from the ObjectTemplate.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002272 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002273class V8EXPORT ObjectTemplate : public Template {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002274 public:
v8.team.kasperl727e9952008-09-02 14:56:44 +00002275 /** Creates an ObjectTemplate. */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002276 static Local<ObjectTemplate> New();
v8.team.kasperl727e9952008-09-02 14:56:44 +00002277
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002278 /** Creates a new instance of this template.*/
2279 Local<Object> NewInstance();
2280
2281 /**
2282 * Sets an accessor on the object template.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002283 *
2284 * Whenever the property with the given name is accessed on objects
2285 * created from this ObjectTemplate the getter and setter callbacks
2286 * are called instead of getting and setting the property directly
2287 * on the JavaScript object.
2288 *
2289 * \param name The name of the property for which an accessor is added.
2290 * \param getter The callback to invoke when getting the property.
2291 * \param setter The callback to invoke when setting the property.
2292 * \param data A piece of data that will be passed to the getter and setter
2293 * callbacks whenever they are invoked.
2294 * \param settings Access control settings for the accessor. This is a bit
2295 * field consisting of one of more of
2296 * DEFAULT = 0, ALL_CAN_READ = 1, or ALL_CAN_WRITE = 2.
2297 * The default is to not allow cross-context access.
2298 * ALL_CAN_READ means that all cross-context reads are allowed.
2299 * ALL_CAN_WRITE means that all cross-context writes are allowed.
2300 * The combination ALL_CAN_READ | ALL_CAN_WRITE can be used to allow all
2301 * cross-context access.
2302 * \param attribute The attributes of the property for which an accessor
2303 * is added.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002304 */
2305 void SetAccessor(Handle<String> name,
2306 AccessorGetter getter,
2307 AccessorSetter setter = 0,
2308 Handle<Value> data = Handle<Value>(),
2309 AccessControl settings = DEFAULT,
2310 PropertyAttribute attribute = None);
2311
2312 /**
2313 * Sets a named property handler on the object template.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002314 *
2315 * Whenever a named property is accessed on objects created from
2316 * this object template, the provided callback is invoked instead of
2317 * accessing the property directly on the JavaScript object.
2318 *
2319 * \param getter The callback to invoke when getting a property.
2320 * \param setter The callback to invoke when setting a property.
whesse@chromium.org2c186ca2010-06-16 11:32:39 +00002321 * \param query The callback to invoke to check if a property is present,
2322 * and if present, get its attributes.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002323 * \param deleter The callback to invoke when deleting a property.
2324 * \param enumerator The callback to invoke to enumerate all the named
2325 * properties of an object.
2326 * \param data A piece of data that will be passed to the callbacks
2327 * whenever they are invoked.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002328 */
2329 void SetNamedPropertyHandler(NamedPropertyGetter getter,
2330 NamedPropertySetter setter = 0,
2331 NamedPropertyQuery query = 0,
2332 NamedPropertyDeleter deleter = 0,
2333 NamedPropertyEnumerator enumerator = 0,
whesse@chromium.org2c186ca2010-06-16 11:32:39 +00002334 Handle<Value> data = Handle<Value>());
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002335
2336 /**
2337 * Sets an indexed property handler on the object template.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002338 *
2339 * Whenever an indexed property is accessed on objects created from
2340 * this object template, the provided callback is invoked instead of
2341 * accessing the property directly on the JavaScript object.
2342 *
2343 * \param getter The callback to invoke when getting a property.
2344 * \param setter The callback to invoke when setting a property.
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00002345 * \param query The callback to invoke to check if an object has a property.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002346 * \param deleter The callback to invoke when deleting a property.
2347 * \param enumerator The callback to invoke to enumerate all the indexed
2348 * properties of an object.
2349 * \param data A piece of data that will be passed to the callbacks
2350 * whenever they are invoked.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002351 */
2352 void SetIndexedPropertyHandler(IndexedPropertyGetter getter,
2353 IndexedPropertySetter setter = 0,
2354 IndexedPropertyQuery query = 0,
2355 IndexedPropertyDeleter deleter = 0,
2356 IndexedPropertyEnumerator enumerator = 0,
ager@chromium.orgea4f62e2010-08-16 16:28:43 +00002357 Handle<Value> data = Handle<Value>());
vegorov@chromium.org26c16f82010-08-11 13:41:03 +00002358
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002359 /**
2360 * Sets the callback to be used when calling instances created from
2361 * this template as a function. If no callback is set, instances
v8.team.kasperl727e9952008-09-02 14:56:44 +00002362 * behave like normal JavaScript objects that cannot be called as a
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002363 * function.
2364 */
2365 void SetCallAsFunctionHandler(InvocationCallback callback,
2366 Handle<Value> data = Handle<Value>());
2367
v8.team.kasperl727e9952008-09-02 14:56:44 +00002368 /**
2369 * Mark object instances of the template as undetectable.
2370 *
2371 * In many ways, undetectable objects behave as though they are not
2372 * there. They behave like 'undefined' in conditionals and when
2373 * printed. However, properties can be accessed and called as on
2374 * normal objects.
2375 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002376 void MarkAsUndetectable();
2377
v8.team.kasperl727e9952008-09-02 14:56:44 +00002378 /**
2379 * Sets access check callbacks on the object template.
2380 *
2381 * When accessing properties on instances of this object template,
2382 * the access check callback will be called to determine whether or
2383 * not to allow cross-context access to the properties.
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002384 * The last parameter specifies whether access checks are turned
2385 * on by default on instances. If access checks are off by default,
2386 * they can be turned on on individual instances by calling
2387 * Object::TurnOnAccessCheck().
v8.team.kasperl727e9952008-09-02 14:56:44 +00002388 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002389 void SetAccessCheckCallbacks(NamedSecurityCallback named_handler,
2390 IndexedSecurityCallback indexed_handler,
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002391 Handle<Value> data = Handle<Value>(),
2392 bool turned_on_by_default = true);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002393
kasper.lund212ac232008-07-16 07:07:30 +00002394 /**
2395 * Gets the number of internal fields for objects generated from
2396 * this template.
2397 */
2398 int InternalFieldCount();
2399
2400 /**
2401 * Sets the number of internal fields for objects generated from
2402 * this template.
2403 */
2404 void SetInternalFieldCount(int value);
2405
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002406 private:
2407 ObjectTemplate();
2408 static Local<ObjectTemplate> New(Handle<FunctionTemplate> constructor);
2409 friend class FunctionTemplate;
2410};
2411
2412
2413/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002414 * A Signature specifies which receivers and arguments a function can
2415 * legally be called with.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002416 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002417class V8EXPORT Signature : public Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002418 public:
2419 static Local<Signature> New(Handle<FunctionTemplate> receiver =
2420 Handle<FunctionTemplate>(),
2421 int argc = 0,
2422 Handle<FunctionTemplate> argv[] = 0);
2423 private:
2424 Signature();
2425};
2426
2427
2428/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002429 * A utility for determining the type of objects based on the template
2430 * they were constructed from.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002431 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002432class V8EXPORT TypeSwitch : public Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002433 public:
2434 static Local<TypeSwitch> New(Handle<FunctionTemplate> type);
2435 static Local<TypeSwitch> New(int argc, Handle<FunctionTemplate> types[]);
2436 int match(Handle<Value> value);
2437 private:
2438 TypeSwitch();
2439};
2440
2441
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00002442// --- Extensions ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002443
2444
2445/**
2446 * Ignore
2447 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002448class V8EXPORT Extension { // NOLINT
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002449 public:
2450 Extension(const char* name,
2451 const char* source = 0,
2452 int dep_count = 0,
2453 const char** deps = 0);
2454 virtual ~Extension() { }
2455 virtual v8::Handle<v8::FunctionTemplate>
2456 GetNativeFunction(v8::Handle<v8::String> name) {
2457 return v8::Handle<v8::FunctionTemplate>();
2458 }
2459
2460 const char* name() { return name_; }
2461 const char* source() { return source_; }
2462 int dependency_count() { return dep_count_; }
2463 const char** dependencies() { return deps_; }
2464 void set_auto_enable(bool value) { auto_enable_ = value; }
2465 bool auto_enable() { return auto_enable_; }
2466
2467 private:
2468 const char* name_;
2469 const char* source_;
2470 int dep_count_;
2471 const char** deps_;
2472 bool auto_enable_;
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00002473
2474 // Disallow copying and assigning.
2475 Extension(const Extension&);
2476 void operator=(const Extension&);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002477};
2478
2479
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002480void V8EXPORT RegisterExtension(Extension* extension);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002481
2482
2483/**
2484 * Ignore
2485 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002486class V8EXPORT DeclareExtension {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002487 public:
2488 inline DeclareExtension(Extension* extension) {
2489 RegisterExtension(extension);
2490 }
2491};
2492
2493
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00002494// --- Statics ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002495
2496
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002497Handle<Primitive> V8EXPORT Undefined();
2498Handle<Primitive> V8EXPORT Null();
2499Handle<Boolean> V8EXPORT True();
2500Handle<Boolean> V8EXPORT False();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002501
2502
2503/**
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00002504 * A set of constraints that specifies the limits of the runtime's memory use.
2505 * You must set the heap size before initializing the VM - the size cannot be
2506 * adjusted after the VM is initialized.
2507 *
2508 * If you are using threads then you should hold the V8::Locker lock while
2509 * setting the stack limit and you must set a non-default stack limit separately
2510 * for each thread.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002511 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002512class V8EXPORT ResourceConstraints {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002513 public:
2514 ResourceConstraints();
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002515 int max_young_space_size() const { return max_young_space_size_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002516 void set_max_young_space_size(int value) { max_young_space_size_ = value; }
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002517 int max_old_space_size() const { return max_old_space_size_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002518 void set_max_old_space_size(int value) { max_old_space_size_ = value; }
ager@chromium.org01fe7df2010-11-10 11:59:11 +00002519 int max_executable_size() { return max_executable_size_; }
2520 void set_max_executable_size(int value) { max_executable_size_ = value; }
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002521 uint32_t* stack_limit() const { return stack_limit_; }
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00002522 // Sets an address beyond which the VM's stack may not grow.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002523 void set_stack_limit(uint32_t* value) { stack_limit_ = value; }
2524 private:
2525 int max_young_space_size_;
2526 int max_old_space_size_;
ager@chromium.org01fe7df2010-11-10 11:59:11 +00002527 int max_executable_size_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002528 uint32_t* stack_limit_;
2529};
2530
2531
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +00002532bool V8EXPORT SetResourceConstraints(ResourceConstraints* constraints);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002533
2534
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00002535// --- Exceptions ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002536
2537
2538typedef void (*FatalErrorCallback)(const char* location, const char* message);
2539
2540
2541typedef void (*MessageCallback)(Handle<Message> message, Handle<Value> data);
2542
2543
2544/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002545 * Schedules an exception to be thrown when returning to JavaScript. When an
2546 * exception has been scheduled it is illegal to invoke any JavaScript
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002547 * operation; the caller must return immediately and only after the exception
v8.team.kasperl727e9952008-09-02 14:56:44 +00002548 * has been handled does it become legal to invoke JavaScript operations.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002549 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002550Handle<Value> V8EXPORT ThrowException(Handle<Value> exception);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002551
2552/**
2553 * Create new error objects by calling the corresponding error object
2554 * constructor with the message.
2555 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002556class V8EXPORT Exception {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002557 public:
2558 static Local<Value> RangeError(Handle<String> message);
2559 static Local<Value> ReferenceError(Handle<String> message);
2560 static Local<Value> SyntaxError(Handle<String> message);
2561 static Local<Value> TypeError(Handle<String> message);
2562 static Local<Value> Error(Handle<String> message);
2563};
2564
2565
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00002566// --- Counters Callbacks ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002567
ager@chromium.orga74f0da2008-12-03 16:05:52 +00002568typedef int* (*CounterLookupCallback)(const char* name);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002569
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002570typedef void* (*CreateHistogramCallback)(const char* name,
2571 int min,
2572 int max,
2573 size_t buckets);
2574
2575typedef void (*AddHistogramSampleCallback)(void* histogram, int sample);
2576
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00002577// --- Memory Allocation Callback ---
kmillikin@chromium.org3cdd9e12010-09-06 11:39:48 +00002578 enum ObjectSpace {
2579 kObjectSpaceNewSpace = 1 << 0,
2580 kObjectSpaceOldPointerSpace = 1 << 1,
2581 kObjectSpaceOldDataSpace = 1 << 2,
2582 kObjectSpaceCodeSpace = 1 << 3,
2583 kObjectSpaceMapSpace = 1 << 4,
2584 kObjectSpaceLoSpace = 1 << 5,
2585
2586 kObjectSpaceAll = kObjectSpaceNewSpace | kObjectSpaceOldPointerSpace |
2587 kObjectSpaceOldDataSpace | kObjectSpaceCodeSpace | kObjectSpaceMapSpace |
2588 kObjectSpaceLoSpace
2589 };
2590
2591 enum AllocationAction {
2592 kAllocationActionAllocate = 1 << 0,
2593 kAllocationActionFree = 1 << 1,
2594 kAllocationActionAll = kAllocationActionAllocate | kAllocationActionFree
2595 };
2596
2597typedef void (*MemoryAllocationCallback)(ObjectSpace space,
2598 AllocationAction action,
2599 int size);
2600
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00002601// --- Failed Access Check Callback ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002602typedef void (*FailedAccessCheckCallback)(Local<Object> target,
2603 AccessType type,
2604 Local<Value> data);
2605
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00002606// --- AllowCodeGenerationFromStrings callbacks ---
2607
2608/**
2609 * Callback to check if code generation from strings is allowed. See
2610 * Context::AllowCodeGenerationFromStrings.
2611 */
2612typedef bool (*AllowCodeGenerationFromStringsCallback)(Local<Context> context);
2613
2614// --- Garbage Collection Callbacks ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002615
2616/**
kmillikin@chromium.org5d8f0e62010-03-24 08:21:20 +00002617 * Applications can register callback functions which will be called
2618 * before and after a garbage collection. Allocations are not
2619 * allowed in the callback functions, you therefore cannot manipulate
v8.team.kasperl727e9952008-09-02 14:56:44 +00002620 * objects (set or delete properties for example) since it is possible
2621 * such operations will result in the allocation of objects.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002622 */
kmillikin@chromium.org5d8f0e62010-03-24 08:21:20 +00002623enum GCType {
2624 kGCTypeScavenge = 1 << 0,
2625 kGCTypeMarkSweepCompact = 1 << 1,
2626 kGCTypeAll = kGCTypeScavenge | kGCTypeMarkSweepCompact
2627};
2628
2629enum GCCallbackFlags {
2630 kNoGCCallbackFlags = 0,
2631 kGCCallbackFlagCompacted = 1 << 0
2632};
2633
2634typedef void (*GCPrologueCallback)(GCType type, GCCallbackFlags flags);
2635typedef void (*GCEpilogueCallback)(GCType type, GCCallbackFlags flags);
2636
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002637typedef void (*GCCallback)();
2638
2639
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002640/**
ager@chromium.org3811b432009-10-28 14:53:37 +00002641 * Collection of V8 heap information.
2642 *
2643 * Instances of this class can be passed to v8::V8::HeapStatistics to
2644 * get heap statistics from V8.
2645 */
2646class V8EXPORT HeapStatistics {
2647 public:
2648 HeapStatistics();
2649 size_t total_heap_size() { return total_heap_size_; }
ager@chromium.org01fe7df2010-11-10 11:59:11 +00002650 size_t total_heap_size_executable() { return total_heap_size_executable_; }
ager@chromium.org3811b432009-10-28 14:53:37 +00002651 size_t used_heap_size() { return used_heap_size_; }
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00002652 size_t heap_size_limit() { return heap_size_limit_; }
ager@chromium.org3811b432009-10-28 14:53:37 +00002653
2654 private:
2655 void set_total_heap_size(size_t size) { total_heap_size_ = size; }
ager@chromium.org01fe7df2010-11-10 11:59:11 +00002656 void set_total_heap_size_executable(size_t size) {
2657 total_heap_size_executable_ = size;
2658 }
ager@chromium.org3811b432009-10-28 14:53:37 +00002659 void set_used_heap_size(size_t size) { used_heap_size_ = size; }
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00002660 void set_heap_size_limit(size_t size) { heap_size_limit_ = size; }
ager@chromium.org3811b432009-10-28 14:53:37 +00002661
2662 size_t total_heap_size_;
ager@chromium.org01fe7df2010-11-10 11:59:11 +00002663 size_t total_heap_size_executable_;
ager@chromium.org3811b432009-10-28 14:53:37 +00002664 size_t used_heap_size_;
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00002665 size_t heap_size_limit_;
ager@chromium.org3811b432009-10-28 14:53:37 +00002666
2667 friend class V8;
2668};
2669
2670
whesse@chromium.orgb08986c2011-03-14 16:13:42 +00002671class RetainedObjectInfo;
2672
ager@chromium.org3811b432009-10-28 14:53:37 +00002673/**
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00002674 * Isolate represents an isolated instance of the V8 engine. V8
2675 * isolates have completely separate states. Objects from one isolate
2676 * must not be used in other isolates. When V8 is initialized a
2677 * default isolate is implicitly created and entered. The embedder
2678 * can create additional isolates and use them in parallel in multiple
2679 * threads. An isolate can be entered by at most one thread at any
2680 * given time. The Locker/Unlocker API can be used to synchronize.
2681 */
2682class V8EXPORT Isolate {
2683 public:
2684 /**
2685 * Stack-allocated class which sets the isolate for all operations
2686 * executed within a local scope.
2687 */
2688 class V8EXPORT Scope {
2689 public:
2690 explicit Scope(Isolate* isolate) : isolate_(isolate) {
2691 isolate->Enter();
2692 }
2693
2694 ~Scope() { isolate_->Exit(); }
2695
2696 private:
2697 Isolate* const isolate_;
2698
2699 // Prevent copying of Scope objects.
2700 Scope(const Scope&);
2701 Scope& operator=(const Scope&);
2702 };
2703
2704 /**
2705 * Creates a new isolate. Does not change the currently entered
2706 * isolate.
2707 *
2708 * When an isolate is no longer used its resources should be freed
2709 * by calling Dispose(). Using the delete operator is not allowed.
2710 */
2711 static Isolate* New();
2712
2713 /**
2714 * Returns the entered isolate for the current thread or NULL in
2715 * case there is no current isolate.
2716 */
2717 static Isolate* GetCurrent();
2718
2719 /**
2720 * Methods below this point require holding a lock (using Locker) in
2721 * a multi-threaded environment.
2722 */
2723
2724 /**
2725 * Sets this isolate as the entered one for the current thread.
2726 * Saves the previously entered one (if any), so that it can be
2727 * restored when exiting. Re-entering an isolate is allowed.
2728 */
2729 void Enter();
2730
2731 /**
2732 * Exits this isolate by restoring the previously entered one in the
2733 * current thread. The isolate may still stay the same, if it was
2734 * entered more than once.
2735 *
2736 * Requires: this == Isolate::GetCurrent().
2737 */
2738 void Exit();
2739
2740 /**
2741 * Disposes the isolate. The isolate must not be entered by any
2742 * thread to be disposable.
2743 */
2744 void Dispose();
2745
ager@chromium.orgea91cc52011-05-23 06:06:11 +00002746 /**
2747 * Associate embedder-specific data with the isolate
2748 */
2749 void SetData(void* data);
2750
2751 /**
2752 * Retrive embedder-specific data from the isolate.
2753 * Returns NULL if SetData has never been called.
2754 */
2755 void* GetData();
2756
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00002757 private:
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00002758 Isolate();
2759 Isolate(const Isolate&);
2760 ~Isolate();
2761 Isolate& operator=(const Isolate&);
2762 void* operator new(size_t size);
2763 void operator delete(void*, size_t);
2764};
2765
2766
sgjesse@chromium.org8e8294a2011-05-02 14:30:53 +00002767class StartupData {
2768 public:
2769 enum CompressionAlgorithm {
2770 kUncompressed,
2771 kBZip2
2772 };
2773
2774 const char* data;
2775 int compressed_size;
2776 int raw_size;
2777};
2778
jkummerow@chromium.orge297f592011-06-08 10:05:15 +00002779
2780/**
2781 * A helper class for driving V8 startup data decompression. It is based on
2782 * "CompressedStartupData" API functions from the V8 class. It isn't mandatory
2783 * for an embedder to use this class, instead, API functions can be used
2784 * directly.
2785 *
2786 * For an example of the class usage, see the "shell.cc" sample application.
2787 */
2788class V8EXPORT StartupDataDecompressor { // NOLINT
2789 public:
2790 StartupDataDecompressor();
2791 virtual ~StartupDataDecompressor();
2792 int Decompress();
2793
2794 protected:
2795 virtual int DecompressData(char* raw_data,
2796 int* raw_data_size,
2797 const char* compressed_data,
2798 int compressed_data_size) = 0;
2799
2800 private:
2801 char** raw_data;
2802};
2803
svenpanne@chromium.org84bcc552011-07-18 09:50:57 +00002804
2805/**
2806 * EntropySource is used as a callback function when v8 needs a source
2807 * of entropy.
2808 */
2809typedef bool (*EntropySource)(unsigned char* buffer, size_t length);
2810
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00002811/**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002812 * Container class for static utility functions.
2813 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002814class V8EXPORT V8 {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002815 public:
v8.team.kasperl727e9952008-09-02 14:56:44 +00002816 /** Set the callback to invoke in case of fatal errors. */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002817 static void SetFatalErrorHandler(FatalErrorCallback that);
2818
v8.team.kasperl727e9952008-09-02 14:56:44 +00002819 /**
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00002820 * Set the callback to invoke to check if code generation from
2821 * strings should be allowed.
2822 */
2823 static void SetAllowCodeGenerationFromStringsCallback(
2824 AllowCodeGenerationFromStringsCallback that);
2825
2826 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002827 * Ignore out-of-memory exceptions.
2828 *
2829 * V8 running out of memory is treated as a fatal error by default.
2830 * This means that the fatal error handler is called and that V8 is
2831 * terminated.
2832 *
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00002833 * IgnoreOutOfMemoryException can be used to not treat an
v8.team.kasperl727e9952008-09-02 14:56:44 +00002834 * out-of-memory situation as a fatal error. This way, the contexts
2835 * that did not cause the out of memory problem might be able to
2836 * continue execution.
2837 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002838 static void IgnoreOutOfMemoryException();
2839
v8.team.kasperl727e9952008-09-02 14:56:44 +00002840 /**
ager@chromium.org9258b6b2008-09-11 09:11:10 +00002841 * Check if V8 is dead and therefore unusable. This is the case after
v8.team.kasperl727e9952008-09-02 14:56:44 +00002842 * fatal errors such as out-of-memory situations.
2843 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002844 static bool IsDead();
2845
2846 /**
sgjesse@chromium.org8e8294a2011-05-02 14:30:53 +00002847 * The following 4 functions are to be used when V8 is built with
2848 * the 'compress_startup_data' flag enabled. In this case, the
2849 * embedder must decompress startup data prior to initializing V8.
2850 *
2851 * This is how interaction with V8 should look like:
2852 * int compressed_data_count = v8::V8::GetCompressedStartupDataCount();
2853 * v8::StartupData* compressed_data =
2854 * new v8::StartupData[compressed_data_count];
2855 * v8::V8::GetCompressedStartupData(compressed_data);
2856 * ... decompress data (compressed_data can be updated in-place) ...
2857 * v8::V8::SetDecompressedStartupData(compressed_data);
2858 * ... now V8 can be initialized
2859 * ... make sure the decompressed data stays valid until V8 shutdown
jkummerow@chromium.orge297f592011-06-08 10:05:15 +00002860 *
2861 * A helper class StartupDataDecompressor is provided. It implements
2862 * the protocol of the interaction described above, and can be used in
2863 * most cases instead of calling these API functions directly.
sgjesse@chromium.org8e8294a2011-05-02 14:30:53 +00002864 */
2865 static StartupData::CompressionAlgorithm GetCompressedStartupDataAlgorithm();
2866 static int GetCompressedStartupDataCount();
2867 static void GetCompressedStartupData(StartupData* compressed_data);
2868 static void SetDecompressedStartupData(StartupData* decompressed_data);
2869
2870 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002871 * Adds a message listener.
2872 *
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00002873 * The same message listener can be added more than once and in that
v8.team.kasperl727e9952008-09-02 14:56:44 +00002874 * case it will be called more than once for each message.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002875 */
2876 static bool AddMessageListener(MessageCallback that,
2877 Handle<Value> data = Handle<Value>());
2878
2879 /**
2880 * Remove all message listeners from the specified callback function.
2881 */
2882 static void RemoveMessageListeners(MessageCallback that);
2883
2884 /**
ager@chromium.org6a2b0aa2010-07-13 20:58:03 +00002885 * Tells V8 to capture current stack trace when uncaught exception occurs
2886 * and report it to the message listeners. The option is off by default.
2887 */
2888 static void SetCaptureStackTraceForUncaughtExceptions(
2889 bool capture,
2890 int frame_limit = 10,
2891 StackTrace::StackTraceOptions options = StackTrace::kOverview);
2892
2893 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002894 * Sets V8 flags from a string.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002895 */
2896 static void SetFlagsFromString(const char* str, int length);
2897
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +00002898 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002899 * Sets V8 flags from the command line.
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +00002900 */
2901 static void SetFlagsFromCommandLine(int* argc,
2902 char** argv,
2903 bool remove_flags);
2904
kasper.lund7276f142008-07-30 08:49:36 +00002905 /** Get the version string. */
2906 static const char* GetVersion();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002907
2908 /**
2909 * Enables the host application to provide a mechanism for recording
2910 * statistics counters.
2911 */
2912 static void SetCounterFunction(CounterLookupCallback);
2913
2914 /**
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002915 * Enables the host application to provide a mechanism for recording
2916 * histograms. The CreateHistogram function returns a
2917 * histogram which will later be passed to the AddHistogramSample
2918 * function.
2919 */
2920 static void SetCreateHistogramFunction(CreateHistogramCallback);
2921 static void SetAddHistogramSampleFunction(AddHistogramSampleCallback);
2922
2923 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002924 * Enables the computation of a sliding window of states. The sliding
2925 * window information is recorded in statistics counters.
2926 */
2927 static void EnableSlidingStateWindow();
2928
2929 /** Callback function for reporting failed access checks.*/
2930 static void SetFailedAccessCheckCallbackFunction(FailedAccessCheckCallback);
2931
2932 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002933 * Enables the host application to receive a notification before a
kmillikin@chromium.org5d8f0e62010-03-24 08:21:20 +00002934 * garbage collection. Allocations are not allowed in the
2935 * callback function, you therefore cannot manipulate objects (set
2936 * or delete properties for example) since it is possible such
2937 * operations will result in the allocation of objects. It is possible
2938 * to specify the GCType filter for your callback. But it is not possible to
2939 * register the same callback function two times with different
2940 * GCType filters.
2941 */
2942 static void AddGCPrologueCallback(
2943 GCPrologueCallback callback, GCType gc_type_filter = kGCTypeAll);
2944
2945 /**
2946 * This function removes callback which was installed by
2947 * AddGCPrologueCallback function.
2948 */
2949 static void RemoveGCPrologueCallback(GCPrologueCallback callback);
2950
2951 /**
2952 * The function is deprecated. Please use AddGCPrologueCallback instead.
2953 * Enables the host application to receive a notification before a
2954 * garbage collection. Allocations are not allowed in the
v8.team.kasperl727e9952008-09-02 14:56:44 +00002955 * callback function, you therefore cannot manipulate objects (set
2956 * or delete properties for example) since it is possible such
2957 * operations will result in the allocation of objects.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002958 */
2959 static void SetGlobalGCPrologueCallback(GCCallback);
2960
2961 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002962 * Enables the host application to receive a notification after a
kmillikin@chromium.org5d8f0e62010-03-24 08:21:20 +00002963 * garbage collection. Allocations are not allowed in the
2964 * callback function, you therefore cannot manipulate objects (set
2965 * or delete properties for example) since it is possible such
2966 * operations will result in the allocation of objects. It is possible
2967 * to specify the GCType filter for your callback. But it is not possible to
2968 * register the same callback function two times with different
2969 * GCType filters.
2970 */
2971 static void AddGCEpilogueCallback(
2972 GCEpilogueCallback callback, GCType gc_type_filter = kGCTypeAll);
2973
2974 /**
2975 * This function removes callback which was installed by
2976 * AddGCEpilogueCallback function.
2977 */
2978 static void RemoveGCEpilogueCallback(GCEpilogueCallback callback);
2979
2980 /**
2981 * The function is deprecated. Please use AddGCEpilogueCallback instead.
2982 * Enables the host application to receive a notification after a
v8.team.kasperl727e9952008-09-02 14:56:44 +00002983 * major garbage collection. Allocations are not allowed in the
2984 * callback function, you therefore cannot manipulate objects (set
2985 * or delete properties for example) since it is possible such
2986 * operations will result in the allocation of objects.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002987 */
2988 static void SetGlobalGCEpilogueCallback(GCCallback);
2989
2990 /**
kmillikin@chromium.org3cdd9e12010-09-06 11:39:48 +00002991 * Enables the host application to provide a mechanism to be notified
2992 * and perform custom logging when V8 Allocates Executable Memory.
2993 */
2994 static void AddMemoryAllocationCallback(MemoryAllocationCallback callback,
2995 ObjectSpace space,
2996 AllocationAction action);
2997
2998 /**
2999 * This function removes callback which was installed by
3000 * AddMemoryAllocationCallback function.
3001 */
3002 static void RemoveMemoryAllocationCallback(MemoryAllocationCallback callback);
3003
3004 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00003005 * Allows the host application to group objects together. If one
3006 * object in the group is alive, all objects in the group are alive.
3007 * After each garbage collection, object groups are removed. It is
3008 * intended to be used in the before-garbage-collection callback
ager@chromium.org8bb60582008-12-11 12:02:20 +00003009 * function, for instance to simulate DOM tree connections among JS
v8.team.kasperl727e9952008-09-02 14:56:44 +00003010 * wrapper objects.
whesse@chromium.orgb08986c2011-03-14 16:13:42 +00003011 * See v8-profiler.h for RetainedObjectInfo interface description.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003012 */
whesse@chromium.orgb08986c2011-03-14 16:13:42 +00003013 static void AddObjectGroup(Persistent<Value>* objects,
3014 size_t length,
3015 RetainedObjectInfo* info = NULL);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003016
3017 /**
ricow@chromium.orgbadaffc2011-03-17 12:15:27 +00003018 * Allows the host application to declare implicit references between
3019 * the objects: if |parent| is alive, all |children| are alive too.
3020 * After each garbage collection, all implicit references
3021 * are removed. It is intended to be used in the before-garbage-collection
3022 * callback function.
3023 */
3024 static void AddImplicitReferences(Persistent<Object> parent,
3025 Persistent<Value>* children,
3026 size_t length);
3027
3028 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00003029 * Initializes from snapshot if possible. Otherwise, attempts to
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00003030 * initialize from scratch. This function is called implicitly if
3031 * you use the API without calling it first.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003032 */
3033 static bool Initialize();
3034
kasper.lund7276f142008-07-30 08:49:36 +00003035 /**
svenpanne@chromium.org84bcc552011-07-18 09:50:57 +00003036 * Allows the host application to provide a callback which can be used
3037 * as a source of entropy for random number generators.
3038 */
3039 static void SetEntropySource(EntropySource source);
3040
3041 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00003042 * Adjusts the amount of registered external memory. Used to give
3043 * V8 an indication of the amount of externally allocated memory
3044 * that is kept alive by JavaScript objects. V8 uses this to decide
3045 * when to perform global garbage collections. Registering
3046 * externally allocated memory will trigger global garbage
3047 * collections more often than otherwise in an attempt to garbage
3048 * collect the JavaScript objects keeping the externally allocated
3049 * memory alive.
3050 *
3051 * \param change_in_bytes the change in externally allocated memory
3052 * that is kept alive by JavaScript objects.
3053 * \returns the adjusted value.
kasper.lund7276f142008-07-30 08:49:36 +00003054 */
3055 static int AdjustAmountOfExternalAllocatedMemory(int change_in_bytes);
3056
iposva@chromium.org245aa852009-02-10 00:49:54 +00003057 /**
3058 * Suspends recording of tick samples in the profiler.
3059 * When the V8 profiling mode is enabled (usually via command line
3060 * switches) this function suspends recording of tick samples.
3061 * Profiling ticks are discarded until ResumeProfiler() is called.
3062 *
3063 * See also the --prof and --prof_auto command line switches to
3064 * enable V8 profiling.
3065 */
3066 static void PauseProfiler();
3067
3068 /**
3069 * Resumes recording of tick samples in the profiler.
3070 * See also PauseProfiler().
3071 */
3072 static void ResumeProfiler();
3073
ager@chromium.org41826e72009-03-30 13:30:57 +00003074 /**
kasperl@chromium.org71affb52009-05-26 05:44:31 +00003075 * Return whether profiler is currently paused.
3076 */
3077 static bool IsProfilerPaused();
3078
3079 /**
sgjesse@chromium.orgc81c8942009-08-21 10:54:26 +00003080 * Retrieve the V8 thread id of the calling thread.
3081 *
3082 * The thread id for a thread should only be retrieved after the V8
3083 * lock has been acquired with a Locker object with that thread.
3084 */
3085 static int GetCurrentThreadId();
3086
3087 /**
3088 * Forcefully terminate execution of a JavaScript thread. This can
3089 * be used to terminate long-running scripts.
3090 *
3091 * TerminateExecution should only be called when then V8 lock has
3092 * been acquired with a Locker object. Therefore, in order to be
3093 * able to terminate long-running threads, preemption must be
3094 * enabled to allow the user of TerminateExecution to acquire the
3095 * lock.
3096 *
3097 * The termination is achieved by throwing an exception that is
3098 * uncatchable by JavaScript exception handlers. Termination
3099 * exceptions act as if they were caught by a C++ TryCatch exception
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00003100 * handler. If forceful termination is used, any C++ TryCatch
sgjesse@chromium.orgc81c8942009-08-21 10:54:26 +00003101 * exception handler that catches an exception should check if that
3102 * exception is a termination exception and immediately return if
3103 * that is the case. Returning immediately in that case will
3104 * continue the propagation of the termination exception if needed.
3105 *
3106 * The thread id passed to TerminateExecution must have been
3107 * obtained by calling GetCurrentThreadId on the thread in question.
3108 *
3109 * \param thread_id The thread id of the thread to terminate.
3110 */
3111 static void TerminateExecution(int thread_id);
3112
3113 /**
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003114 * Forcefully terminate the current thread of JavaScript execution
3115 * in the given isolate. If no isolate is provided, the default
3116 * isolate is used.
sgjesse@chromium.orgc81c8942009-08-21 10:54:26 +00003117 *
3118 * This method can be used by any thread even if that thread has not
3119 * acquired the V8 lock with a Locker object.
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003120 *
3121 * \param isolate The isolate in which to terminate the current JS execution.
sgjesse@chromium.orgc81c8942009-08-21 10:54:26 +00003122 */
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003123 static void TerminateExecution(Isolate* isolate = NULL);
ager@chromium.org9085a012009-05-11 19:22:57 +00003124
3125 /**
sgjesse@chromium.org2ab99522010-03-10 09:03:43 +00003126 * Is V8 terminating JavaScript execution.
3127 *
3128 * Returns true if JavaScript execution is currently terminating
3129 * because of a call to TerminateExecution. In that case there are
3130 * still JavaScript frames on the stack and the termination
3131 * exception is still active.
svenpanne@chromium.org6d786c92011-06-15 10:58:27 +00003132 *
3133 * \param isolate The isolate in which to check.
sgjesse@chromium.org2ab99522010-03-10 09:03:43 +00003134 */
svenpanne@chromium.org6d786c92011-06-15 10:58:27 +00003135 static bool IsExecutionTerminating(Isolate* isolate = NULL);
sgjesse@chromium.org2ab99522010-03-10 09:03:43 +00003136
3137 /**
ager@chromium.org41826e72009-03-30 13:30:57 +00003138 * Releases any resources used by v8 and stops any utility threads
3139 * that may be running. Note that disposing v8 is permanent, it
3140 * cannot be reinitialized.
3141 *
3142 * It should generally not be necessary to dispose v8 before exiting
3143 * a process, this should happen automatically. It is only necessary
3144 * to use if the process needs the resources taken up by v8.
3145 */
3146 static bool Dispose();
3147
ager@chromium.org3811b432009-10-28 14:53:37 +00003148 /**
3149 * Get statistics about the heap memory usage.
3150 */
3151 static void GetHeapStatistics(HeapStatistics* heap_statistics);
ager@chromium.orgadd848f2009-08-13 12:44:13 +00003152
3153 /**
3154 * Optional notification that the embedder is idle.
3155 * V8 uses the notification to reduce memory footprint.
ager@chromium.orgab99eea2009-08-25 07:05:41 +00003156 * This call can be used repeatedly if the embedder remains idle.
ager@chromium.orgab99eea2009-08-25 07:05:41 +00003157 * Returns true if the embedder should stop calling IdleNotification
3158 * until real work has been done. This indicates that V8 has done
3159 * as much cleanup as it will be able to do.
ager@chromium.orgadd848f2009-08-13 12:44:13 +00003160 */
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00003161 static bool IdleNotification();
ager@chromium.orgadd848f2009-08-13 12:44:13 +00003162
sgjesse@chromium.orgc81c8942009-08-21 10:54:26 +00003163 /**
3164 * Optional notification that the system is running low on memory.
3165 * V8 uses these notifications to attempt to free memory.
3166 */
3167 static void LowMemoryNotification();
3168
kasperl@chromium.org8b2bb262010-03-01 09:46:28 +00003169 /**
3170 * Optional notification that a context has been disposed. V8 uses
ager@chromium.orgce5e87b2010-03-10 10:24:18 +00003171 * these notifications to guide the GC heuristic. Returns the number
3172 * of context disposals - including this one - since the last time
3173 * V8 had a chance to clean up.
kasperl@chromium.org8b2bb262010-03-01 09:46:28 +00003174 */
ager@chromium.orgce5e87b2010-03-10 10:24:18 +00003175 static int ContextDisposedNotification();
kasperl@chromium.org8b2bb262010-03-01 09:46:28 +00003176
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003177 private:
3178 V8();
3179
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003180 static internal::Object** GlobalizeReference(internal::Object** handle);
3181 static void DisposeGlobal(internal::Object** global_handle);
3182 static void MakeWeak(internal::Object** global_handle,
3183 void* data,
3184 WeakReferenceCallback);
3185 static void ClearWeak(internal::Object** global_handle);
kmillikin@chromium.orgc53e10d2011-05-18 09:12:58 +00003186 static void MarkIndependent(internal::Object** global_handle);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003187 static bool IsGlobalNearDeath(internal::Object** global_handle);
3188 static bool IsGlobalWeak(internal::Object** global_handle);
whesse@chromium.orgb08986c2011-03-14 16:13:42 +00003189 static void SetWrapperClassId(internal::Object** global_handle,
3190 uint16_t class_id);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003191
3192 template <class T> friend class Handle;
3193 template <class T> friend class Local;
3194 template <class T> friend class Persistent;
3195 friend class Context;
3196};
3197
3198
3199/**
3200 * An external exception handler.
3201 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00003202class V8EXPORT TryCatch {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003203 public:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003204 /**
3205 * Creates a new try/catch block and registers it with v8.
3206 */
3207 TryCatch();
3208
3209 /**
3210 * Unregisters and deletes this try/catch block.
3211 */
3212 ~TryCatch();
3213
3214 /**
3215 * Returns true if an exception has been caught by this try/catch block.
3216 */
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00003217 bool HasCaught() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003218
3219 /**
sgjesse@chromium.orgc81c8942009-08-21 10:54:26 +00003220 * For certain types of exceptions, it makes no sense to continue
3221 * execution.
3222 *
3223 * Currently, the only type of exception that can be caught by a
3224 * TryCatch handler and for which it does not make sense to continue
3225 * is termination exception. Such exceptions are thrown when the
3226 * TerminateExecution methods are called to terminate a long-running
3227 * script.
3228 *
3229 * If CanContinue returns false, the correct action is to perform
3230 * any C++ cleanup needed and then return.
3231 */
3232 bool CanContinue() const;
3233
3234 /**
christian.plesner.hansen@gmail.comb9ce6372009-11-03 11:38:18 +00003235 * Throws the exception caught by this TryCatch in a way that avoids
3236 * it being caught again by this same TryCatch. As with ThrowException
3237 * it is illegal to execute any JavaScript operations after calling
3238 * ReThrow; the caller must return immediately to where the exception
3239 * is caught.
3240 */
3241 Handle<Value> ReThrow();
3242
3243 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003244 * Returns the exception caught by this try/catch block. If no exception has
3245 * been caught an empty handle is returned.
3246 *
3247 * The returned handle is valid until this TryCatch block has been destroyed.
3248 */
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00003249 Local<Value> Exception() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003250
3251 /**
sgjesse@chromium.org911335c2009-08-19 12:59:44 +00003252 * Returns the .stack property of the thrown object. If no .stack
3253 * property is present an empty handle is returned.
3254 */
3255 Local<Value> StackTrace() const;
3256
3257 /**
ager@chromium.org9258b6b2008-09-11 09:11:10 +00003258 * Returns the message associated with this exception. If there is
3259 * no message associated an empty handle is returned.
3260 *
3261 * The returned handle is valid until this TryCatch block has been
3262 * destroyed.
3263 */
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00003264 Local<v8::Message> Message() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +00003265
3266 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003267 * Clears any exceptions that may have been caught by this try/catch block.
3268 * After this method has been called, HasCaught() will return false.
3269 *
3270 * It is not necessary to clear a try/catch block before using it again; if
3271 * another exception is thrown the previously caught exception will just be
3272 * overwritten. However, it is often a good idea since it makes it easier
3273 * to determine which operation threw a given exception.
3274 */
3275 void Reset();
3276
v8.team.kasperl727e9952008-09-02 14:56:44 +00003277 /**
3278 * Set verbosity of the external exception handler.
3279 *
3280 * By default, exceptions that are caught by an external exception
3281 * handler are not reported. Call SetVerbose with true on an
3282 * external exception handler to have exceptions caught by the
3283 * handler reported as if they were not caught.
3284 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003285 void SetVerbose(bool value);
3286
ager@chromium.org9258b6b2008-09-11 09:11:10 +00003287 /**
3288 * Set whether or not this TryCatch should capture a Message object
3289 * which holds source information about where the exception
3290 * occurred. True by default.
3291 */
3292 void SetCaptureMessage(bool value);
3293
ager@chromium.orgc4c92722009-11-18 14:12:51 +00003294 private:
jkummerow@chromium.orge297f592011-06-08 10:05:15 +00003295 v8::internal::Isolate* isolate_;
ager@chromium.orgc4c92722009-11-18 14:12:51 +00003296 void* next_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003297 void* exception_;
ager@chromium.org9258b6b2008-09-11 09:11:10 +00003298 void* message_;
christian.plesner.hansen@gmail.comb9ce6372009-11-03 11:38:18 +00003299 bool is_verbose_ : 1;
3300 bool can_continue_ : 1;
3301 bool capture_message_ : 1;
3302 bool rethrow_ : 1;
ager@chromium.orgc4c92722009-11-18 14:12:51 +00003303
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003304 friend class v8::internal::Isolate;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003305};
3306
3307
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00003308// --- Context ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003309
3310
3311/**
3312 * Ignore
3313 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00003314class V8EXPORT ExtensionConfiguration {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003315 public:
3316 ExtensionConfiguration(int name_count, const char* names[])
3317 : name_count_(name_count), names_(names) { }
3318 private:
3319 friend class ImplementationUtilities;
3320 int name_count_;
3321 const char** names_;
3322};
3323
3324
3325/**
3326 * A sandboxed execution context with its own set of built-in objects
3327 * and functions.
3328 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00003329class V8EXPORT Context {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003330 public:
whesse@chromium.org7a392b32011-01-31 11:30:36 +00003331 /**
3332 * Returns the global proxy object or global object itself for
3333 * detached contexts.
3334 *
3335 * Global proxy object is a thin wrapper whose prototype points to
3336 * actual context's global object with the properties like Object, etc.
3337 * This is done that way for security reasons (for more details see
3338 * https://wiki.mozilla.org/Gecko:SplitWindow).
3339 *
3340 * Please note that changes to global proxy object prototype most probably
3341 * would break VM---v8 expects only global object as a prototype of
3342 * global proxy object.
3343 *
3344 * If DetachGlobal() has been invoked, Global() would return actual global
3345 * object until global is reattached with ReattachGlobal().
3346 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003347 Local<Object> Global();
3348
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00003349 /**
3350 * Detaches the global object from its context before
3351 * the global object can be reused to create a new context.
3352 */
3353 void DetachGlobal();
3354
sgjesse@chromium.orgdf7a2842010-03-25 14:34:15 +00003355 /**
3356 * Reattaches a global object to a context. This can be used to
3357 * restore the connection between a global object and a context
3358 * after DetachGlobal has been called.
3359 *
3360 * \param global_object The global object to reattach to the
3361 * context. For this to work, the global object must be the global
3362 * object that was associated with this context before a call to
3363 * DetachGlobal.
3364 */
3365 void ReattachGlobal(Handle<Object> global_object);
3366
kmillikin@chromium.org9155e252010-05-26 13:27:57 +00003367 /** Creates a new context.
3368 *
3369 * Returns a persistent handle to the newly allocated context. This
3370 * persistent handle has to be disposed when the context is no
3371 * longer used so the context can be garbage collected.
lrn@chromium.org5d00b602011-01-05 09:51:43 +00003372 *
3373 * \param extensions An optional extension configuration containing
3374 * the extensions to be installed in the newly created context.
3375 *
3376 * \param global_template An optional object template from which the
3377 * global object for the newly created context will be created.
3378 *
3379 * \param global_object An optional global object to be reused for
3380 * the newly created context. This global object must have been
3381 * created by a previous call to Context::New with the same global
3382 * template. The state of the global object will be completely reset
3383 * and only object identify will remain.
kmillikin@chromium.org9155e252010-05-26 13:27:57 +00003384 */
v8.team.kasperl727e9952008-09-02 14:56:44 +00003385 static Persistent<Context> New(
kmillikin@chromium.org5d8f0e62010-03-24 08:21:20 +00003386 ExtensionConfiguration* extensions = NULL,
v8.team.kasperl727e9952008-09-02 14:56:44 +00003387 Handle<ObjectTemplate> global_template = Handle<ObjectTemplate>(),
3388 Handle<Value> global_object = Handle<Value>());
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003389
kasper.lund44510672008-07-25 07:37:58 +00003390 /** Returns the last entered context. */
3391 static Local<Context> GetEntered();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003392
kasper.lund44510672008-07-25 07:37:58 +00003393 /** Returns the context that is on the top of the stack. */
3394 static Local<Context> GetCurrent();
3395
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003396 /**
ager@chromium.org1bf0cd02009-05-20 11:34:19 +00003397 * Returns the context of the calling JavaScript code. That is the
3398 * context of the top-most JavaScript frame. If there are no
3399 * JavaScript frames an empty handle is returned.
3400 */
3401 static Local<Context> GetCalling();
3402
3403 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003404 * Sets the security token for the context. To access an object in
3405 * another context, the security tokens must match.
3406 */
3407 void SetSecurityToken(Handle<Value> token);
3408
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00003409 /** Restores the security token to the default value. */
3410 void UseDefaultSecurityToken();
3411
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003412 /** Returns the security token of this context.*/
3413 Handle<Value> GetSecurityToken();
3414
v8.team.kasperl727e9952008-09-02 14:56:44 +00003415 /**
3416 * Enter this context. After entering a context, all code compiled
3417 * and run is compiled and run in this context. If another context
3418 * is already entered, this old context is saved so it can be
3419 * restored when the new context is exited.
3420 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003421 void Enter();
v8.team.kasperl727e9952008-09-02 14:56:44 +00003422
3423 /**
3424 * Exit this context. Exiting the current context restores the
3425 * context that was in place when entering the current context.
3426 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003427 void Exit();
3428
v8.team.kasperl727e9952008-09-02 14:56:44 +00003429 /** Returns true if the context has experienced an out of memory situation. */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003430 bool HasOutOfMemoryException();
3431
v8.team.kasperl727e9952008-09-02 14:56:44 +00003432 /** Returns true if V8 has a current context. */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003433 static bool InContext();
3434
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003435 /**
ager@chromium.org9085a012009-05-11 19:22:57 +00003436 * Associate an additional data object with the context. This is mainly used
3437 * with the debugger to provide additional information on the context through
3438 * the debugger API.
3439 */
sgjesse@chromium.org499aaa52009-11-30 08:07:20 +00003440 void SetData(Handle<String> data);
ager@chromium.org9085a012009-05-11 19:22:57 +00003441 Local<Value> GetData();
3442
3443 /**
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00003444 * Control whether code generation from strings is allowed. Calling
3445 * this method with false will disable 'eval' and the 'Function'
3446 * constructor for code running in this context. If 'eval' or the
3447 * 'Function' constructor are used an exception will be thrown.
3448 *
3449 * If code generation from strings is not allowed the
3450 * V8::AllowCodeGenerationFromStrings callback will be invoked if
3451 * set before blocking the call to 'eval' or the 'Function'
3452 * constructor. If that callback returns true, the call will be
3453 * allowed, otherwise an exception will be thrown. If no callback is
3454 * set an exception will be thrown.
3455 */
3456 void AllowCodeGenerationFromStrings(bool allow);
3457
3458 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003459 * Stack-allocated class which sets the execution context for all
3460 * operations executed within a local scope.
3461 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00003462 class Scope {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003463 public:
karlklose@chromium.org44bc7082011-04-11 12:33:05 +00003464 explicit inline Scope(Handle<Context> context) : context_(context) {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003465 context_->Enter();
3466 }
3467 inline ~Scope() { context_->Exit(); }
3468 private:
3469 Handle<Context> context_;
3470 };
3471
3472 private:
3473 friend class Value;
3474 friend class Script;
3475 friend class Object;
3476 friend class Function;
3477};
3478
3479
3480/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00003481 * Multiple threads in V8 are allowed, but only one thread at a time
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003482 * is allowed to use any given V8 isolate. See Isolate class
3483 * comments. The definition of 'using V8 isolate' includes
3484 * accessing handles or holding onto object pointers obtained
3485 * from V8 handles while in the particular V8 isolate. It is up
3486 * to the user of V8 to ensure (perhaps with locking) that this
3487 * constraint is not violated.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003488 *
lrn@chromium.org1c092762011-05-09 09:42:16 +00003489 * v8::Locker is a scoped lock object. While it's
3490 * active (i.e. between its construction and destruction) the current thread is
3491 * allowed to use the locked isolate. V8 guarantees that an isolate can be locked
3492 * by at most one thread at any time. In other words, the scope of a v8::Locker is
3493 * a critical section.
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003494 *
lrn@chromium.org1c092762011-05-09 09:42:16 +00003495 * Sample usage:
3496* \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003497 * ...
3498 * {
lrn@chromium.org1c092762011-05-09 09:42:16 +00003499 * v8::Locker locker(isolate);
3500 * v8::Isolate::Scope isolate_scope(isolate);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003501 * ...
lrn@chromium.org1c092762011-05-09 09:42:16 +00003502 * // Code using V8 and isolate goes here.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003503 * ...
3504 * } // Destructor called here
v8.team.kasperl727e9952008-09-02 14:56:44 +00003505 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003506 *
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00003507 * If you wish to stop using V8 in a thread A you can do this either
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003508 * by destroying the v8::Locker object as above or by constructing a
3509 * v8::Unlocker object:
3510 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00003511 * \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003512 * {
lrn@chromium.org1c092762011-05-09 09:42:16 +00003513 * isolate->Exit();
3514 * v8::Unlocker unlocker(isolate);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003515 * ...
3516 * // Code not using V8 goes here while V8 can run in another thread.
3517 * ...
3518 * } // Destructor called here.
lrn@chromium.org1c092762011-05-09 09:42:16 +00003519 * isolate->Enter();
v8.team.kasperl727e9952008-09-02 14:56:44 +00003520 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003521 *
3522 * The Unlocker object is intended for use in a long-running callback
3523 * from V8, where you want to release the V8 lock for other threads to
3524 * use.
3525 *
3526 * The v8::Locker is a recursive lock. That is, you can lock more than
3527 * once in a given thread. This can be useful if you have code that can
3528 * be called either from code that holds the lock or from code that does
3529 * not. The Unlocker is not recursive so you can not have several
3530 * Unlockers on the stack at once, and you can not use an Unlocker in a
3531 * thread that is not inside a Locker's scope.
3532 *
3533 * An unlocker will unlock several lockers if it has to and reinstate
3534 * the correct depth of locking on its destruction. eg.:
3535 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00003536 * \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003537 * // V8 not locked.
3538 * {
lrn@chromium.org1c092762011-05-09 09:42:16 +00003539 * v8::Locker locker(isolate);
3540 * Isolate::Scope isolate_scope(isolate);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003541 * // V8 locked.
3542 * {
lrn@chromium.org1c092762011-05-09 09:42:16 +00003543 * v8::Locker another_locker(isolate);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003544 * // V8 still locked (2 levels).
3545 * {
lrn@chromium.org1c092762011-05-09 09:42:16 +00003546 * isolate->Exit();
3547 * v8::Unlocker unlocker(isolate);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003548 * // V8 not locked.
3549 * }
lrn@chromium.org1c092762011-05-09 09:42:16 +00003550 * isolate->Enter();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003551 * // V8 locked again (2 levels).
3552 * }
3553 * // V8 still locked (1 level).
3554 * }
3555 * // V8 Now no longer locked.
v8.team.kasperl727e9952008-09-02 14:56:44 +00003556 * \endcode
lrn@chromium.org1c092762011-05-09 09:42:16 +00003557 *
3558 *
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003559 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00003560class V8EXPORT Unlocker {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003561 public:
lrn@chromium.org1c092762011-05-09 09:42:16 +00003562 /**
3563 * Initialize Unlocker for a given Isolate. NULL means default isolate.
3564 */
3565 explicit Unlocker(Isolate* isolate = NULL);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003566 ~Unlocker();
lrn@chromium.org1c092762011-05-09 09:42:16 +00003567 private:
3568 internal::Isolate* isolate_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003569};
3570
3571
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00003572class V8EXPORT Locker {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003573 public:
lrn@chromium.org1c092762011-05-09 09:42:16 +00003574 /**
3575 * Initialize Locker for a given Isolate. NULL means default isolate.
3576 */
3577 explicit Locker(Isolate* isolate = NULL);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003578 ~Locker();
v8.team.kasperl727e9952008-09-02 14:56:44 +00003579
3580 /**
3581 * Start preemption.
3582 *
vegorov@chromium.org7304bca2011-05-16 12:14:13 +00003583 * When preemption is started, a timer is fired every n milliseconds
v8.team.kasperl727e9952008-09-02 14:56:44 +00003584 * that will switch between multiple threads that are in contention
3585 * for the V8 lock.
3586 */
3587 static void StartPreemption(int every_n_ms);
3588
3589 /**
3590 * Stop preemption.
3591 */
3592 static void StopPreemption();
3593
ager@chromium.org9258b6b2008-09-11 09:11:10 +00003594 /**
lrn@chromium.org1c092762011-05-09 09:42:16 +00003595 * Returns whether or not the locker for a given isolate, or default isolate if NULL is given,
3596 * is locked by the current thread.
ager@chromium.org9258b6b2008-09-11 09:11:10 +00003597 */
lrn@chromium.org1c092762011-05-09 09:42:16 +00003598 static bool IsLocked(Isolate* isolate = NULL);
ager@chromium.org9258b6b2008-09-11 09:11:10 +00003599
ager@chromium.orgddb913d2009-01-27 10:01:48 +00003600 /**
3601 * Returns whether v8::Locker is being used by this V8 instance.
3602 */
3603 static bool IsActive() { return active_; }
3604
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003605 private:
3606 bool has_lock_;
3607 bool top_level_;
lrn@chromium.org1c092762011-05-09 09:42:16 +00003608 internal::Isolate* isolate_;
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00003609
ager@chromium.orgddb913d2009-01-27 10:01:48 +00003610 static bool active_;
3611
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00003612 // Disallow copying and assigning.
3613 Locker(const Locker&);
3614 void operator=(const Locker&);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003615};
3616
3617
erik.corry@gmail.comd88afa22010-09-15 12:33:05 +00003618/**
3619 * An interface for exporting data from V8, using "push" model.
3620 */
whesse@chromium.orgf0ac72d2010-11-08 12:47:26 +00003621class V8EXPORT OutputStream { // NOLINT
3622 public:
erik.corry@gmail.comd88afa22010-09-15 12:33:05 +00003623 enum OutputEncoding {
3624 kAscii = 0 // 7-bit ASCII.
3625 };
3626 enum WriteResult {
3627 kContinue = 0,
3628 kAbort = 1
3629 };
3630 virtual ~OutputStream() {}
3631 /** Notify about the end of stream. */
3632 virtual void EndOfStream() = 0;
3633 /** Get preferred output chunk size. Called only once. */
3634 virtual int GetChunkSize() { return 1024; }
3635 /** Get preferred output encoding. Called only once. */
3636 virtual OutputEncoding GetOutputEncoding() { return kAscii; }
3637 /**
3638 * Writes the next chunk of snapshot data into the stream. Writing
3639 * can be stopped by returning kAbort as function result. EndOfStream
3640 * will not be called in case writing was aborted.
3641 */
3642 virtual WriteResult WriteAsciiChunk(char* data, int size) = 0;
3643};
3644
3645
ager@chromium.org5f0c45f2010-12-17 08:51:21 +00003646/**
3647 * An interface for reporting progress and controlling long-running
3648 * activities.
3649 */
3650class V8EXPORT ActivityControl { // NOLINT
3651 public:
3652 enum ControlOption {
3653 kContinue = 0,
3654 kAbort = 1
3655 };
3656 virtual ~ActivityControl() {}
3657 /**
3658 * Notify about current progress. The activity can be stopped by
3659 * returning kAbort as the callback result.
3660 */
3661 virtual ControlOption ReportProgressValue(int done, int total) = 0;
3662};
3663
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003664
fschneider@chromium.orgfb144a02011-05-04 12:43:48 +00003665// --- Implementation ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003666
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003667
3668namespace internal {
3669
erik.corry@gmail.com4a6c3272010-11-18 12:04:40 +00003670static const int kApiPointerSize = sizeof(void*); // NOLINT
3671static const int kApiIntSize = sizeof(int); // NOLINT
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003672
3673// Tag information for HeapObject.
3674const int kHeapObjectTag = 1;
3675const int kHeapObjectTagSize = 2;
3676const intptr_t kHeapObjectTagMask = (1 << kHeapObjectTagSize) - 1;
3677
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003678// Tag information for Smi.
3679const int kSmiTag = 0;
3680const int kSmiTagSize = 1;
3681const intptr_t kSmiTagMask = (1 << kSmiTagSize) - 1;
3682
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003683template <size_t ptr_size> struct SmiTagging;
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003684
3685// Smi constants for 32-bit systems.
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003686template <> struct SmiTagging<4> {
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003687 static const int kSmiShiftSize = 0;
3688 static const int kSmiValueSize = 31;
3689 static inline int SmiToInt(internal::Object* value) {
3690 int shift_bits = kSmiTagSize + kSmiShiftSize;
3691 // Throw away top 32 bits and shift down (requires >> to be sign extending).
3692 return static_cast<int>(reinterpret_cast<intptr_t>(value)) >> shift_bits;
3693 }
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003694
3695 // For 32-bit systems any 2 bytes aligned pointer can be encoded as smi
3696 // with a plain reinterpret_cast.
vegorov@chromium.org0a4e9012011-01-24 12:33:13 +00003697 static const uintptr_t kEncodablePointerMask = 0x1;
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003698 static const int kPointerToSmiShift = 0;
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003699};
3700
3701// Smi constants for 64-bit systems.
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003702template <> struct SmiTagging<8> {
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003703 static const int kSmiShiftSize = 31;
3704 static const int kSmiValueSize = 32;
3705 static inline int SmiToInt(internal::Object* value) {
3706 int shift_bits = kSmiTagSize + kSmiShiftSize;
3707 // Shift down and throw away top 32 bits.
3708 return static_cast<int>(reinterpret_cast<intptr_t>(value) >> shift_bits);
3709 }
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003710
3711 // To maximize the range of pointers that can be encoded
3712 // in the available 32 bits, we require them to be 8 bytes aligned.
3713 // This gives 2 ^ (32 + 3) = 32G address space covered.
3714 // It might be not enough to cover stack allocated objects on some platforms.
3715 static const int kPointerAlignment = 3;
3716
vegorov@chromium.org0a4e9012011-01-24 12:33:13 +00003717 static const uintptr_t kEncodablePointerMask =
3718 ~(uintptr_t(0xffffffff) << kPointerAlignment);
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003719
3720 static const int kPointerToSmiShift =
3721 kSmiTagSize + kSmiShiftSize - kPointerAlignment;
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003722};
3723
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003724typedef SmiTagging<kApiPointerSize> PlatformSmiTagging;
3725const int kSmiShiftSize = PlatformSmiTagging::kSmiShiftSize;
3726const int kSmiValueSize = PlatformSmiTagging::kSmiValueSize;
vegorov@chromium.org0a4e9012011-01-24 12:33:13 +00003727const uintptr_t kEncodablePointerMask =
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003728 PlatformSmiTagging::kEncodablePointerMask;
3729const int kPointerToSmiShift = PlatformSmiTagging::kPointerToSmiShift;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003730
sgjesse@chromium.orgac6aa172009-12-04 12:29:05 +00003731template <size_t ptr_size> struct InternalConstants;
3732
3733// Internal constants for 32-bit systems.
3734template <> struct InternalConstants<4> {
erik.corry@gmail.com4a6c3272010-11-18 12:04:40 +00003735 static const int kStringResourceOffset = 3 * kApiPointerSize;
sgjesse@chromium.orgac6aa172009-12-04 12:29:05 +00003736};
3737
3738// Internal constants for 64-bit systems.
3739template <> struct InternalConstants<8> {
erik.corry@gmail.com4a6c3272010-11-18 12:04:40 +00003740 static const int kStringResourceOffset = 3 * kApiPointerSize;
sgjesse@chromium.orgac6aa172009-12-04 12:29:05 +00003741};
3742
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003743/**
3744 * This class exports constants and functionality from within v8 that
3745 * is necessary to implement inline functions in the v8 api. Don't
3746 * depend on functions and constants defined here.
3747 */
3748class Internals {
3749 public:
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003750 // These values match non-compiler-dependent values defined within
3751 // the implementation of v8.
3752 static const int kHeapObjectMapOffset = 0;
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003753 static const int kMapInstanceTypeOffset = 1 * kApiPointerSize + kApiIntSize;
sgjesse@chromium.orgac6aa172009-12-04 12:29:05 +00003754 static const int kStringResourceOffset =
erik.corry@gmail.com4a6c3272010-11-18 12:04:40 +00003755 InternalConstants<kApiPointerSize>::kStringResourceOffset;
sgjesse@chromium.orgac6aa172009-12-04 12:29:05 +00003756
ager@chromium.orgea91cc52011-05-23 06:06:11 +00003757 static const int kForeignAddressOffset = kApiPointerSize;
erik.corry@gmail.com4a6c3272010-11-18 12:04:40 +00003758 static const int kJSObjectHeaderSize = 3 * kApiPointerSize;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003759 static const int kFullStringRepresentationMask = 0x07;
sgjesse@chromium.org82dbbab2010-06-02 08:57:44 +00003760 static const int kExternalTwoByteRepresentationTag = 0x02;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003761
svenpanne@chromium.org6d786c92011-06-15 10:58:27 +00003762 static const int kJSObjectType = 0xa3;
ricow@chromium.org5ad5ace2010-06-23 09:06:43 +00003763 static const int kFirstNonstringType = 0x80;
ager@chromium.orgea91cc52011-05-23 06:06:11 +00003764 static const int kForeignType = 0x85;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003765
3766 static inline bool HasHeapObjectTag(internal::Object* value) {
3767 return ((reinterpret_cast<intptr_t>(value) & kHeapObjectTagMask) ==
3768 kHeapObjectTag);
3769 }
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00003770
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003771 static inline bool HasSmiTag(internal::Object* value) {
3772 return ((reinterpret_cast<intptr_t>(value) & kSmiTagMask) == kSmiTag);
3773 }
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00003774
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003775 static inline int SmiValue(internal::Object* value) {
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003776 return PlatformSmiTagging::SmiToInt(value);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003777 }
3778
3779 static inline int GetInstanceType(internal::Object* obj) {
3780 typedef internal::Object O;
3781 O* map = ReadField<O*>(obj, kHeapObjectMapOffset);
3782 return ReadField<uint8_t>(map, kMapInstanceTypeOffset);
3783 }
3784
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003785 static inline void* GetExternalPointerFromSmi(internal::Object* value) {
vegorov@chromium.org0a4e9012011-01-24 12:33:13 +00003786 const uintptr_t address = reinterpret_cast<uintptr_t>(value);
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003787 return reinterpret_cast<void*>(address >> kPointerToSmiShift);
3788 }
3789
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003790 static inline void* GetExternalPointer(internal::Object* obj) {
3791 if (HasSmiTag(obj)) {
sgjesse@chromium.orgc6c57182011-01-17 12:24:25 +00003792 return GetExternalPointerFromSmi(obj);
ager@chromium.orgea91cc52011-05-23 06:06:11 +00003793 } else if (GetInstanceType(obj) == kForeignType) {
3794 return ReadField<void*>(obj, kForeignAddressOffset);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003795 } else {
3796 return NULL;
3797 }
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003798 }
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00003799
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003800 static inline bool IsExternalTwoByteString(int instance_type) {
3801 int representation = (instance_type & kFullStringRepresentationMask);
3802 return representation == kExternalTwoByteRepresentationTag;
3803 }
3804
3805 template <typename T>
3806 static inline T ReadField(Object* ptr, int offset) {
3807 uint8_t* addr = reinterpret_cast<uint8_t*>(ptr) + offset - kHeapObjectTag;
3808 return *reinterpret_cast<T*>(addr);
3809 }
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003810
3811 static inline bool CanCastToHeapObject(void* o) { return false; }
3812 static inline bool CanCastToHeapObject(Context* o) { return true; }
3813 static inline bool CanCastToHeapObject(String* o) { return true; }
3814 static inline bool CanCastToHeapObject(Object* o) { return true; }
3815 static inline bool CanCastToHeapObject(Message* o) { return true; }
3816 static inline bool CanCastToHeapObject(StackTrace* o) { return true; }
3817 static inline bool CanCastToHeapObject(StackFrame* o) { return true; }
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003818};
3819
whesse@chromium.orgf0ac72d2010-11-08 12:47:26 +00003820} // namespace internal
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003821
3822
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003823template <class T>
3824Handle<T>::Handle() : val_(0) { }
3825
3826
3827template <class T>
3828Local<T>::Local() : Handle<T>() { }
3829
3830
3831template <class T>
3832Local<T> Local<T>::New(Handle<T> that) {
3833 if (that.IsEmpty()) return Local<T>();
sgjesse@chromium.orgea88ce92011-03-23 11:19:56 +00003834 T* that_ptr = *that;
3835 internal::Object** p = reinterpret_cast<internal::Object**>(that_ptr);
3836 if (internal::Internals::CanCastToHeapObject(that_ptr)) {
3837 return Local<T>(reinterpret_cast<T*>(HandleScope::CreateHandle(
3838 reinterpret_cast<internal::HeapObject*>(*p))));
3839 }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003840 return Local<T>(reinterpret_cast<T*>(HandleScope::CreateHandle(*p)));
3841}
3842
3843
3844template <class T>
3845Persistent<T> Persistent<T>::New(Handle<T> that) {
3846 if (that.IsEmpty()) return Persistent<T>();
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003847 internal::Object** p = reinterpret_cast<internal::Object**>(*that);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003848 return Persistent<T>(reinterpret_cast<T*>(V8::GlobalizeReference(p)));
3849}
3850
3851
3852template <class T>
ager@chromium.org32912102009-01-16 10:38:43 +00003853bool Persistent<T>::IsNearDeath() const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003854 if (this->IsEmpty()) return false;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003855 return V8::IsGlobalNearDeath(reinterpret_cast<internal::Object**>(**this));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003856}
3857
3858
3859template <class T>
ager@chromium.org32912102009-01-16 10:38:43 +00003860bool Persistent<T>::IsWeak() const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003861 if (this->IsEmpty()) return false;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003862 return V8::IsGlobalWeak(reinterpret_cast<internal::Object**>(**this));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003863}
3864
3865
3866template <class T>
3867void Persistent<T>::Dispose() {
3868 if (this->IsEmpty()) return;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003869 V8::DisposeGlobal(reinterpret_cast<internal::Object**>(**this));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003870}
3871
3872
3873template <class T>
3874Persistent<T>::Persistent() : Handle<T>() { }
3875
3876template <class T>
3877void Persistent<T>::MakeWeak(void* parameters, WeakReferenceCallback callback) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003878 V8::MakeWeak(reinterpret_cast<internal::Object**>(**this),
3879 parameters,
3880 callback);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003881}
3882
3883template <class T>
3884void Persistent<T>::ClearWeak() {
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003885 V8::ClearWeak(reinterpret_cast<internal::Object**>(**this));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003886}
3887
whesse@chromium.orgb08986c2011-03-14 16:13:42 +00003888template <class T>
kmillikin@chromium.orgc53e10d2011-05-18 09:12:58 +00003889void Persistent<T>::MarkIndependent() {
3890 V8::MarkIndependent(reinterpret_cast<internal::Object**>(**this));
3891}
3892
3893template <class T>
whesse@chromium.orgb08986c2011-03-14 16:13:42 +00003894void Persistent<T>::SetWrapperClassId(uint16_t class_id) {
3895 V8::SetWrapperClassId(reinterpret_cast<internal::Object**>(**this), class_id);
3896}
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00003897
fschneider@chromium.orge03fb642010-11-01 12:34:09 +00003898Arguments::Arguments(internal::Object** implicit_args,
3899 internal::Object** values, int length,
3900 bool is_construct_call)
3901 : implicit_args_(implicit_args),
3902 values_(values),
3903 length_(length),
3904 is_construct_call_(is_construct_call) { }
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00003905
3906
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003907Local<Value> Arguments::operator[](int i) const {
3908 if (i < 0 || length_ <= i) return Local<Value>(*Undefined());
3909 return Local<Value>(reinterpret_cast<Value*>(values_ - i));
3910}
3911
3912
3913Local<Function> Arguments::Callee() const {
fschneider@chromium.orge03fb642010-11-01 12:34:09 +00003914 return Local<Function>(reinterpret_cast<Function*>(
3915 &implicit_args_[kCalleeIndex]));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003916}
3917
3918
3919Local<Object> Arguments::This() const {
3920 return Local<Object>(reinterpret_cast<Object*>(values_ + 1));
3921}
3922
3923
3924Local<Object> Arguments::Holder() const {
fschneider@chromium.orge03fb642010-11-01 12:34:09 +00003925 return Local<Object>(reinterpret_cast<Object*>(
3926 &implicit_args_[kHolderIndex]));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003927}
3928
3929
3930Local<Value> Arguments::Data() const {
fschneider@chromium.orge03fb642010-11-01 12:34:09 +00003931 return Local<Value>(reinterpret_cast<Value*>(&implicit_args_[kDataIndex]));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003932}
3933
3934
3935bool Arguments::IsConstructCall() const {
3936 return is_construct_call_;
3937}
3938
3939
3940int Arguments::Length() const {
3941 return length_;
3942}
3943
3944
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003945template <class T>
3946Local<T> HandleScope::Close(Handle<T> value) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003947 internal::Object** before = reinterpret_cast<internal::Object**>(*value);
3948 internal::Object** after = RawClose(before);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003949 return Local<T>(reinterpret_cast<T*>(after));
3950}
3951
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00003952Handle<Value> ScriptOrigin::ResourceName() const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003953 return resource_name_;
3954}
3955
3956
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00003957Handle<Integer> ScriptOrigin::ResourceLineOffset() const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003958 return resource_line_offset_;
3959}
3960
3961
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00003962Handle<Integer> ScriptOrigin::ResourceColumnOffset() const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003963 return resource_column_offset_;
3964}
3965
3966
3967Handle<Boolean> Boolean::New(bool value) {
3968 return value ? True() : False();
3969}
3970
3971
3972void Template::Set(const char* name, v8::Handle<Data> value) {
3973 Set(v8::String::New(name), value);
3974}
3975
3976
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003977Local<Value> Object::GetInternalField(int index) {
3978#ifndef V8_ENABLE_CHECKS
3979 Local<Value> quick_result = UncheckedGetInternalField(index);
3980 if (!quick_result.IsEmpty()) return quick_result;
3981#endif
3982 return CheckedGetInternalField(index);
3983}
3984
3985
3986Local<Value> Object::UncheckedGetInternalField(int index) {
3987 typedef internal::Object O;
3988 typedef internal::Internals I;
3989 O* obj = *reinterpret_cast<O**>(this);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003990 if (I::GetInstanceType(obj) == I::kJSObjectType) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003991 // If the object is a plain JSObject, which is the common case,
3992 // we know where to find the internal fields and can return the
3993 // value directly.
erik.corry@gmail.com4a6c3272010-11-18 12:04:40 +00003994 int offset = I::kJSObjectHeaderSize + (internal::kApiPointerSize * index);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003995 O* value = I::ReadField<O*>(obj, offset);
3996 O** result = HandleScope::CreateHandle(value);
3997 return Local<Value>(reinterpret_cast<Value*>(result));
3998 } else {
3999 return Local<Value>();
4000 }
4001}
4002
4003
4004void* External::Unwrap(Handle<v8::Value> obj) {
4005#ifdef V8_ENABLE_CHECKS
4006 return FullUnwrap(obj);
4007#else
4008 return QuickUnwrap(obj);
4009#endif
4010}
4011
4012
4013void* External::QuickUnwrap(Handle<v8::Value> wrapper) {
4014 typedef internal::Object O;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004015 O* obj = *reinterpret_cast<O**>(const_cast<v8::Value*>(*wrapper));
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00004016 return internal::Internals::GetExternalPointer(obj);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004017}
4018
4019
4020void* Object::GetPointerFromInternalField(int index) {
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00004021 typedef internal::Object O;
4022 typedef internal::Internals I;
4023
4024 O* obj = *reinterpret_cast<O**>(this);
4025
4026 if (I::GetInstanceType(obj) == I::kJSObjectType) {
4027 // If the object is a plain JSObject, which is the common case,
4028 // we know where to find the internal fields and can return the
4029 // value directly.
erik.corry@gmail.com4a6c3272010-11-18 12:04:40 +00004030 int offset = I::kJSObjectHeaderSize + (internal::kApiPointerSize * index);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00004031 O* value = I::ReadField<O*>(obj, offset);
4032 return I::GetExternalPointer(value);
4033 }
4034
4035 return SlowGetPointerFromInternalField(index);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004036}
4037
4038
4039String* String::Cast(v8::Value* value) {
4040#ifdef V8_ENABLE_CHECKS
4041 CheckCast(value);
4042#endif
4043 return static_cast<String*>(value);
4044}
4045
4046
4047String::ExternalStringResource* String::GetExternalStringResource() const {
4048 typedef internal::Object O;
4049 typedef internal::Internals I;
4050 O* obj = *reinterpret_cast<O**>(const_cast<String*>(this));
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004051 String::ExternalStringResource* result;
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00004052 if (I::IsExternalTwoByteString(I::GetInstanceType(obj))) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004053 void* value = I::ReadField<void*>(obj, I::kStringResourceOffset);
4054 result = reinterpret_cast<String::ExternalStringResource*>(value);
4055 } else {
4056 result = NULL;
4057 }
4058#ifdef V8_ENABLE_CHECKS
4059 VerifyExternalStringResource(result);
4060#endif
4061 return result;
4062}
4063
4064
4065bool Value::IsString() const {
4066#ifdef V8_ENABLE_CHECKS
4067 return FullIsString();
4068#else
4069 return QuickIsString();
4070#endif
4071}
4072
4073bool Value::QuickIsString() const {
4074 typedef internal::Object O;
4075 typedef internal::Internals I;
4076 O* obj = *reinterpret_cast<O**>(const_cast<Value*>(this));
4077 if (!I::HasHeapObjectTag(obj)) return false;
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00004078 return (I::GetInstanceType(obj) < I::kFirstNonstringType);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004079}
4080
4081
4082Number* Number::Cast(v8::Value* value) {
4083#ifdef V8_ENABLE_CHECKS
4084 CheckCast(value);
4085#endif
4086 return static_cast<Number*>(value);
4087}
4088
4089
4090Integer* Integer::Cast(v8::Value* value) {
4091#ifdef V8_ENABLE_CHECKS
4092 CheckCast(value);
4093#endif
4094 return static_cast<Integer*>(value);
4095}
4096
4097
4098Date* Date::Cast(v8::Value* value) {
4099#ifdef V8_ENABLE_CHECKS
4100 CheckCast(value);
4101#endif
4102 return static_cast<Date*>(value);
4103}
4104
4105
svenpanne@chromium.org84bcc552011-07-18 09:50:57 +00004106StringObject* StringObject::Cast(v8::Value* value) {
4107#ifdef V8_ENABLE_CHECKS
4108 CheckCast(value);
4109#endif
4110 return static_cast<StringObject*>(value);
4111}
4112
4113
4114NumberObject* NumberObject::Cast(v8::Value* value) {
4115#ifdef V8_ENABLE_CHECKS
4116 CheckCast(value);
4117#endif
4118 return static_cast<NumberObject*>(value);
4119}
4120
4121
4122BooleanObject* BooleanObject::Cast(v8::Value* value) {
4123#ifdef V8_ENABLE_CHECKS
4124 CheckCast(value);
4125#endif
4126 return static_cast<BooleanObject*>(value);
4127}
4128
4129
ager@chromium.orgb61a0d12010-10-13 08:35:23 +00004130RegExp* RegExp::Cast(v8::Value* value) {
4131#ifdef V8_ENABLE_CHECKS
4132 CheckCast(value);
4133#endif
4134 return static_cast<RegExp*>(value);
4135}
4136
4137
ager@chromium.org18ad94b2009-09-02 08:22:29 +00004138Object* Object::Cast(v8::Value* value) {
4139#ifdef V8_ENABLE_CHECKS
4140 CheckCast(value);
4141#endif
4142 return static_cast<Object*>(value);
4143}
4144
4145
4146Array* Array::Cast(v8::Value* value) {
4147#ifdef V8_ENABLE_CHECKS
4148 CheckCast(value);
4149#endif
4150 return static_cast<Array*>(value);
4151}
4152
4153
4154Function* Function::Cast(v8::Value* value) {
4155#ifdef V8_ENABLE_CHECKS
4156 CheckCast(value);
4157#endif
4158 return static_cast<Function*>(value);
4159}
4160
4161
4162External* External::Cast(v8::Value* value) {
4163#ifdef V8_ENABLE_CHECKS
4164 CheckCast(value);
4165#endif
4166 return static_cast<External*>(value);
4167}
4168
4169
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00004170Local<Value> AccessorInfo::Data() const {
ager@chromium.orgb26c50a2010-03-26 09:27:16 +00004171 return Local<Value>(reinterpret_cast<Value*>(&args_[-2]));
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00004172}
4173
4174
4175Local<Object> AccessorInfo::This() const {
4176 return Local<Object>(reinterpret_cast<Object*>(&args_[0]));
4177}
4178
4179
4180Local<Object> AccessorInfo::Holder() const {
4181 return Local<Object>(reinterpret_cast<Object*>(&args_[-1]));
4182}
4183
4184
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00004185/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00004186 * \example shell.cc
4187 * A simple shell that takes a list of expressions on the
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00004188 * command-line and executes them.
4189 */
4190
4191
4192/**
4193 * \example process.cc
4194 */
4195
4196
4197} // namespace v8
4198
4199
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00004200#undef V8EXPORT
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00004201#undef TYPE_CHECK
4202
4203
ager@chromium.org9258b6b2008-09-11 09:11:10 +00004204#endif // V8_H_