blob: ca4a247fe80d7b79674a7608844c9174932ab384 [file] [log] [blame]
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00001// Copyright 2007-2009 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
41#include <stdio.h>
42
43#ifdef _WIN32
kasperl@chromium.org71affb52009-05-26 05:44:31 +000044// When compiling on MinGW stdint.h is available.
45#ifdef __MINGW32__
46#include <stdint.h>
47#else // __MINGW32__
ager@chromium.org5ec48922009-05-05 07:25:34 +000048typedef signed char int8_t;
49typedef unsigned char uint8_t;
50typedef short int16_t; // NOLINT
51typedef unsigned short uint16_t; // NOLINT
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000052typedef int int32_t;
53typedef unsigned int uint32_t;
ager@chromium.org5ec48922009-05-05 07:25:34 +000054typedef __int64 int64_t;
55typedef unsigned __int64 uint64_t;
kasperl@chromium.org71affb52009-05-26 05:44:31 +000056// intptr_t and friends are defined in crtdefs.h through stdio.h.
57#endif // __MINGW32__
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000058
59// Setup for Windows DLL export/import. When building the V8 DLL the
60// BUILDING_V8_SHARED needs to be defined. When building a program which uses
61// the V8 DLL USING_V8_SHARED needs to be defined. When either building the V8
62// static library or building a program which uses the V8 static library neither
63// BUILDING_V8_SHARED nor USING_V8_SHARED should be defined.
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000064#if defined(BUILDING_V8_SHARED) && defined(USING_V8_SHARED)
65#error both BUILDING_V8_SHARED and USING_V8_SHARED are set - please check the\
66 build configuration to ensure that at most one of these is set
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000067#endif
68
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000069#ifdef BUILDING_V8_SHARED
ager@chromium.orgbb29dc92009-03-24 13:25:23 +000070#define V8EXPORT __declspec(dllexport)
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000071#elif USING_V8_SHARED
ager@chromium.orgbb29dc92009-03-24 13:25:23 +000072#define V8EXPORT __declspec(dllimport)
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000073#else
ager@chromium.orgbb29dc92009-03-24 13:25:23 +000074#define V8EXPORT
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000075#endif // BUILDING_V8_SHARED
76
77#else // _WIN32
ager@chromium.org9085a012009-05-11 19:22:57 +000078
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000079#include <stdint.h>
80
sgjesse@chromium.orgb9d7da12009-08-05 08:38:10 +000081// Setup for Linux shared library export. There is no need to distinguish
82// between building or using the V8 shared library, but we should not
83// export symbols when we are building a static library.
84#if defined(__GNUC__) && (__GNUC__ >= 4) && defined(V8_SHARED)
ager@chromium.orgbb29dc92009-03-24 13:25:23 +000085#define V8EXPORT __attribute__ ((visibility("default")))
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000086#else // defined(__GNUC__) && (__GNUC__ >= 4)
ager@chromium.orgbb29dc92009-03-24 13:25:23 +000087#define V8EXPORT
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +000088#endif // defined(__GNUC__) && (__GNUC__ >= 4)
89
90#endif // _WIN32
91
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000092/**
v8.team.kasperl727e9952008-09-02 14:56:44 +000093 * The v8 JavaScript engine.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +000094 */
95namespace v8 {
96
97class Context;
98class String;
99class Value;
100class Utils;
101class Number;
102class Object;
103class Array;
104class Int32;
105class Uint32;
106class External;
107class Primitive;
108class Boolean;
109class Integer;
110class Function;
111class Date;
112class ImplementationUtilities;
113class Signature;
114template <class T> class Handle;
115template <class T> class Local;
116template <class T> class Persistent;
117class FunctionTemplate;
118class ObjectTemplate;
119class Data;
kmillikin@chromium.org9155e252010-05-26 13:27:57 +0000120class AccessorInfo;
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +0000121class StackTrace;
122class StackFrame;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000123
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000124namespace internal {
125
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +0000126class Arguments;
ager@chromium.orgc4c92722009-11-18 14:12:51 +0000127class Object;
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +0000128class Heap;
ager@chromium.orgc4c92722009-11-18 14:12:51 +0000129class Top;
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000130
131}
132
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000133
134// --- W e a k H a n d l e s
135
136
137/**
138 * A weak reference callback function.
139 *
140 * \param object the weak global object to be reclaimed by the garbage collector
141 * \param parameter the value passed in when making the weak global object
142 */
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000143typedef void (*WeakReferenceCallback)(Persistent<Value> object,
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000144 void* parameter);
145
146
147// --- H a n d l e s ---
148
149#define TYPE_CHECK(T, S) \
150 while (false) { \
151 *(static_cast<T**>(0)) = static_cast<S*>(0); \
152 }
153
154/**
155 * An object reference managed by the v8 garbage collector.
156 *
157 * All objects returned from v8 have to be tracked by the garbage
158 * collector so that it knows that the objects are still alive. Also,
159 * because the garbage collector may move objects, it is unsafe to
160 * point directly to an object. Instead, all objects are stored in
161 * handles which are known by the garbage collector and updated
162 * whenever an object moves. Handles should always be passed by value
163 * (except in cases like out-parameters) and they should never be
164 * allocated on the heap.
165 *
166 * There are two types of handles: local and persistent handles.
167 * Local handles are light-weight and transient and typically used in
168 * local operations. They are managed by HandleScopes. Persistent
169 * handles can be used when storing objects across several independent
170 * operations and have to be explicitly deallocated when they're no
171 * longer used.
172 *
173 * It is safe to extract the object stored in the handle by
174 * dereferencing the handle (for instance, to extract the Object* from
175 * an Handle<Object>); the value will still be governed by a handle
176 * behind the scenes and the same rules apply to these values as to
177 * their handles.
178 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000179template <class T> class Handle {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000180 public:
181
182 /**
183 * Creates an empty handle.
184 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000185 inline Handle();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000186
187 /**
188 * Creates a new handle for the specified value.
189 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000190 inline explicit Handle(T* val) : val_(val) { }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000191
192 /**
193 * Creates a handle for the contents of the specified handle. This
194 * constructor allows you to pass handles as arguments by value and
v8.team.kasperl727e9952008-09-02 14:56:44 +0000195 * to assign between handles. However, if you try to assign between
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000196 * incompatible handles, for instance from a Handle<String> to a
197 * Handle<Number> it will cause a compiletime error. Assigning
198 * between compatible handles, for instance assigning a
199 * Handle<String> to a variable declared as Handle<Value>, is legal
200 * because String is a subclass of Value.
201 */
202 template <class S> inline Handle(Handle<S> that)
203 : val_(reinterpret_cast<T*>(*that)) {
204 /**
205 * This check fails when trying to convert between incompatible
206 * handles. For example, converting from a Handle<String> to a
207 * Handle<Number>.
208 */
209 TYPE_CHECK(T, S);
210 }
211
212 /**
213 * Returns true if the handle is empty.
214 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000215 inline bool IsEmpty() const { return val_ == 0; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000216
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000217 inline T* operator->() const { return val_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000218
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000219 inline T* operator*() const { return val_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000220
221 /**
222 * Sets the handle to be empty. IsEmpty() will then return true.
223 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000224 inline void Clear() { this->val_ = 0; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000225
226 /**
227 * Checks whether two handles are the same.
228 * Returns true if both are empty, or if the objects
229 * to which they refer are identical.
230 * The handles' references are not checked.
231 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000232 template <class S> inline bool operator==(Handle<S> that) const {
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000233 internal::Object** a = reinterpret_cast<internal::Object**>(**this);
234 internal::Object** b = reinterpret_cast<internal::Object**>(*that);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000235 if (a == 0) return b == 0;
236 if (b == 0) return false;
237 return *a == *b;
238 }
239
240 /**
241 * Checks whether two handles are different.
242 * Returns true if only one of the handles is empty, or if
243 * the objects to which they refer are different.
244 * The handles' references are not checked.
245 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000246 template <class S> inline bool operator!=(Handle<S> that) const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000247 return !operator==(that);
248 }
249
250 template <class S> static inline Handle<T> Cast(Handle<S> that) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000251#ifdef V8_ENABLE_CHECKS
252 // If we're going to perform the type check then we have to check
253 // that the handle isn't empty before doing the checked cast.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000254 if (that.IsEmpty()) return Handle<T>();
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000255#endif
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000256 return Handle<T>(T::Cast(*that));
257 }
258
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000259 template <class S> inline Handle<S> As() {
260 return Handle<S>::Cast(*this);
261 }
262
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000263 private:
264 T* val_;
265};
266
267
268/**
269 * A light-weight stack-allocated object handle. All operations
270 * that return objects from within v8 return them in local handles. They
271 * are created within HandleScopes, and all local handles allocated within a
272 * handle scope are destroyed when the handle scope is destroyed. Hence it
273 * is not necessary to explicitly deallocate local handles.
274 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000275template <class T> class Local : public Handle<T> {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000276 public:
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000277 inline Local();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000278 template <class S> inline Local(Local<S> that)
279 : Handle<T>(reinterpret_cast<T*>(*that)) {
280 /**
281 * This check fails when trying to convert between incompatible
282 * handles. For example, converting from a Handle<String> to a
283 * Handle<Number>.
284 */
285 TYPE_CHECK(T, S);
286 }
287 template <class S> inline Local(S* that) : Handle<T>(that) { }
288 template <class S> static inline Local<T> Cast(Local<S> that) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000289#ifdef V8_ENABLE_CHECKS
290 // If we're going to perform the type check then we have to check
291 // that the handle isn't empty before doing the checked cast.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000292 if (that.IsEmpty()) return Local<T>();
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000293#endif
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000294 return Local<T>(T::Cast(*that));
295 }
296
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000297 template <class S> inline Local<S> As() {
298 return Local<S>::Cast(*this);
299 }
300
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000301 /** Create a local handle for the content of another handle.
302 * The referee is kept alive by the local handle even when
303 * the original handle is destroyed/disposed.
304 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000305 inline static Local<T> New(Handle<T> that);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000306};
307
308
309/**
310 * An object reference that is independent of any handle scope. Where
v8.team.kasperl727e9952008-09-02 14:56:44 +0000311 * a Local handle only lives as long as the HandleScope in which it was
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000312 * allocated, a Persistent handle remains valid until it is explicitly
313 * disposed.
314 *
315 * A persistent handle contains a reference to a storage cell within
316 * the v8 engine which holds an object value and which is updated by
317 * the garbage collector whenever the object is moved. A new storage
318 * cell can be created using Persistent::New and existing handles can
319 * be disposed using Persistent::Dispose. Since persistent handles
320 * are passed by value you may have many persistent handle objects
321 * that point to the same storage cell. For instance, if you pass a
322 * persistent handle as an argument to a function you will not get two
323 * different storage cells but rather two references to the same
324 * storage cell.
325 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000326template <class T> class Persistent : public Handle<T> {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000327 public:
328
329 /**
330 * Creates an empty persistent handle that doesn't point to any
331 * storage cell.
332 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000333 inline Persistent();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000334
335 /**
336 * Creates a persistent handle for the same storage cell as the
337 * specified handle. This constructor allows you to pass persistent
338 * handles as arguments by value and to assign between persistent
v8.team.kasperl727e9952008-09-02 14:56:44 +0000339 * handles. However, attempting to assign between incompatible
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000340 * persistent handles, for instance from a Persistent<String> to a
v8.team.kasperl727e9952008-09-02 14:56:44 +0000341 * Persistent<Number> will cause a compiletime error. Assigning
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000342 * between compatible persistent handles, for instance assigning a
343 * Persistent<String> to a variable declared as Persistent<Value>,
v8.team.kasperl727e9952008-09-02 14:56:44 +0000344 * is allowed as String is a subclass of Value.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000345 */
346 template <class S> inline Persistent(Persistent<S> that)
347 : Handle<T>(reinterpret_cast<T*>(*that)) {
348 /**
349 * This check fails when trying to convert between incompatible
350 * handles. For example, converting from a Handle<String> to a
351 * Handle<Number>.
352 */
353 TYPE_CHECK(T, S);
354 }
355
356 template <class S> inline Persistent(S* that) : Handle<T>(that) { }
357
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000358 /**
359 * "Casts" a plain handle which is known to be a persistent handle
360 * to a persistent handle.
361 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000362 template <class S> explicit inline Persistent(Handle<S> that)
363 : Handle<T>(*that) { }
364
365 template <class S> static inline Persistent<T> Cast(Persistent<S> that) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000366#ifdef V8_ENABLE_CHECKS
367 // If we're going to perform the type check then we have to check
368 // that the handle isn't empty before doing the checked cast.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000369 if (that.IsEmpty()) return Persistent<T>();
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000370#endif
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000371 return Persistent<T>(T::Cast(*that));
372 }
373
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000374 template <class S> inline Persistent<S> As() {
375 return Persistent<S>::Cast(*this);
376 }
377
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000378 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +0000379 * Creates a new persistent handle for an existing local or
380 * persistent handle.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000381 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000382 inline static Persistent<T> New(Handle<T> that);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000383
384 /**
385 * Releases the storage cell referenced by this persistent handle.
386 * Does not remove the reference to the cell from any handles.
387 * This handle's reference, and any any other references to the storage
388 * cell remain and IsEmpty will still return false.
389 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000390 inline void Dispose();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000391
392 /**
393 * Make the reference to this object weak. When only weak handles
394 * refer to the object, the garbage collector will perform a
395 * callback to the given V8::WeakReferenceCallback function, passing
396 * it the object reference and the given parameters.
397 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000398 inline void MakeWeak(void* parameters, WeakReferenceCallback callback);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000399
400 /** Clears the weak reference to this object.*/
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000401 inline void ClearWeak();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000402
403 /**
404 *Checks if the handle holds the only reference to an object.
405 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000406 inline bool IsNearDeath() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000407
408 /**
409 * Returns true if the handle's reference is weak.
410 */
kasperl@chromium.orge959c182009-07-27 08:59:04 +0000411 inline bool IsWeak() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000412
413 private:
414 friend class ImplementationUtilities;
415 friend class ObjectTemplate;
416};
417
418
v8.team.kasperl727e9952008-09-02 14:56:44 +0000419 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000420 * A stack-allocated class that governs a number of local handles.
421 * After a handle scope has been created, all local handles will be
422 * allocated within that handle scope until either the handle scope is
423 * deleted or another handle scope is created. If there is already a
424 * handle scope and a new one is created, all allocations will take
v8.team.kasperl727e9952008-09-02 14:56:44 +0000425 * place in the new handle scope until it is deleted. After that,
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000426 * new handles will again be allocated in the original handle scope.
427 *
428 * After the handle scope of a local handle has been deleted the
429 * garbage collector will no longer track the object stored in the
430 * handle and may deallocate it. The behavior of accessing a handle
431 * for which the handle scope has been deleted is undefined.
432 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000433class V8EXPORT HandleScope {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000434 public:
ager@chromium.orgddb913d2009-01-27 10:01:48 +0000435 HandleScope();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000436
ager@chromium.orgddb913d2009-01-27 10:01:48 +0000437 ~HandleScope();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000438
439 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000440 * Closes the handle scope and returns the value as a handle in the
441 * previous scope, which is the new current scope after the call.
442 */
443 template <class T> Local<T> Close(Handle<T> value);
444
445 /**
446 * Counts the number of allocated handles.
447 */
448 static int NumberOfHandles();
449
450 /**
451 * Creates a new handle with the given value.
452 */
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000453 static internal::Object** CreateHandle(internal::Object* value);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000454
455 private:
456 // Make it impossible to create heap-allocated or illegal handle
457 // scopes by disallowing certain operations.
458 HandleScope(const HandleScope&);
459 void operator=(const HandleScope&);
460 void* operator new(size_t size);
461 void operator delete(void*, size_t);
462
ager@chromium.org3811b432009-10-28 14:53:37 +0000463 // This Data class is accessible internally as HandleScopeData through a
464 // typedef in the ImplementationUtilities class.
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000465 class V8EXPORT Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000466 public:
467 int extensions;
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000468 internal::Object** next;
469 internal::Object** limit;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000470 inline void Initialize() {
471 extensions = -1;
472 next = limit = NULL;
473 }
474 };
475
ager@chromium.orgddb913d2009-01-27 10:01:48 +0000476 Data previous_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000477
ager@chromium.orgddb913d2009-01-27 10:01:48 +0000478 // Allow for the active closing of HandleScopes which allows to pass a handle
479 // from the HandleScope being closed to the next top most HandleScope.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000480 bool is_closed_;
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000481 internal::Object** RawClose(internal::Object** value);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000482
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000483 friend class ImplementationUtilities;
484};
485
486
487// --- S p e c i a l o b j e c t s ---
488
489
490/**
491 * The superclass of values and API object templates.
492 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000493class V8EXPORT Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000494 private:
495 Data();
496};
497
498
499/**
500 * Pre-compilation data that can be associated with a script. This
501 * data can be calculated for a script in advance of actually
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000502 * compiling it, and can be stored between compilations. When script
v8.team.kasperl727e9952008-09-02 14:56:44 +0000503 * data is given to the compile method compilation will be faster.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000504 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000505class V8EXPORT ScriptData { // NOLINT
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000506 public:
507 virtual ~ScriptData() { }
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +0000508
kmillikin@chromium.org9155e252010-05-26 13:27:57 +0000509 /**
510 * Pre-compiles the specified script (context-independent).
511 *
512 * \param input Pointer to UTF-8 script source code.
513 * \param length Length of UTF-8 script source code.
514 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000515 static ScriptData* PreCompile(const char* input, int length);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000516
kmillikin@chromium.org9155e252010-05-26 13:27:57 +0000517 /**
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +0000518 * Pre-compiles the specified script (context-independent).
519 *
520 * NOTE: Pre-compilation using this method cannot happen on another thread
521 * without using Lockers.
522 *
523 * \param source Script source code.
524 */
525 static ScriptData* PreCompile(Handle<String> source);
526
527 /**
kmillikin@chromium.org9155e252010-05-26 13:27:57 +0000528 * Load previous pre-compilation data.
529 *
530 * \param data Pointer to data returned by a call to Data() of a previous
531 * ScriptData. Ownership is not transferred.
532 * \param length Length of data.
533 */
534 static ScriptData* New(const char* data, int length);
535
536 /**
537 * Returns the length of Data().
538 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000539 virtual int Length() = 0;
kmillikin@chromium.org9155e252010-05-26 13:27:57 +0000540
541 /**
542 * Returns a serialized representation of this ScriptData that can later be
543 * passed to New(). NOTE: Serialized data is platform-dependent.
544 */
545 virtual const char* Data() = 0;
546
547 /**
548 * Returns true if the source code could not be parsed.
549 */
fschneider@chromium.org0c20e672010-01-14 15:28:53 +0000550 virtual bool HasError() = 0;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000551};
552
553
554/**
555 * The origin, within a file, of a script.
556 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000557class ScriptOrigin {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000558 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000559 inline ScriptOrigin(
560 Handle<Value> resource_name,
561 Handle<Integer> resource_line_offset = Handle<Integer>(),
562 Handle<Integer> resource_column_offset = Handle<Integer>())
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000563 : resource_name_(resource_name),
564 resource_line_offset_(resource_line_offset),
565 resource_column_offset_(resource_column_offset) { }
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000566 inline Handle<Value> ResourceName() const;
567 inline Handle<Integer> ResourceLineOffset() const;
568 inline Handle<Integer> ResourceColumnOffset() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000569 private:
mads.s.agercbaa0602008-08-14 13:41:48 +0000570 Handle<Value> resource_name_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000571 Handle<Integer> resource_line_offset_;
572 Handle<Integer> resource_column_offset_;
573};
574
575
576/**
v8.team.kasperl727e9952008-09-02 14:56:44 +0000577 * A compiled JavaScript script.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000578 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000579class V8EXPORT Script {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000580 public:
581
582 /**
ager@chromium.org5c838252010-02-19 08:53:10 +0000583 * Compiles the specified script (context-independent).
sgjesse@chromium.org911335c2009-08-19 12:59:44 +0000584 *
ager@chromium.org5c838252010-02-19 08:53:10 +0000585 * \param source Script source code.
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000586 * \param origin Script origin, owned by caller, no references are kept
ager@chromium.org5c838252010-02-19 08:53:10 +0000587 * when New() returns
588 * \param pre_data Pre-parsing data, as obtained by ScriptData::PreCompile()
589 * using pre_data speeds compilation if it's done multiple times.
590 * Owned by caller, no references are kept when New() returns.
591 * \param script_data Arbitrary data associated with script. Using
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000592 * this has same effect as calling SetData(), but allows data to be
ager@chromium.org5c838252010-02-19 08:53:10 +0000593 * available to compile event handlers.
594 * \return Compiled script object (context independent; when run it
595 * will use the currently entered context).
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000596 */
ager@chromium.org5c838252010-02-19 08:53:10 +0000597 static Local<Script> New(Handle<String> source,
598 ScriptOrigin* origin = NULL,
599 ScriptData* pre_data = NULL,
600 Handle<String> script_data = Handle<String>());
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000601
mads.s.agercbaa0602008-08-14 13:41:48 +0000602 /**
603 * Compiles the specified script using the specified file name
604 * object (typically a string) as the script's origin.
sgjesse@chromium.org911335c2009-08-19 12:59:44 +0000605 *
ager@chromium.org5c838252010-02-19 08:53:10 +0000606 * \param source Script source code.
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000607 * \param file_name file name object (typically a string) to be used
ager@chromium.org5c838252010-02-19 08:53:10 +0000608 * as the script's origin.
609 * \return Compiled script object (context independent; when run it
610 * will use the currently entered context).
611 */
612 static Local<Script> New(Handle<String> source,
613 Handle<Value> file_name);
614
615 /**
616 * Compiles the specified script (bound to current context).
617 *
618 * \param source Script source code.
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000619 * \param origin Script origin, owned by caller, no references are kept
ager@chromium.org5c838252010-02-19 08:53:10 +0000620 * when Compile() returns
621 * \param pre_data Pre-parsing data, as obtained by ScriptData::PreCompile()
622 * using pre_data speeds compilation if it's done multiple times.
623 * Owned by caller, no references are kept when Compile() returns.
624 * \param script_data Arbitrary data associated with script. Using
625 * this has same effect as calling SetData(), but makes data available
626 * earlier (i.e. to compile event handlers).
627 * \return Compiled script object, bound to the context that was active
628 * when this function was called. When run it will always use this
629 * context.
mads.s.agercbaa0602008-08-14 13:41:48 +0000630 */
631 static Local<Script> Compile(Handle<String> source,
ager@chromium.org5c838252010-02-19 08:53:10 +0000632 ScriptOrigin* origin = NULL,
633 ScriptData* pre_data = NULL,
634 Handle<String> script_data = Handle<String>());
635
636 /**
637 * Compiles the specified script using the specified file name
638 * object (typically a string) as the script's origin.
639 *
640 * \param source Script source code.
641 * \param file_name File name to use as script's origin
642 * \param script_data Arbitrary data associated with script. Using
643 * this has same effect as calling SetData(), but makes data available
644 * earlier (i.e. to compile event handlers).
645 * \return Compiled script object, bound to the context that was active
646 * when this function was called. When run it will always use this
647 * context.
648 */
649 static Local<Script> Compile(Handle<String> source,
650 Handle<Value> file_name,
651 Handle<String> script_data = Handle<String>());
mads.s.agercbaa0602008-08-14 13:41:48 +0000652
v8.team.kasperl727e9952008-09-02 14:56:44 +0000653 /**
sgjesse@chromium.org911335c2009-08-19 12:59:44 +0000654 * Runs the script returning the resulting value. If the script is
655 * context independent (created using ::New) it will be run in the
656 * currently entered context. If it is context specific (created
657 * using ::Compile) it will be run in the context in which it was
658 * compiled.
v8.team.kasperl727e9952008-09-02 14:56:44 +0000659 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000660 Local<Value> Run();
kasperl@chromium.org7be3c992009-03-12 07:19:55 +0000661
662 /**
663 * Returns the script id value.
664 */
665 Local<Value> Id();
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000666
667 /**
668 * Associate an additional data object with the script. This is mainly used
669 * with the debugger as this data object is only available through the
670 * debugger API.
671 */
sgjesse@chromium.org499aaa52009-11-30 08:07:20 +0000672 void SetData(Handle<String> data);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000673};
674
675
676/**
677 * An error message.
678 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +0000679class V8EXPORT Message {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000680 public:
ager@chromium.org32912102009-01-16 10:38:43 +0000681 Local<String> Get() const;
682 Local<String> GetSourceLine() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000683
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000684 /**
685 * Returns the resource name for the script from where the function causing
686 * the error originates.
687 */
ager@chromium.org32912102009-01-16 10:38:43 +0000688 Handle<Value> GetScriptResourceName() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000689
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000690 /**
ager@chromium.org65dad4b2009-04-23 08:48:43 +0000691 * Returns the resource data for the script from where the function causing
692 * the error originates.
693 */
694 Handle<Value> GetScriptData() const;
695
696 /**
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000697 * Returns the number, 1-based, of the line where the error occurred.
698 */
ager@chromium.org32912102009-01-16 10:38:43 +0000699 int GetLineNumber() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000700
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000701 /**
702 * Returns the index within the script of the first character where
703 * the error occurred.
704 */
ager@chromium.org32912102009-01-16 10:38:43 +0000705 int GetStartPosition() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000706
707 /**
708 * Returns the index within the script of the last character where
709 * the error occurred.
710 */
ager@chromium.org32912102009-01-16 10:38:43 +0000711 int GetEndPosition() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000712
713 /**
714 * Returns the index within the line of the first character where
715 * the error occurred.
716 */
ager@chromium.org32912102009-01-16 10:38:43 +0000717 int GetStartColumn() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000718
719 /**
720 * Returns the index within the line of the last character where
721 * the error occurred.
722 */
ager@chromium.org32912102009-01-16 10:38:43 +0000723 int GetEndColumn() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000724
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000725 // TODO(1245381): Print to a string instead of on a FILE.
726 static void PrintCurrentStackTrace(FILE* out);
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +0000727
728 static const int kNoLineNumberInfo = 0;
729 static const int kNoColumnInfo = 0;
730};
731
732
733/**
734 * Representation of a JavaScript stack trace. The information collected is a
735 * snapshot of the execution stack and the information remains valid after
736 * execution continues.
737 */
738class V8EXPORT StackTrace {
739 public:
740 /**
741 * Flags that determine what information is placed captured for each
742 * StackFrame when grabbing the current stack trace.
743 */
744 enum StackTraceOptions {
745 kLineNumber = 1,
746 kColumnOffset = 1 << 1 | kLineNumber,
747 kScriptName = 1 << 2,
748 kFunctionName = 1 << 3,
749 kIsEval = 1 << 4,
750 kIsConstructor = 1 << 5,
751 kOverview = kLineNumber | kColumnOffset | kScriptName | kFunctionName,
752 kDetailed = kOverview | kIsEval | kIsConstructor
753 };
754
755 /**
756 * Returns a StackFrame at a particular index.
757 */
758 Local<StackFrame> GetFrame(uint32_t index) const;
759
760 /**
761 * Returns the number of StackFrames.
762 */
763 int GetFrameCount() const;
764
765 /**
766 * Returns StackTrace as a v8::Array that contains StackFrame objects.
767 */
768 Local<Array> AsArray();
769
770 /**
771 * Grab a snapshot of the the current JavaScript execution stack.
772 *
773 * \param frame_limit The maximum number of stack frames we want to capture.
774 * \param options Enumerates the set of things we will capture for each
775 * StackFrame.
776 */
777 static Local<StackTrace> CurrentStackTrace(
778 int frame_limit,
779 StackTraceOptions options = kOverview);
780};
781
782
783/**
784 * A single JavaScript stack frame.
785 */
786class V8EXPORT StackFrame {
787 public:
788 /**
789 * Returns the number, 1-based, of the line for the associate function call.
790 * This method will return Message::kNoLineNumberInfo if it is unable to
791 * retrieve the line number, or if kLineNumber was not passed as an option
792 * when capturing the StackTrace.
793 */
794 int GetLineNumber() const;
795
796 /**
797 * Returns the 1-based column offset on the line for the associated function
798 * call.
799 * This method will return Message::kNoColumnInfo if it is unable to retrieve
800 * the column number, or if kColumnOffset was not passed as an option when
801 * capturing the StackTrace.
802 */
803 int GetColumn() const;
804
805 /**
806 * Returns the name of the resource that contains the script for the
807 * function for this StackFrame.
808 */
809 Local<String> GetScriptName() const;
810
811 /**
812 * Returns the name of the function associated with this stack frame.
813 */
814 Local<String> GetFunctionName() const;
815
816 /**
817 * Returns whether or not the associated function is compiled via a call to
818 * eval().
819 */
820 bool IsEval() const;
821
822 /**
823 * Returns whther or not the associated function is called as a
824 * constructor via "new".
825 */
826 bool IsConstructor() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000827};
828
829
830// --- V a l u e ---
831
832
833/**
v8.team.kasperl727e9952008-09-02 14:56:44 +0000834 * The superclass of all JavaScript values and objects.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000835 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000836class Value : public Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000837 public:
838
839 /**
840 * Returns true if this value is the undefined value. See ECMA-262
841 * 4.3.10.
842 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000843 V8EXPORT bool IsUndefined() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000844
845 /**
846 * Returns true if this value is the null value. See ECMA-262
847 * 4.3.11.
848 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000849 V8EXPORT bool IsNull() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000850
851 /**
852 * Returns true if this value is true.
853 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000854 V8EXPORT bool IsTrue() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000855
856 /**
857 * Returns true if this value is false.
858 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000859 V8EXPORT bool IsFalse() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000860
861 /**
862 * Returns true if this value is an instance of the String type.
863 * See ECMA-262 8.4.
864 */
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000865 inline bool IsString() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000866
867 /**
868 * Returns true if this value is a function.
869 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000870 V8EXPORT bool IsFunction() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000871
872 /**
873 * Returns true if this value is an array.
874 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000875 V8EXPORT bool IsArray() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000876
v8.team.kasperl727e9952008-09-02 14:56:44 +0000877 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000878 * Returns true if this value is an object.
879 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000880 V8EXPORT bool IsObject() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000881
v8.team.kasperl727e9952008-09-02 14:56:44 +0000882 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000883 * Returns true if this value is boolean.
884 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000885 V8EXPORT bool IsBoolean() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000886
v8.team.kasperl727e9952008-09-02 14:56:44 +0000887 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000888 * Returns true if this value is a number.
889 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000890 V8EXPORT bool IsNumber() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000891
v8.team.kasperl727e9952008-09-02 14:56:44 +0000892 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000893 * Returns true if this value is external.
894 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000895 V8EXPORT bool IsExternal() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000896
v8.team.kasperl727e9952008-09-02 14:56:44 +0000897 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000898 * Returns true if this value is a 32-bit signed integer.
899 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000900 V8EXPORT bool IsInt32() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000901
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000902 /**
lrn@chromium.orgc34f5802010-04-28 12:53:43 +0000903 * Returns true if this value is a 32-bit unsigned integer.
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000904 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000905 V8EXPORT bool IsUint32() const;
ager@chromium.orgce5e87b2010-03-10 10:24:18 +0000906
907 /**
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000908 * Returns true if this value is a Date.
909 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000910 V8EXPORT bool IsDate() const;
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +0000911
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000912 V8EXPORT Local<Boolean> ToBoolean() const;
913 V8EXPORT Local<Number> ToNumber() const;
914 V8EXPORT Local<String> ToString() const;
915 V8EXPORT Local<String> ToDetailString() const;
916 V8EXPORT Local<Object> ToObject() const;
917 V8EXPORT Local<Integer> ToInteger() const;
918 V8EXPORT Local<Uint32> ToUint32() const;
919 V8EXPORT Local<Int32> ToInt32() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000920
921 /**
922 * Attempts to convert a string to an array index.
923 * Returns an empty handle if the conversion fails.
924 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000925 V8EXPORT Local<Uint32> ToArrayIndex() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000926
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000927 V8EXPORT bool BooleanValue() const;
928 V8EXPORT double NumberValue() const;
929 V8EXPORT int64_t IntegerValue() const;
930 V8EXPORT uint32_t Uint32Value() const;
931 V8EXPORT int32_t Int32Value() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000932
933 /** JS == */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000934 V8EXPORT bool Equals(Handle<Value> that) const;
935 V8EXPORT bool StrictEquals(Handle<Value> that) const;
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +0000936
ager@chromium.org18ad94b2009-09-02 08:22:29 +0000937 private:
938 inline bool QuickIsString() const;
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000939 V8EXPORT bool FullIsString() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000940};
941
942
943/**
944 * The superclass of primitive values. See ECMA-262 4.3.2.
945 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000946class Primitive : public Value { };
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000947
948
949/**
950 * A primitive boolean value (ECMA-262, 4.3.14). Either the true
951 * or false value.
952 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000953class Boolean : public Primitive {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000954 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000955 V8EXPORT bool Value() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000956 static inline Handle<Boolean> New(bool value);
957};
958
959
960/**
v8.team.kasperl727e9952008-09-02 14:56:44 +0000961 * A JavaScript string value (ECMA-262, 4.3.17).
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000962 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000963class String : public Primitive {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000964 public:
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000965
966 /**
967 * Returns the number of characters in this string.
968 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000969 V8EXPORT int Length() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +0000970
v8.team.kasperl727e9952008-09-02 14:56:44 +0000971 /**
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000972 * Returns the number of bytes in the UTF-8 encoded
973 * representation of this string.
974 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +0000975 V8EXPORT int Utf8Length() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +0000976
977 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +0000978 * Write the contents of the string to an external buffer.
979 * If no arguments are given, expects the buffer to be large
980 * enough to hold the entire string and NULL terminator. Copies
981 * the contents of the string and the NULL terminator into the
982 * buffer.
983 *
984 * Copies up to length characters into the output buffer.
985 * Only null-terminates if there is enough space in the buffer.
986 *
987 * \param buffer The buffer into which the string will be copied.
988 * \param start The starting position within the string at which
989 * copying begins.
990 * \param length The number of bytes to copy from the string.
ager@chromium.org357bf652010-04-12 11:30:10 +0000991 * \param nchars_ref The number of characters written, can be NULL.
ricow@chromium.orgc9c80822010-04-21 08:22:37 +0000992 * \param hints Various hints that might affect performance of this or
993 * subsequent operations.
ager@chromium.org357bf652010-04-12 11:30:10 +0000994 * \return The number of bytes copied to the buffer
v8.team.kasperl727e9952008-09-02 14:56:44 +0000995 * excluding the NULL terminator.
996 */
whesse@chromium.orgb6e43bb2010-04-14 09:36:28 +0000997 enum WriteHints {
998 NO_HINTS = 0,
999 HINT_MANY_WRITES_EXPECTED = 1
1000 };
1001
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001002 V8EXPORT int Write(uint16_t* buffer,
1003 int start = 0,
1004 int length = -1,
1005 WriteHints hints = NO_HINTS) const; // UTF-16
1006 V8EXPORT int WriteAscii(char* buffer,
1007 int start = 0,
1008 int length = -1,
1009 WriteHints hints = NO_HINTS) const; // ASCII
1010 V8EXPORT int WriteUtf8(char* buffer,
1011 int length = -1,
1012 int* nchars_ref = NULL,
1013 WriteHints hints = NO_HINTS) const; // UTF-8
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001014
v8.team.kasperl727e9952008-09-02 14:56:44 +00001015 /**
ager@chromium.org563b8dc2009-03-20 14:23:52 +00001016 * A zero length string.
1017 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001018 V8EXPORT static v8::Local<v8::String> Empty();
ager@chromium.org563b8dc2009-03-20 14:23:52 +00001019
1020 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001021 * Returns true if the string is external
1022 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001023 V8EXPORT bool IsExternal() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001024
v8.team.kasperl727e9952008-09-02 14:56:44 +00001025 /**
1026 * Returns true if the string is both external and ascii
1027 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001028 V8EXPORT bool IsExternalAscii() const;
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001029
1030 class V8EXPORT ExternalStringResourceBase {
1031 public:
1032 virtual ~ExternalStringResourceBase() {}
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001033
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001034 protected:
1035 ExternalStringResourceBase() {}
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001036
1037 /**
1038 * Internally V8 will call this Dispose method when the external string
1039 * resource is no longer needed. The default implementation will use the
1040 * delete operator. This method can be overridden in subclasses to
1041 * control how allocated external string resources are disposed.
1042 */
1043 virtual void Dispose() { delete this; }
1044
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001045 private:
1046 // Disallow copying and assigning.
1047 ExternalStringResourceBase(const ExternalStringResourceBase&);
1048 void operator=(const ExternalStringResourceBase&);
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001049
1050 friend class v8::internal::Heap;
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001051 };
1052
v8.team.kasperl727e9952008-09-02 14:56:44 +00001053 /**
1054 * An ExternalStringResource is a wrapper around a two-byte string
1055 * buffer that resides outside V8's heap. Implement an
1056 * ExternalStringResource to manage the life cycle of the underlying
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001057 * buffer. Note that the string data must be immutable.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001058 */
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001059 class V8EXPORT ExternalStringResource
1060 : public ExternalStringResourceBase {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001061 public:
1062 /**
1063 * Override the destructor to manage the life cycle of the underlying
1064 * buffer.
1065 */
1066 virtual ~ExternalStringResource() {}
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001067
1068 /**
1069 * The string data from the underlying buffer.
1070 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001071 virtual const uint16_t* data() const = 0;
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001072
1073 /**
1074 * The length of the string. That is, the number of two-byte characters.
1075 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001076 virtual size_t length() const = 0;
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001077
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001078 protected:
1079 ExternalStringResource() {}
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001080 };
1081
1082 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001083 * An ExternalAsciiStringResource is a wrapper around an ascii
1084 * string buffer that resides outside V8's heap. Implement an
1085 * ExternalAsciiStringResource to manage the life cycle of the
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001086 * underlying buffer. Note that the string data must be immutable
1087 * and that the data must be strict 7-bit ASCII, not Latin1 or
1088 * UTF-8, which would require special treatment internally in the
1089 * engine and, in the case of UTF-8, do not allow efficient indexing.
1090 * Use String::New or convert to 16 bit data for non-ASCII.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001091 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001092
kmillikin@chromium.org13bd2942009-12-16 15:36:05 +00001093 class V8EXPORT ExternalAsciiStringResource
1094 : public ExternalStringResourceBase {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001095 public:
1096 /**
1097 * Override the destructor to manage the life cycle of the underlying
1098 * buffer.
1099 */
1100 virtual ~ExternalAsciiStringResource() {}
1101 /** The string data from the underlying buffer.*/
1102 virtual const char* data() const = 0;
1103 /** The number of ascii characters in the string.*/
1104 virtual size_t length() const = 0;
1105 protected:
1106 ExternalAsciiStringResource() {}
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001107 };
1108
1109 /**
ager@chromium.org9085a012009-05-11 19:22:57 +00001110 * Get the ExternalStringResource for an external string. Returns
1111 * NULL if IsExternal() doesn't return true.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001112 */
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001113 inline ExternalStringResource* GetExternalStringResource() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001114
1115 /**
1116 * Get the ExternalAsciiStringResource for an external ascii string.
ager@chromium.org9085a012009-05-11 19:22:57 +00001117 * Returns NULL if IsExternalAscii() doesn't return true.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001118 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001119 V8EXPORT ExternalAsciiStringResource* GetExternalAsciiStringResource() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001120
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001121 static inline String* Cast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001122
1123 /**
1124 * Allocates a new string from either utf-8 encoded or ascii data.
1125 * The second parameter 'length' gives the buffer length.
1126 * If the data is utf-8 encoded, the caller must
1127 * be careful to supply the length parameter.
1128 * If it is not given, the function calls
1129 * 'strlen' to determine the buffer length, it might be
kasper.lund7276f142008-07-30 08:49:36 +00001130 * wrong if 'data' contains a null character.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001131 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001132 V8EXPORT static Local<String> New(const char* data, int length = -1);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001133
1134 /** Allocates a new string from utf16 data.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001135 V8EXPORT static Local<String> New(const uint16_t* data, int length = -1);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001136
1137 /** Creates a symbol. Returns one if it exists already.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001138 V8EXPORT static Local<String> NewSymbol(const char* data, int length = -1);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001139
v8.team.kasperl727e9952008-09-02 14:56:44 +00001140 /**
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001141 * Creates a new string by concatenating the left and the right strings
1142 * passed in as parameters.
1143 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001144 V8EXPORT static Local<String> Concat(Handle<String> left,
1145 Handle<String>right);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001146
1147 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001148 * Creates a new external string using the data defined in the given
lrn@chromium.org1af7e1b2010-06-07 11:12:01 +00001149 * resource. When the external string is no longer live on V8's heap the
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001150 * resource will be disposed by calling its Dispose method. The caller of
1151 * this function should not otherwise delete or modify the resource. Neither
1152 * should the underlying buffer be deallocated or modified except through the
1153 * destructor of the external string resource.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001154 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001155 V8EXPORT static Local<String> NewExternal(ExternalStringResource* resource);
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001156
ager@chromium.org6f10e412009-02-13 10:11:16 +00001157 /**
1158 * Associate an external string resource with this string by transforming it
1159 * in place so that existing references to this string in the JavaScript heap
1160 * will use the external string resource. The external string resource's
1161 * character contents needs to be equivalent to this string.
1162 * Returns true if the string has been changed to be an external string.
lrn@chromium.org1af7e1b2010-06-07 11:12:01 +00001163 * The string is not modified if the operation fails. See NewExternal for
1164 * information on the lifetime of the resource.
ager@chromium.org6f10e412009-02-13 10:11:16 +00001165 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001166 V8EXPORT bool MakeExternal(ExternalStringResource* resource);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001167
v8.team.kasperl727e9952008-09-02 14:56:44 +00001168 /**
1169 * Creates a new external string using the ascii data defined in the given
lrn@chromium.org1af7e1b2010-06-07 11:12:01 +00001170 * resource. When the external string is no longer live on V8's heap the
vegorov@chromium.org2356e6f2010-06-09 09:38:56 +00001171 * resource will be disposed by calling its Dispose method. The caller of
1172 * this function should not otherwise delete or modify the resource. Neither
1173 * should the underlying buffer be deallocated or modified except through the
1174 * destructor of the external string resource.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001175 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001176 V8EXPORT static Local<String> NewExternal(
1177 ExternalAsciiStringResource* resource);
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001178
ager@chromium.org6f10e412009-02-13 10:11:16 +00001179 /**
1180 * Associate an external string resource with this string by transforming it
1181 * in place so that existing references to this string in the JavaScript heap
1182 * will use the external string resource. The external string resource's
1183 * character contents needs to be equivalent to this string.
1184 * Returns true if the string has been changed to be an external string.
lrn@chromium.org1af7e1b2010-06-07 11:12:01 +00001185 * The string is not modified if the operation fails. See NewExternal for
1186 * information on the lifetime of the resource.
ager@chromium.org6f10e412009-02-13 10:11:16 +00001187 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001188 V8EXPORT bool MakeExternal(ExternalAsciiStringResource* resource);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001189
christian.plesner.hansen@gmail.com5a6af922009-08-12 14:20:51 +00001190 /**
1191 * Returns true if this string can be made external.
1192 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001193 V8EXPORT bool CanMakeExternal();
christian.plesner.hansen@gmail.com5a6af922009-08-12 14:20:51 +00001194
kasper.lund7276f142008-07-30 08:49:36 +00001195 /** Creates an undetectable string from the supplied ascii or utf-8 data.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001196 V8EXPORT static Local<String> NewUndetectable(const char* data,
1197 int length = -1);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001198
kasper.lund7276f142008-07-30 08:49:36 +00001199 /** Creates an undetectable string from the supplied utf-16 data.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001200 V8EXPORT static Local<String> NewUndetectable(const uint16_t* data,
1201 int length = -1);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001202
1203 /**
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001204 * Converts an object to a utf8-encoded character array. Useful if
ager@chromium.org71daaf62009-04-01 07:22:49 +00001205 * you want to print the object. If conversion to a string fails
1206 * (eg. due to an exception in the toString() method of the object)
1207 * then the length() method returns 0 and the * operator returns
1208 * NULL.
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001209 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001210 class V8EXPORT Utf8Value {
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001211 public:
1212 explicit Utf8Value(Handle<v8::Value> obj);
1213 ~Utf8Value();
ager@chromium.orga1645e22009-09-09 19:27:10 +00001214 char* operator*() { return str_; }
1215 const char* operator*() const { return str_; }
1216 int length() const { return length_; }
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001217 private:
1218 char* str_;
1219 int length_;
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00001220
1221 // Disallow copying and assigning.
1222 Utf8Value(const Utf8Value&);
1223 void operator=(const Utf8Value&);
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001224 };
1225
1226 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001227 * Converts an object to an ascii string.
1228 * Useful if you want to print the object.
ager@chromium.org71daaf62009-04-01 07:22:49 +00001229 * If conversion to a string fails (eg. due to an exception in the toString()
1230 * method of the object) then the length() method returns 0 and the * operator
1231 * returns NULL.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001232 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001233 class V8EXPORT AsciiValue {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001234 public:
1235 explicit AsciiValue(Handle<v8::Value> obj);
1236 ~AsciiValue();
ager@chromium.orga1645e22009-09-09 19:27:10 +00001237 char* operator*() { return str_; }
1238 const char* operator*() const { return str_; }
1239 int length() const { return length_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001240 private:
1241 char* str_;
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001242 int length_;
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00001243
1244 // Disallow copying and assigning.
1245 AsciiValue(const AsciiValue&);
1246 void operator=(const AsciiValue&);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001247 };
1248
1249 /**
1250 * Converts an object to a two-byte string.
ager@chromium.org71daaf62009-04-01 07:22:49 +00001251 * If conversion to a string fails (eg. due to an exception in the toString()
1252 * method of the object) then the length() method returns 0 and the * operator
1253 * returns NULL.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001254 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001255 class V8EXPORT Value {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001256 public:
1257 explicit Value(Handle<v8::Value> obj);
1258 ~Value();
ager@chromium.orga1645e22009-09-09 19:27:10 +00001259 uint16_t* operator*() { return str_; }
1260 const uint16_t* operator*() const { return str_; }
1261 int length() const { return length_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001262 private:
1263 uint16_t* str_;
ager@chromium.org9258b6b2008-09-11 09:11:10 +00001264 int length_;
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00001265
1266 // Disallow copying and assigning.
1267 Value(const Value&);
1268 void operator=(const Value&);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001269 };
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001270
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001271 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001272 V8EXPORT void VerifyExternalStringResource(ExternalStringResource* val) const;
1273 V8EXPORT static void CheckCast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001274};
1275
1276
1277/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001278 * A JavaScript number value (ECMA-262, 4.3.20)
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001279 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001280class Number : public Primitive {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001281 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001282 V8EXPORT double Value() const;
1283 V8EXPORT static Local<Number> New(double value);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001284 static inline Number* Cast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001285 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001286 V8EXPORT Number();
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001287 static void CheckCast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001288};
1289
1290
1291/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001292 * A JavaScript value representing a signed integer.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001293 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001294class Integer : public Number {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001295 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001296 V8EXPORT static Local<Integer> New(int32_t value);
1297 V8EXPORT static Local<Integer> NewFromUnsigned(uint32_t value);
1298 V8EXPORT int64_t Value() const;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001299 static inline Integer* Cast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001300 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001301 V8EXPORT Integer();
1302 V8EXPORT static void CheckCast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001303};
1304
1305
1306/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001307 * A JavaScript value representing a 32-bit signed integer.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001308 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001309class Int32 : public Integer {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001310 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001311 V8EXPORT int32_t Value() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001312 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001313 V8EXPORT Int32();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001314};
1315
1316
1317/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001318 * A JavaScript value representing a 32-bit unsigned integer.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001319 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001320class Uint32 : public Integer {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001321 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001322 V8EXPORT uint32_t Value() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001323 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001324 V8EXPORT Uint32();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001325};
1326
1327
1328/**
1329 * An instance of the built-in Date constructor (ECMA-262, 15.9).
1330 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001331class Date : public Value {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001332 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001333 V8EXPORT static Local<Value> New(double time);
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00001334
1335 /**
1336 * A specialization of Value::NumberValue that is more efficient
1337 * because we know the structure of this object.
1338 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001339 V8EXPORT double NumberValue() const;
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00001340
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001341 static inline Date* Cast(v8::Value* obj);
1342 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001343 V8EXPORT static void CheckCast(v8::Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001344};
1345
1346
1347enum PropertyAttribute {
1348 None = 0,
1349 ReadOnly = 1 << 0,
1350 DontEnum = 1 << 1,
1351 DontDelete = 1 << 2
1352};
1353
ager@chromium.org3811b432009-10-28 14:53:37 +00001354enum ExternalArrayType {
1355 kExternalByteArray = 1,
1356 kExternalUnsignedByteArray,
1357 kExternalShortArray,
1358 kExternalUnsignedShortArray,
1359 kExternalIntArray,
1360 kExternalUnsignedIntArray,
1361 kExternalFloatArray
1362};
1363
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001364/**
kmillikin@chromium.org9155e252010-05-26 13:27:57 +00001365 * Accessor[Getter|Setter] are used as callback functions when
1366 * setting|getting a particular property. See Object and ObjectTemplate's
1367 * method SetAccessor.
1368 */
1369typedef Handle<Value> (*AccessorGetter)(Local<String> property,
1370 const AccessorInfo& info);
1371
1372
1373typedef void (*AccessorSetter)(Local<String> property,
1374 Local<Value> value,
1375 const AccessorInfo& info);
1376
1377
1378/**
1379 * Access control specifications.
1380 *
1381 * Some accessors should be accessible across contexts. These
1382 * accessors have an explicit access control parameter which specifies
1383 * the kind of cross-context access that should be allowed.
1384 *
1385 * Additionally, for security, accessors can prohibit overwriting by
1386 * accessors defined in JavaScript. For objects that have such
1387 * accessors either locally or in their prototype chain it is not
1388 * possible to overwrite the accessor by using __defineGetter__ or
1389 * __defineSetter__ from JavaScript code.
1390 */
1391enum AccessControl {
1392 DEFAULT = 0,
1393 ALL_CAN_READ = 1,
1394 ALL_CAN_WRITE = 1 << 1,
1395 PROHIBITS_OVERWRITING = 1 << 2
1396};
1397
1398
1399/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001400 * A JavaScript object (ECMA-262, 4.3.3)
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001401 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001402class Object : public Value {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001403 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001404 V8EXPORT bool Set(Handle<Value> key,
1405 Handle<Value> value,
1406 PropertyAttribute attribs = None);
ager@chromium.org65dad4b2009-04-23 08:48:43 +00001407
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001408 V8EXPORT bool Set(uint32_t index,
1409 Handle<Value> value);
ager@chromium.orgce5e87b2010-03-10 10:24:18 +00001410
ager@chromium.orge2902be2009-06-08 12:21:35 +00001411 // Sets a local property on this object bypassing interceptors and
ager@chromium.org65dad4b2009-04-23 08:48:43 +00001412 // overriding accessors or read-only properties.
1413 //
1414 // Note that if the object has an interceptor the property will be set
1415 // locally, but since the interceptor takes precedence the local property
1416 // will only be returned if the interceptor doesn't return a value.
1417 //
1418 // Note also that this only works for named properties.
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001419 V8EXPORT bool ForceSet(Handle<Value> key,
1420 Handle<Value> value,
1421 PropertyAttribute attribs = None);
ager@chromium.orge2902be2009-06-08 12:21:35 +00001422
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001423 V8EXPORT Local<Value> Get(Handle<Value> key);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001424
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001425 V8EXPORT Local<Value> Get(uint32_t index);
ager@chromium.orgce5e87b2010-03-10 10:24:18 +00001426
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001427 // TODO(1245389): Replace the type-specific versions of these
1428 // functions with generic ones that accept a Handle<Value> key.
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001429 V8EXPORT bool Has(Handle<String> key);
ager@chromium.orge2902be2009-06-08 12:21:35 +00001430
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001431 V8EXPORT bool Delete(Handle<String> key);
ager@chromium.orge2902be2009-06-08 12:21:35 +00001432
1433 // Delete a property on this object bypassing interceptors and
1434 // ignoring dont-delete attributes.
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001435 V8EXPORT bool ForceDelete(Handle<Value> key);
ager@chromium.orge2902be2009-06-08 12:21:35 +00001436
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001437 V8EXPORT bool Has(uint32_t index);
ager@chromium.orge2902be2009-06-08 12:21:35 +00001438
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001439 V8EXPORT bool Delete(uint32_t index);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001440
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001441 V8EXPORT bool SetAccessor(Handle<String> name,
1442 AccessorGetter getter,
1443 AccessorSetter setter = 0,
1444 Handle<Value> data = Handle<Value>(),
1445 AccessControl settings = DEFAULT,
1446 PropertyAttribute attribute = None);
kmillikin@chromium.org9155e252010-05-26 13:27:57 +00001447
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001448 /**
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00001449 * Returns an array containing the names of the enumerable properties
1450 * of this object, including properties from prototype objects. The
1451 * array returned by this method contains the same values as would
1452 * be enumerated by a for-in statement over this object.
1453 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001454 V8EXPORT Local<Array> GetPropertyNames();
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00001455
1456 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001457 * Get the prototype object. This does not skip objects marked to
1458 * be skipped by __proto__ and it does not consult the security
1459 * handler.
1460 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001461 V8EXPORT Local<Value> GetPrototype();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001462
1463 /**
ager@chromium.org5c838252010-02-19 08:53:10 +00001464 * Set the prototype object. This does not skip objects marked to
1465 * be skipped by __proto__ and it does not consult the security
1466 * handler.
1467 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001468 V8EXPORT bool SetPrototype(Handle<Value> prototype);
ager@chromium.org5c838252010-02-19 08:53:10 +00001469
1470 /**
sgjesse@chromium.org900d3b72009-08-07 11:24:25 +00001471 * Finds an instance of the given function template in the prototype
1472 * chain.
1473 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001474 V8EXPORT Local<Object> FindInstanceInPrototypeChain(
1475 Handle<FunctionTemplate> tmpl);
sgjesse@chromium.org900d3b72009-08-07 11:24:25 +00001476
1477 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001478 * Call builtin Object.prototype.toString on this object.
1479 * This is different from Value::ToString() that may call
1480 * user-defined toString function. This one does not.
1481 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001482 V8EXPORT Local<String> ObjectProtoToString();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001483
kasper.lund212ac232008-07-16 07:07:30 +00001484 /** Gets the number of internal fields for this Object. */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001485 V8EXPORT int InternalFieldCount();
kasper.lund212ac232008-07-16 07:07:30 +00001486 /** Gets the value in an internal field. */
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001487 inline Local<Value> GetInternalField(int index);
kasper.lund212ac232008-07-16 07:07:30 +00001488 /** Sets the value in an internal field. */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001489 V8EXPORT void SetInternalField(int index, Handle<Value> value);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001490
kasperl@chromium.orge959c182009-07-27 08:59:04 +00001491 /** Gets a native pointer from an internal field. */
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001492 inline void* GetPointerFromInternalField(int index);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001493
kasperl@chromium.orge959c182009-07-27 08:59:04 +00001494 /** Sets a native pointer in an internal field. */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001495 V8EXPORT void SetPointerInInternalField(int index, void* value);
kasperl@chromium.orge959c182009-07-27 08:59:04 +00001496
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001497 // Testers for local properties.
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001498 V8EXPORT bool HasRealNamedProperty(Handle<String> key);
1499 V8EXPORT bool HasRealIndexedProperty(uint32_t index);
1500 V8EXPORT bool HasRealNamedCallbackProperty(Handle<String> key);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001501
1502 /**
1503 * If result.IsEmpty() no real property was located in the prototype chain.
1504 * This means interceptors in the prototype chain are not called.
1505 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001506 V8EXPORT Local<Value> GetRealNamedPropertyInPrototypeChain(
1507 Handle<String> key);
sgjesse@chromium.org98aff2f2009-09-30 08:27:10 +00001508
1509 /**
1510 * If result.IsEmpty() no real property was located on the object or
1511 * in the prototype chain.
1512 * This means interceptors in the prototype chain are not called.
1513 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001514 V8EXPORT Local<Value> GetRealNamedProperty(Handle<String> key);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001515
1516 /** Tests for a named lookup interceptor.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001517 V8EXPORT bool HasNamedLookupInterceptor();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001518
kasper.lund212ac232008-07-16 07:07:30 +00001519 /** Tests for an index lookup interceptor.*/
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001520 V8EXPORT bool HasIndexedLookupInterceptor();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001521
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00001522 /**
1523 * Turns on access check on the object if the object is an instance of
1524 * a template that has access check callbacks. If an object has no
1525 * access check info, the object cannot be accessed by anyone.
1526 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001527 V8EXPORT void TurnOnAccessCheck();
ager@chromium.org41826e72009-03-30 13:30:57 +00001528
ager@chromium.org3b45ab52009-03-19 22:21:34 +00001529 /**
1530 * Returns the identity hash for this object. The current implemenation uses
ager@chromium.org9085a012009-05-11 19:22:57 +00001531 * a hidden property on the object to store the identity hash.
ager@chromium.org5ec48922009-05-05 07:25:34 +00001532 *
ager@chromium.org9085a012009-05-11 19:22:57 +00001533 * The return value will never be 0. Also, it is not guaranteed to be
ager@chromium.org5ec48922009-05-05 07:25:34 +00001534 * unique.
ager@chromium.org3b45ab52009-03-19 22:21:34 +00001535 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001536 V8EXPORT int GetIdentityHash();
ager@chromium.org41826e72009-03-30 13:30:57 +00001537
ager@chromium.org3b45ab52009-03-19 22:21:34 +00001538 /**
1539 * Access hidden properties on JavaScript objects. These properties are
1540 * hidden from the executing JavaScript and only accessible through the V8
1541 * C++ API. Hidden properties introduced by V8 internally (for example the
1542 * identity hash) are prefixed with "v8::".
1543 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001544 V8EXPORT bool SetHiddenValue(Handle<String> key, Handle<Value> value);
1545 V8EXPORT Local<Value> GetHiddenValue(Handle<String> key);
1546 V8EXPORT bool DeleteHiddenValue(Handle<String> key);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001547
christian.plesner.hansen@gmail.com2bc58ef2009-09-22 10:00:30 +00001548 /**
1549 * Returns true if this is an instance of an api function (one
1550 * created from a function created from a function template) and has
1551 * been modified since it was created. Note that this method is
1552 * conservative and may return true for objects that haven't actually
1553 * been modified.
1554 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001555 V8EXPORT bool IsDirty();
ager@chromium.org3b45ab52009-03-19 22:21:34 +00001556
1557 /**
1558 * Clone this object with a fast but shallow copy. Values will point
1559 * to the same values as the original object.
1560 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001561 V8EXPORT Local<Object> Clone();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001562
sgjesse@chromium.org0b6db592009-07-30 14:48:31 +00001563 /**
1564 * Set the backing store of the indexed properties to be managed by the
1565 * embedding layer. Access to the indexed properties will follow the rules
1566 * spelled out in CanvasPixelArray.
1567 * Note: The embedding program still owns the data and needs to ensure that
1568 * the backing store is preserved while V8 has a reference.
1569 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001570 V8EXPORT void SetIndexedPropertiesToPixelData(uint8_t* data, int length);
whesse@chromium.org2c186ca2010-06-16 11:32:39 +00001571 bool HasIndexedPropertiesInPixelData();
1572 uint8_t* GetIndexedPropertiesPixelData();
1573 int GetIndexedPropertiesPixelDataLength();
sgjesse@chromium.org0b6db592009-07-30 14:48:31 +00001574
ager@chromium.org3811b432009-10-28 14:53:37 +00001575 /**
1576 * Set the backing store of the indexed properties to be managed by the
1577 * embedding layer. Access to the indexed properties will follow the rules
1578 * spelled out for the CanvasArray subtypes in the WebGL specification.
1579 * Note: The embedding program still owns the data and needs to ensure that
1580 * the backing store is preserved while V8 has a reference.
1581 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001582 V8EXPORT void SetIndexedPropertiesToExternalArrayData(
1583 void* data,
1584 ExternalArrayType array_type,
1585 int number_of_elements);
whesse@chromium.org2c186ca2010-06-16 11:32:39 +00001586 bool HasIndexedPropertiesInExternalArrayData();
1587 void* GetIndexedPropertiesExternalArrayData();
1588 ExternalArrayType GetIndexedPropertiesExternalArrayDataType();
1589 int GetIndexedPropertiesExternalArrayDataLength();
ager@chromium.org3811b432009-10-28 14:53:37 +00001590
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001591 V8EXPORT static Local<Object> New();
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001592 static inline Object* Cast(Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001593 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001594 V8EXPORT Object();
1595 V8EXPORT static void CheckCast(Value* obj);
1596 V8EXPORT Local<Value> CheckedGetInternalField(int index);
1597 V8EXPORT void* SlowGetPointerFromInternalField(int index);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001598
1599 /**
1600 * If quick access to the internal field is possible this method
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00001601 * returns the value. Otherwise an empty handle is returned.
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001602 */
1603 inline Local<Value> UncheckedGetInternalField(int index);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001604};
1605
1606
1607/**
1608 * An instance of the built-in array constructor (ECMA-262, 15.4.2).
1609 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001610class Array : public Object {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001611 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001612 V8EXPORT uint32_t Length() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001613
ager@chromium.org3e875802009-06-29 08:26:34 +00001614 /**
1615 * Clones an element at index |index|. Returns an empty
1616 * handle if cloning fails (for any reason).
1617 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001618 V8EXPORT Local<Object> CloneElementAt(uint32_t index);
ager@chromium.org3e875802009-06-29 08:26:34 +00001619
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001620 V8EXPORT static Local<Array> New(int length = 0);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001621 static inline Array* Cast(Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001622 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001623 V8EXPORT Array();
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001624 static void CheckCast(Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001625};
1626
1627
1628/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001629 * A JavaScript function object (ECMA-262, 15.3).
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001630 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001631class Function : public Object {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001632 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001633 V8EXPORT Local<Object> NewInstance() const;
1634 V8EXPORT Local<Object> NewInstance(int argc, Handle<Value> argv[]) const;
1635 V8EXPORT Local<Value> Call(Handle<Object> recv,
1636 int argc,
1637 Handle<Value> argv[]);
1638 V8EXPORT void SetName(Handle<String> name);
1639 V8EXPORT Handle<Value> GetName() const;
ager@chromium.org5c838252010-02-19 08:53:10 +00001640
1641 /**
1642 * Returns zero based line number of function body and
1643 * kLineOffsetNotFound if no information available.
1644 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001645 V8EXPORT int GetScriptLineNumber() const;
1646 V8EXPORT ScriptOrigin GetScriptOrigin() const;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001647 static inline Function* Cast(Value* obj);
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001648 V8EXPORT static const int kLineOffsetNotFound;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001649 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001650 V8EXPORT Function();
1651 V8EXPORT static void CheckCast(Value* obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001652};
1653
1654
1655/**
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001656 * A JavaScript value that wraps a C++ void*. This type of value is
1657 * mainly used to associate C++ data structures with JavaScript
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001658 * objects.
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001659 *
1660 * The Wrap function V8 will return the most optimal Value object wrapping the
1661 * C++ void*. The type of the value is not guaranteed to be an External object
1662 * and no assumptions about its type should be made. To access the wrapped
1663 * value Unwrap should be used, all other operations on that object will lead
1664 * to unpredictable results.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001665 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001666class External : public Value {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001667 public:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001668 V8EXPORT static Local<Value> Wrap(void* data);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001669 static inline void* Unwrap(Handle<Value> obj);
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001670
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001671 V8EXPORT static Local<External> New(void* value);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001672 static inline External* Cast(Value* obj);
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001673 V8EXPORT void* Value() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001674 private:
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001675 V8EXPORT External();
1676 V8EXPORT static void CheckCast(v8::Value* obj);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00001677 static inline void* QuickUnwrap(Handle<v8::Value> obj);
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001678 V8EXPORT static void* FullUnwrap(Handle<v8::Value> obj);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001679};
1680
1681
1682// --- T e m p l a t e s ---
1683
1684
1685/**
1686 * The superclass of object and function templates.
1687 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001688class V8EXPORT Template : public Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001689 public:
1690 /** Adds a property to each instance created by this template.*/
1691 void Set(Handle<String> name, Handle<Data> value,
1692 PropertyAttribute attributes = None);
1693 inline void Set(const char* name, Handle<Data> value);
1694 private:
1695 Template();
1696
1697 friend class ObjectTemplate;
1698 friend class FunctionTemplate;
1699};
1700
1701
1702/**
1703 * The argument information given to function call callbacks. This
v8.team.kasperl727e9952008-09-02 14:56:44 +00001704 * class provides access to information about the context of the call,
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001705 * including the receiver, the number and values of arguments, and
1706 * the holder of the function.
1707 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00001708class Arguments {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001709 public:
1710 inline int Length() const;
1711 inline Local<Value> operator[](int i) const;
1712 inline Local<Function> Callee() const;
1713 inline Local<Object> This() const;
1714 inline Local<Object> Holder() const;
1715 inline bool IsConstructCall() const;
1716 inline Local<Value> Data() const;
1717 private:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001718 friend class ImplementationUtilities;
1719 inline Arguments(Local<Value> data,
1720 Local<Object> holder,
1721 Local<Function> callee,
1722 bool is_construct_call,
1723 void** values, int length);
1724 Local<Value> data_;
1725 Local<Object> holder_;
1726 Local<Function> callee_;
1727 bool is_construct_call_;
1728 void** values_;
1729 int length_;
1730};
1731
1732
1733/**
1734 * The information passed to an accessor callback about the context
1735 * of the property access.
1736 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001737class V8EXPORT AccessorInfo {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001738 public:
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00001739 inline AccessorInfo(internal::Object** args)
1740 : args_(args) { }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001741 inline Local<Value> Data() const;
1742 inline Local<Object> This() const;
1743 inline Local<Object> Holder() const;
1744 private:
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00001745 internal::Object** args_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001746};
1747
1748
1749typedef Handle<Value> (*InvocationCallback)(const Arguments& args);
1750
1751typedef int (*LookupCallback)(Local<Object> self, Local<String> name);
1752
1753/**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001754 * NamedProperty[Getter|Setter] are used as interceptors on object.
1755 * See ObjectTemplate::SetNamedPropertyHandler.
1756 */
1757typedef Handle<Value> (*NamedPropertyGetter)(Local<String> property,
1758 const AccessorInfo& info);
1759
1760
1761/**
1762 * Returns the value if the setter intercepts the request.
1763 * Otherwise, returns an empty handle.
1764 */
1765typedef Handle<Value> (*NamedPropertySetter)(Local<String> property,
1766 Local<Value> value,
1767 const AccessorInfo& info);
1768
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001769/**
1770 * Returns a non-empty handle if the interceptor intercepts the request.
whesse@chromium.org2c186ca2010-06-16 11:32:39 +00001771 * The result is an integer encoding property attributes (like v8::None,
1772 * v8::DontEnum, etc.)
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001773 */
lrn@chromium.org1af7e1b2010-06-07 11:12:01 +00001774typedef Handle<Integer> (*NamedPropertyQuery)(Local<String> property,
1775 const AccessorInfo& info);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001776
1777
1778/**
1779 * Returns a non-empty handle if the deleter intercepts the request.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001780 * The return value is true if the property could be deleted and false
1781 * otherwise.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001782 */
1783typedef Handle<Boolean> (*NamedPropertyDeleter)(Local<String> property,
1784 const AccessorInfo& info);
1785
1786/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001787 * Returns an array containing the names of the properties the named
1788 * property getter intercepts.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001789 */
1790typedef Handle<Array> (*NamedPropertyEnumerator)(const AccessorInfo& info);
1791
v8.team.kasperl727e9952008-09-02 14:56:44 +00001792
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001793/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001794 * Returns the value of the property if the getter intercepts the
1795 * request. Otherwise, returns an empty handle.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001796 */
1797typedef Handle<Value> (*IndexedPropertyGetter)(uint32_t index,
1798 const AccessorInfo& info);
1799
1800
1801/**
1802 * Returns the value if the setter intercepts the request.
1803 * Otherwise, returns an empty handle.
1804 */
1805typedef Handle<Value> (*IndexedPropertySetter)(uint32_t index,
1806 Local<Value> value,
1807 const AccessorInfo& info);
1808
1809
1810/**
1811 * Returns a non-empty handle if the interceptor intercepts the request.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001812 * The result is true if the property exists and false otherwise.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001813 */
1814typedef Handle<Boolean> (*IndexedPropertyQuery)(uint32_t index,
1815 const AccessorInfo& info);
1816
1817/**
1818 * Returns a non-empty handle if the deleter intercepts the request.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001819 * The return value is true if the property could be deleted and false
1820 * otherwise.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001821 */
1822typedef Handle<Boolean> (*IndexedPropertyDeleter)(uint32_t index,
1823 const AccessorInfo& info);
1824
v8.team.kasperl727e9952008-09-02 14:56:44 +00001825/**
1826 * Returns an array containing the indices of the properties the
1827 * indexed property getter intercepts.
1828 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001829typedef Handle<Array> (*IndexedPropertyEnumerator)(const AccessorInfo& info);
1830
1831
1832/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001833 * Access type specification.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001834 */
1835enum AccessType {
1836 ACCESS_GET,
1837 ACCESS_SET,
1838 ACCESS_HAS,
1839 ACCESS_DELETE,
1840 ACCESS_KEYS
1841};
1842
v8.team.kasperl727e9952008-09-02 14:56:44 +00001843
1844/**
1845 * Returns true if cross-context access should be allowed to the named
christian.plesner.hansen@gmail.com2bc58ef2009-09-22 10:00:30 +00001846 * property with the given key on the host object.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001847 */
christian.plesner.hansen@gmail.com2bc58ef2009-09-22 10:00:30 +00001848typedef bool (*NamedSecurityCallback)(Local<Object> host,
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001849 Local<Value> key,
1850 AccessType type,
1851 Local<Value> data);
1852
v8.team.kasperl727e9952008-09-02 14:56:44 +00001853
1854/**
1855 * Returns true if cross-context access should be allowed to the indexed
christian.plesner.hansen@gmail.com2bc58ef2009-09-22 10:00:30 +00001856 * property with the given index on the host object.
v8.team.kasperl727e9952008-09-02 14:56:44 +00001857 */
christian.plesner.hansen@gmail.com2bc58ef2009-09-22 10:00:30 +00001858typedef bool (*IndexedSecurityCallback)(Local<Object> host,
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001859 uint32_t index,
1860 AccessType type,
1861 Local<Value> data);
1862
1863
1864/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001865 * A FunctionTemplate is used to create functions at runtime. There
1866 * can only be one function created from a FunctionTemplate in a
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00001867 * context. The lifetime of the created function is equal to the
1868 * lifetime of the context. So in case the embedder needs to create
1869 * temporary functions that can be collected using Scripts is
1870 * preferred.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001871 *
1872 * A FunctionTemplate can have properties, these properties are added to the
v8.team.kasperl727e9952008-09-02 14:56:44 +00001873 * function object when it is created.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001874 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00001875 * A FunctionTemplate has a corresponding instance template which is
1876 * used to create object instances when the function is used as a
1877 * constructor. Properties added to the instance template are added to
1878 * each object instance.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001879 *
1880 * A FunctionTemplate can have a prototype template. The prototype template
1881 * is used to create the prototype object of the function.
1882 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00001883 * The following example shows how to use a FunctionTemplate:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001884 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00001885 * \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001886 * v8::Local<v8::FunctionTemplate> t = v8::FunctionTemplate::New();
1887 * t->Set("func_property", v8::Number::New(1));
1888 *
1889 * v8::Local<v8::Template> proto_t = t->PrototypeTemplate();
1890 * proto_t->Set("proto_method", v8::FunctionTemplate::New(InvokeCallback));
1891 * proto_t->Set("proto_const", v8::Number::New(2));
1892 *
1893 * v8::Local<v8::ObjectTemplate> instance_t = t->InstanceTemplate();
1894 * instance_t->SetAccessor("instance_accessor", InstanceAccessorCallback);
1895 * instance_t->SetNamedPropertyHandler(PropertyHandlerCallback, ...);
1896 * instance_t->Set("instance_property", Number::New(3));
1897 *
1898 * v8::Local<v8::Function> function = t->GetFunction();
1899 * v8::Local<v8::Object> instance = function->NewInstance();
v8.team.kasperl727e9952008-09-02 14:56:44 +00001900 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001901 *
1902 * Let's use "function" as the JS variable name of the function object
v8.team.kasperl727e9952008-09-02 14:56:44 +00001903 * and "instance" for the instance object created above. The function
1904 * and the instance will have the following properties:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001905 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00001906 * \code
1907 * func_property in function == true;
1908 * function.func_property == 1;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001909 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00001910 * function.prototype.proto_method() invokes 'InvokeCallback'
1911 * function.prototype.proto_const == 2;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001912 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00001913 * instance instanceof function == true;
1914 * instance.instance_accessor calls 'InstanceAccessorCallback'
1915 * instance.instance_property == 3;
1916 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001917 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00001918 * A FunctionTemplate can inherit from another one by calling the
1919 * FunctionTemplate::Inherit method. The following graph illustrates
1920 * the semantics of inheritance:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001921 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00001922 * \code
1923 * FunctionTemplate Parent -> Parent() . prototype -> { }
1924 * ^ ^
1925 * | Inherit(Parent) | .__proto__
1926 * | |
1927 * FunctionTemplate Child -> Child() . prototype -> { }
1928 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001929 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00001930 * A FunctionTemplate 'Child' inherits from 'Parent', the prototype
1931 * object of the Child() function has __proto__ pointing to the
1932 * Parent() function's prototype object. An instance of the Child
1933 * function has all properties on Parent's instance templates.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001934 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00001935 * Let Parent be the FunctionTemplate initialized in the previous
1936 * section and create a Child FunctionTemplate by:
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001937 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00001938 * \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001939 * Local<FunctionTemplate> parent = t;
1940 * Local<FunctionTemplate> child = FunctionTemplate::New();
1941 * child->Inherit(parent);
1942 *
1943 * Local<Function> child_function = child->GetFunction();
1944 * Local<Object> child_instance = child_function->NewInstance();
v8.team.kasperl727e9952008-09-02 14:56:44 +00001945 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001946 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00001947 * The Child function and Child instance will have the following
1948 * properties:
1949 *
1950 * \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001951 * child_func.prototype.__proto__ == function.prototype;
v8.team.kasperl727e9952008-09-02 14:56:44 +00001952 * child_instance.instance_accessor calls 'InstanceAccessorCallback'
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001953 * child_instance.instance_property == 3;
v8.team.kasperl727e9952008-09-02 14:56:44 +00001954 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001955 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00001956class V8EXPORT FunctionTemplate : public Template {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001957 public:
1958 /** Creates a function template.*/
v8.team.kasperl727e9952008-09-02 14:56:44 +00001959 static Local<FunctionTemplate> New(
1960 InvocationCallback callback = 0,
1961 Handle<Value> data = Handle<Value>(),
1962 Handle<Signature> signature = Handle<Signature>());
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001963 /** Returns the unique function instance in the current execution context.*/
1964 Local<Function> GetFunction();
1965
v8.team.kasperl727e9952008-09-02 14:56:44 +00001966 /**
1967 * Set the call-handler callback for a FunctionTemplate. This
1968 * callback is called whenever the function created from this
1969 * FunctionTemplate is called.
1970 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001971 void SetCallHandler(InvocationCallback callback,
1972 Handle<Value> data = Handle<Value>());
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001973
v8.team.kasperl727e9952008-09-02 14:56:44 +00001974 /** Get the InstanceTemplate. */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001975 Local<ObjectTemplate> InstanceTemplate();
1976
1977 /** Causes the function template to inherit from a parent function template.*/
1978 void Inherit(Handle<FunctionTemplate> parent);
1979
1980 /**
1981 * A PrototypeTemplate is the template used to create the prototype object
1982 * of the function created by this template.
1983 */
1984 Local<ObjectTemplate> PrototypeTemplate();
1985
v8.team.kasperl727e9952008-09-02 14:56:44 +00001986
1987 /**
1988 * Set the class name of the FunctionTemplate. This is used for
1989 * printing objects created with the function created from the
1990 * FunctionTemplate as its constructor.
1991 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00001992 void SetClassName(Handle<String> name);
1993
1994 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00001995 * Determines whether the __proto__ accessor ignores instances of
1996 * the function template. If instances of the function template are
1997 * ignored, __proto__ skips all instances and instead returns the
1998 * next object in the prototype chain.
1999 *
2000 * Call with a value of true to make the __proto__ accessor ignore
2001 * instances of the function template. Call with a value of false
2002 * to make the __proto__ accessor not ignore instances of the
2003 * function template. By default, instances of a function template
2004 * are not ignored.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002005 */
2006 void SetHiddenPrototype(bool value);
2007
2008 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002009 * Returns true if the given object is an instance of this function
2010 * template.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002011 */
2012 bool HasInstance(Handle<Value> object);
2013
2014 private:
2015 FunctionTemplate();
2016 void AddInstancePropertyAccessor(Handle<String> name,
2017 AccessorGetter getter,
2018 AccessorSetter setter,
2019 Handle<Value> data,
2020 AccessControl settings,
2021 PropertyAttribute attributes);
2022 void SetNamedInstancePropertyHandler(NamedPropertyGetter getter,
2023 NamedPropertySetter setter,
2024 NamedPropertyQuery query,
2025 NamedPropertyDeleter remover,
2026 NamedPropertyEnumerator enumerator,
whesse@chromium.org2c186ca2010-06-16 11:32:39 +00002027 Handle<Value> data);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002028 void SetIndexedInstancePropertyHandler(IndexedPropertyGetter getter,
2029 IndexedPropertySetter setter,
2030 IndexedPropertyQuery query,
2031 IndexedPropertyDeleter remover,
2032 IndexedPropertyEnumerator enumerator,
2033 Handle<Value> data);
2034 void SetInstanceCallAsFunctionHandler(InvocationCallback callback,
2035 Handle<Value> data);
2036
2037 friend class Context;
2038 friend class ObjectTemplate;
2039};
2040
2041
2042/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002043 * An ObjectTemplate is used to create objects at runtime.
2044 *
2045 * Properties added to an ObjectTemplate are added to each object
2046 * created from the ObjectTemplate.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002047 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002048class V8EXPORT ObjectTemplate : public Template {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002049 public:
v8.team.kasperl727e9952008-09-02 14:56:44 +00002050 /** Creates an ObjectTemplate. */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002051 static Local<ObjectTemplate> New();
v8.team.kasperl727e9952008-09-02 14:56:44 +00002052
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002053 /** Creates a new instance of this template.*/
2054 Local<Object> NewInstance();
2055
2056 /**
2057 * Sets an accessor on the object template.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002058 *
2059 * Whenever the property with the given name is accessed on objects
2060 * created from this ObjectTemplate the getter and setter callbacks
2061 * are called instead of getting and setting the property directly
2062 * on the JavaScript object.
2063 *
2064 * \param name The name of the property for which an accessor is added.
2065 * \param getter The callback to invoke when getting the property.
2066 * \param setter The callback to invoke when setting the property.
2067 * \param data A piece of data that will be passed to the getter and setter
2068 * callbacks whenever they are invoked.
2069 * \param settings Access control settings for the accessor. This is a bit
2070 * field consisting of one of more of
2071 * DEFAULT = 0, ALL_CAN_READ = 1, or ALL_CAN_WRITE = 2.
2072 * The default is to not allow cross-context access.
2073 * ALL_CAN_READ means that all cross-context reads are allowed.
2074 * ALL_CAN_WRITE means that all cross-context writes are allowed.
2075 * The combination ALL_CAN_READ | ALL_CAN_WRITE can be used to allow all
2076 * cross-context access.
2077 * \param attribute The attributes of the property for which an accessor
2078 * is added.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002079 */
2080 void SetAccessor(Handle<String> name,
2081 AccessorGetter getter,
2082 AccessorSetter setter = 0,
2083 Handle<Value> data = Handle<Value>(),
2084 AccessControl settings = DEFAULT,
2085 PropertyAttribute attribute = None);
2086
2087 /**
2088 * Sets a named property handler on the object template.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002089 *
2090 * Whenever a named property is accessed on objects created from
2091 * this object template, the provided callback is invoked instead of
2092 * accessing the property directly on the JavaScript object.
2093 *
2094 * \param getter The callback to invoke when getting a property.
2095 * \param setter The callback to invoke when setting a property.
whesse@chromium.org2c186ca2010-06-16 11:32:39 +00002096 * \param query The callback to invoke to check if a property is present,
2097 * and if present, get its attributes.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002098 * \param deleter The callback to invoke when deleting a property.
2099 * \param enumerator The callback to invoke to enumerate all the named
2100 * properties of an object.
2101 * \param data A piece of data that will be passed to the callbacks
2102 * whenever they are invoked.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002103 */
2104 void SetNamedPropertyHandler(NamedPropertyGetter getter,
2105 NamedPropertySetter setter = 0,
2106 NamedPropertyQuery query = 0,
2107 NamedPropertyDeleter deleter = 0,
2108 NamedPropertyEnumerator enumerator = 0,
whesse@chromium.org2c186ca2010-06-16 11:32:39 +00002109 Handle<Value> data = Handle<Value>());
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002110
2111 /**
2112 * Sets an indexed property handler on the object template.
v8.team.kasperl727e9952008-09-02 14:56:44 +00002113 *
2114 * Whenever an indexed property is accessed on objects created from
2115 * this object template, the provided callback is invoked instead of
2116 * accessing the property directly on the JavaScript object.
2117 *
2118 * \param getter The callback to invoke when getting a property.
2119 * \param setter The callback to invoke when setting a property.
2120 * \param query The callback to invoke to check is an object has a property.
2121 * \param deleter The callback to invoke when deleting a property.
2122 * \param enumerator The callback to invoke to enumerate all the indexed
2123 * properties of an object.
2124 * \param data A piece of data that will be passed to the callbacks
2125 * whenever they are invoked.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002126 */
2127 void SetIndexedPropertyHandler(IndexedPropertyGetter getter,
2128 IndexedPropertySetter setter = 0,
2129 IndexedPropertyQuery query = 0,
2130 IndexedPropertyDeleter deleter = 0,
2131 IndexedPropertyEnumerator enumerator = 0,
2132 Handle<Value> data = Handle<Value>());
2133 /**
2134 * Sets the callback to be used when calling instances created from
2135 * this template as a function. If no callback is set, instances
v8.team.kasperl727e9952008-09-02 14:56:44 +00002136 * behave like normal JavaScript objects that cannot be called as a
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002137 * function.
2138 */
2139 void SetCallAsFunctionHandler(InvocationCallback callback,
2140 Handle<Value> data = Handle<Value>());
2141
v8.team.kasperl727e9952008-09-02 14:56:44 +00002142 /**
2143 * Mark object instances of the template as undetectable.
2144 *
2145 * In many ways, undetectable objects behave as though they are not
2146 * there. They behave like 'undefined' in conditionals and when
2147 * printed. However, properties can be accessed and called as on
2148 * normal objects.
2149 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002150 void MarkAsUndetectable();
2151
v8.team.kasperl727e9952008-09-02 14:56:44 +00002152 /**
2153 * Sets access check callbacks on the object template.
2154 *
2155 * When accessing properties on instances of this object template,
2156 * the access check callback will be called to determine whether or
2157 * not to allow cross-context access to the properties.
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002158 * The last parameter specifies whether access checks are turned
2159 * on by default on instances. If access checks are off by default,
2160 * they can be turned on on individual instances by calling
2161 * Object::TurnOnAccessCheck().
v8.team.kasperl727e9952008-09-02 14:56:44 +00002162 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002163 void SetAccessCheckCallbacks(NamedSecurityCallback named_handler,
2164 IndexedSecurityCallback indexed_handler,
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002165 Handle<Value> data = Handle<Value>(),
2166 bool turned_on_by_default = true);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002167
kasper.lund212ac232008-07-16 07:07:30 +00002168 /**
2169 * Gets the number of internal fields for objects generated from
2170 * this template.
2171 */
2172 int InternalFieldCount();
2173
2174 /**
2175 * Sets the number of internal fields for objects generated from
2176 * this template.
2177 */
2178 void SetInternalFieldCount(int value);
2179
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002180 private:
2181 ObjectTemplate();
2182 static Local<ObjectTemplate> New(Handle<FunctionTemplate> constructor);
2183 friend class FunctionTemplate;
2184};
2185
2186
2187/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002188 * A Signature specifies which receivers and arguments a function can
2189 * legally be called with.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002190 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002191class V8EXPORT Signature : public Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002192 public:
2193 static Local<Signature> New(Handle<FunctionTemplate> receiver =
2194 Handle<FunctionTemplate>(),
2195 int argc = 0,
2196 Handle<FunctionTemplate> argv[] = 0);
2197 private:
2198 Signature();
2199};
2200
2201
2202/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002203 * A utility for determining the type of objects based on the template
2204 * they were constructed from.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002205 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002206class V8EXPORT TypeSwitch : public Data {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002207 public:
2208 static Local<TypeSwitch> New(Handle<FunctionTemplate> type);
2209 static Local<TypeSwitch> New(int argc, Handle<FunctionTemplate> types[]);
2210 int match(Handle<Value> value);
2211 private:
2212 TypeSwitch();
2213};
2214
2215
2216// --- E x t e n s i o n s ---
2217
2218
2219/**
2220 * Ignore
2221 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002222class V8EXPORT Extension { // NOLINT
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002223 public:
2224 Extension(const char* name,
2225 const char* source = 0,
2226 int dep_count = 0,
2227 const char** deps = 0);
2228 virtual ~Extension() { }
2229 virtual v8::Handle<v8::FunctionTemplate>
2230 GetNativeFunction(v8::Handle<v8::String> name) {
2231 return v8::Handle<v8::FunctionTemplate>();
2232 }
2233
2234 const char* name() { return name_; }
2235 const char* source() { return source_; }
2236 int dependency_count() { return dep_count_; }
2237 const char** dependencies() { return deps_; }
2238 void set_auto_enable(bool value) { auto_enable_ = value; }
2239 bool auto_enable() { return auto_enable_; }
2240
2241 private:
2242 const char* name_;
2243 const char* source_;
2244 int dep_count_;
2245 const char** deps_;
2246 bool auto_enable_;
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00002247
2248 // Disallow copying and assigning.
2249 Extension(const Extension&);
2250 void operator=(const Extension&);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002251};
2252
2253
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002254void V8EXPORT RegisterExtension(Extension* extension);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002255
2256
2257/**
2258 * Ignore
2259 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002260class V8EXPORT DeclareExtension {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002261 public:
2262 inline DeclareExtension(Extension* extension) {
2263 RegisterExtension(extension);
2264 }
2265};
2266
2267
2268// --- S t a t i c s ---
2269
2270
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002271Handle<Primitive> V8EXPORT Undefined();
2272Handle<Primitive> V8EXPORT Null();
2273Handle<Boolean> V8EXPORT True();
2274Handle<Boolean> V8EXPORT False();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002275
2276
2277/**
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00002278 * A set of constraints that specifies the limits of the runtime's memory use.
2279 * You must set the heap size before initializing the VM - the size cannot be
2280 * adjusted after the VM is initialized.
2281 *
2282 * If you are using threads then you should hold the V8::Locker lock while
2283 * setting the stack limit and you must set a non-default stack limit separately
2284 * for each thread.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002285 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002286class V8EXPORT ResourceConstraints {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002287 public:
2288 ResourceConstraints();
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002289 int max_young_space_size() const { return max_young_space_size_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002290 void set_max_young_space_size(int value) { max_young_space_size_ = value; }
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002291 int max_old_space_size() const { return max_old_space_size_; }
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002292 void set_max_old_space_size(int value) { max_old_space_size_ = value; }
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002293 uint32_t* stack_limit() const { return stack_limit_; }
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00002294 // Sets an address beyond which the VM's stack may not grow.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002295 void set_stack_limit(uint32_t* value) { stack_limit_ = value; }
2296 private:
2297 int max_young_space_size_;
2298 int max_old_space_size_;
2299 uint32_t* stack_limit_;
2300};
2301
2302
sgjesse@chromium.org720dc0b2010-05-10 09:25:39 +00002303bool V8EXPORT SetResourceConstraints(ResourceConstraints* constraints);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002304
2305
2306// --- E x c e p t i o n s ---
2307
2308
2309typedef void (*FatalErrorCallback)(const char* location, const char* message);
2310
2311
2312typedef void (*MessageCallback)(Handle<Message> message, Handle<Value> data);
2313
2314
2315/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002316 * Schedules an exception to be thrown when returning to JavaScript. When an
2317 * exception has been scheduled it is illegal to invoke any JavaScript
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002318 * operation; the caller must return immediately and only after the exception
v8.team.kasperl727e9952008-09-02 14:56:44 +00002319 * has been handled does it become legal to invoke JavaScript operations.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002320 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002321Handle<Value> V8EXPORT ThrowException(Handle<Value> exception);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002322
2323/**
2324 * Create new error objects by calling the corresponding error object
2325 * constructor with the message.
2326 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002327class V8EXPORT Exception {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002328 public:
2329 static Local<Value> RangeError(Handle<String> message);
2330 static Local<Value> ReferenceError(Handle<String> message);
2331 static Local<Value> SyntaxError(Handle<String> message);
2332 static Local<Value> TypeError(Handle<String> message);
2333 static Local<Value> Error(Handle<String> message);
2334};
2335
2336
ager@chromium.orga74f0da2008-12-03 16:05:52 +00002337// --- C o u n t e r s C a l l b a c k s ---
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002338
ager@chromium.orga74f0da2008-12-03 16:05:52 +00002339typedef int* (*CounterLookupCallback)(const char* name);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002340
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002341typedef void* (*CreateHistogramCallback)(const char* name,
2342 int min,
2343 int max,
2344 size_t buckets);
2345
2346typedef void (*AddHistogramSampleCallback)(void* histogram, int sample);
2347
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002348// --- F a i l e d A c c e s s C h e c k C a l l b a c k ---
2349typedef void (*FailedAccessCheckCallback)(Local<Object> target,
2350 AccessType type,
2351 Local<Value> data);
2352
2353// --- G a r b a g e C o l l e c t i o n C a l l b a c k s
2354
2355/**
kmillikin@chromium.org5d8f0e62010-03-24 08:21:20 +00002356 * Applications can register callback functions which will be called
2357 * before and after a garbage collection. Allocations are not
2358 * allowed in the callback functions, you therefore cannot manipulate
v8.team.kasperl727e9952008-09-02 14:56:44 +00002359 * objects (set or delete properties for example) since it is possible
2360 * such operations will result in the allocation of objects.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002361 */
kmillikin@chromium.org5d8f0e62010-03-24 08:21:20 +00002362enum GCType {
2363 kGCTypeScavenge = 1 << 0,
2364 kGCTypeMarkSweepCompact = 1 << 1,
2365 kGCTypeAll = kGCTypeScavenge | kGCTypeMarkSweepCompact
2366};
2367
2368enum GCCallbackFlags {
2369 kNoGCCallbackFlags = 0,
2370 kGCCallbackFlagCompacted = 1 << 0
2371};
2372
2373typedef void (*GCPrologueCallback)(GCType type, GCCallbackFlags flags);
2374typedef void (*GCEpilogueCallback)(GCType type, GCCallbackFlags flags);
2375
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002376typedef void (*GCCallback)();
2377
2378
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002379/**
sgjesse@chromium.org0b6db592009-07-30 14:48:31 +00002380 * Profiler modules.
2381 *
2382 * In V8, profiler consists of several modules: CPU profiler, and different
2383 * kinds of heap profiling. Each can be turned on / off independently.
sgjesse@chromium.orgb9d7da12009-08-05 08:38:10 +00002384 * When PROFILER_MODULE_HEAP_SNAPSHOT flag is passed to ResumeProfilerEx,
2385 * modules are enabled only temporarily for making a snapshot of the heap.
sgjesse@chromium.org0b6db592009-07-30 14:48:31 +00002386 */
2387enum ProfilerModules {
2388 PROFILER_MODULE_NONE = 0,
2389 PROFILER_MODULE_CPU = 1,
2390 PROFILER_MODULE_HEAP_STATS = 1 << 1,
sgjesse@chromium.orgb9d7da12009-08-05 08:38:10 +00002391 PROFILER_MODULE_JS_CONSTRUCTORS = 1 << 2,
2392 PROFILER_MODULE_HEAP_SNAPSHOT = 1 << 16
sgjesse@chromium.org0b6db592009-07-30 14:48:31 +00002393};
2394
2395
2396/**
ager@chromium.org3811b432009-10-28 14:53:37 +00002397 * Collection of V8 heap information.
2398 *
2399 * Instances of this class can be passed to v8::V8::HeapStatistics to
2400 * get heap statistics from V8.
2401 */
2402class V8EXPORT HeapStatistics {
2403 public:
2404 HeapStatistics();
2405 size_t total_heap_size() { return total_heap_size_; }
2406 size_t used_heap_size() { return used_heap_size_; }
2407
2408 private:
2409 void set_total_heap_size(size_t size) { total_heap_size_ = size; }
2410 void set_used_heap_size(size_t size) { used_heap_size_ = size; }
2411
2412 size_t total_heap_size_;
2413 size_t used_heap_size_;
2414
2415 friend class V8;
2416};
2417
2418
2419/**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002420 * Container class for static utility functions.
2421 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002422class V8EXPORT V8 {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002423 public:
v8.team.kasperl727e9952008-09-02 14:56:44 +00002424 /** Set the callback to invoke in case of fatal errors. */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002425 static void SetFatalErrorHandler(FatalErrorCallback that);
2426
v8.team.kasperl727e9952008-09-02 14:56:44 +00002427 /**
2428 * Ignore out-of-memory exceptions.
2429 *
2430 * V8 running out of memory is treated as a fatal error by default.
2431 * This means that the fatal error handler is called and that V8 is
2432 * terminated.
2433 *
2434 * IgnoreOutOfMemoryException can be used to not treat a
2435 * out-of-memory situation as a fatal error. This way, the contexts
2436 * that did not cause the out of memory problem might be able to
2437 * continue execution.
2438 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002439 static void IgnoreOutOfMemoryException();
2440
v8.team.kasperl727e9952008-09-02 14:56:44 +00002441 /**
ager@chromium.org9258b6b2008-09-11 09:11:10 +00002442 * Check if V8 is dead and therefore unusable. This is the case after
v8.team.kasperl727e9952008-09-02 14:56:44 +00002443 * fatal errors such as out-of-memory situations.
2444 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002445 static bool IsDead();
2446
2447 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002448 * Adds a message listener.
2449 *
2450 * The same message listener can be added more than once and it that
2451 * case it will be called more than once for each message.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002452 */
2453 static bool AddMessageListener(MessageCallback that,
2454 Handle<Value> data = Handle<Value>());
2455
2456 /**
2457 * Remove all message listeners from the specified callback function.
2458 */
2459 static void RemoveMessageListeners(MessageCallback that);
2460
2461 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002462 * Sets V8 flags from a string.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002463 */
2464 static void SetFlagsFromString(const char* str, int length);
2465
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +00002466 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002467 * Sets V8 flags from the command line.
mads.s.ager@gmail.com9a4089a2008-09-01 08:55:01 +00002468 */
2469 static void SetFlagsFromCommandLine(int* argc,
2470 char** argv,
2471 bool remove_flags);
2472
kasper.lund7276f142008-07-30 08:49:36 +00002473 /** Get the version string. */
2474 static const char* GetVersion();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002475
2476 /**
2477 * Enables the host application to provide a mechanism for recording
2478 * statistics counters.
2479 */
2480 static void SetCounterFunction(CounterLookupCallback);
2481
2482 /**
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002483 * Enables the host application to provide a mechanism for recording
2484 * histograms. The CreateHistogram function returns a
2485 * histogram which will later be passed to the AddHistogramSample
2486 * function.
2487 */
2488 static void SetCreateHistogramFunction(CreateHistogramCallback);
2489 static void SetAddHistogramSampleFunction(AddHistogramSampleCallback);
2490
2491 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002492 * Enables the computation of a sliding window of states. The sliding
2493 * window information is recorded in statistics counters.
2494 */
2495 static void EnableSlidingStateWindow();
2496
2497 /** Callback function for reporting failed access checks.*/
2498 static void SetFailedAccessCheckCallbackFunction(FailedAccessCheckCallback);
2499
2500 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002501 * Enables the host application to receive a notification before a
kmillikin@chromium.org5d8f0e62010-03-24 08:21:20 +00002502 * garbage collection. Allocations are not allowed in the
2503 * callback function, you therefore cannot manipulate objects (set
2504 * or delete properties for example) since it is possible such
2505 * operations will result in the allocation of objects. It is possible
2506 * to specify the GCType filter for your callback. But it is not possible to
2507 * register the same callback function two times with different
2508 * GCType filters.
2509 */
2510 static void AddGCPrologueCallback(
2511 GCPrologueCallback callback, GCType gc_type_filter = kGCTypeAll);
2512
2513 /**
2514 * This function removes callback which was installed by
2515 * AddGCPrologueCallback function.
2516 */
2517 static void RemoveGCPrologueCallback(GCPrologueCallback callback);
2518
2519 /**
2520 * The function is deprecated. Please use AddGCPrologueCallback instead.
2521 * Enables the host application to receive a notification before a
2522 * garbage collection. Allocations are not allowed in the
v8.team.kasperl727e9952008-09-02 14:56:44 +00002523 * callback function, you therefore cannot manipulate objects (set
2524 * or delete properties for example) since it is possible such
2525 * operations will result in the allocation of objects.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002526 */
2527 static void SetGlobalGCPrologueCallback(GCCallback);
2528
2529 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002530 * Enables the host application to receive a notification after a
kmillikin@chromium.org5d8f0e62010-03-24 08:21:20 +00002531 * garbage collection. Allocations are not allowed in the
2532 * callback function, you therefore cannot manipulate objects (set
2533 * or delete properties for example) since it is possible such
2534 * operations will result in the allocation of objects. It is possible
2535 * to specify the GCType filter for your callback. But it is not possible to
2536 * register the same callback function two times with different
2537 * GCType filters.
2538 */
2539 static void AddGCEpilogueCallback(
2540 GCEpilogueCallback callback, GCType gc_type_filter = kGCTypeAll);
2541
2542 /**
2543 * This function removes callback which was installed by
2544 * AddGCEpilogueCallback function.
2545 */
2546 static void RemoveGCEpilogueCallback(GCEpilogueCallback callback);
2547
2548 /**
2549 * The function is deprecated. Please use AddGCEpilogueCallback instead.
2550 * Enables the host application to receive a notification after a
v8.team.kasperl727e9952008-09-02 14:56:44 +00002551 * major garbage collection. Allocations are not allowed in the
2552 * callback function, you therefore cannot manipulate objects (set
2553 * or delete properties for example) since it is possible such
2554 * operations will result in the allocation of objects.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002555 */
2556 static void SetGlobalGCEpilogueCallback(GCCallback);
2557
2558 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002559 * Allows the host application to group objects together. If one
2560 * object in the group is alive, all objects in the group are alive.
2561 * After each garbage collection, object groups are removed. It is
2562 * intended to be used in the before-garbage-collection callback
ager@chromium.org8bb60582008-12-11 12:02:20 +00002563 * function, for instance to simulate DOM tree connections among JS
v8.team.kasperl727e9952008-09-02 14:56:44 +00002564 * wrapper objects.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002565 */
ager@chromium.org8bb60582008-12-11 12:02:20 +00002566 static void AddObjectGroup(Persistent<Value>* objects, size_t length);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002567
2568 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002569 * Initializes from snapshot if possible. Otherwise, attempts to
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00002570 * initialize from scratch. This function is called implicitly if
2571 * you use the API without calling it first.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002572 */
2573 static bool Initialize();
2574
kasper.lund7276f142008-07-30 08:49:36 +00002575 /**
v8.team.kasperl727e9952008-09-02 14:56:44 +00002576 * Adjusts the amount of registered external memory. Used to give
2577 * V8 an indication of the amount of externally allocated memory
2578 * that is kept alive by JavaScript objects. V8 uses this to decide
2579 * when to perform global garbage collections. Registering
2580 * externally allocated memory will trigger global garbage
2581 * collections more often than otherwise in an attempt to garbage
2582 * collect the JavaScript objects keeping the externally allocated
2583 * memory alive.
2584 *
2585 * \param change_in_bytes the change in externally allocated memory
2586 * that is kept alive by JavaScript objects.
2587 * \returns the adjusted value.
kasper.lund7276f142008-07-30 08:49:36 +00002588 */
2589 static int AdjustAmountOfExternalAllocatedMemory(int change_in_bytes);
2590
iposva@chromium.org245aa852009-02-10 00:49:54 +00002591 /**
2592 * Suspends recording of tick samples in the profiler.
2593 * When the V8 profiling mode is enabled (usually via command line
2594 * switches) this function suspends recording of tick samples.
2595 * Profiling ticks are discarded until ResumeProfiler() is called.
2596 *
2597 * See also the --prof and --prof_auto command line switches to
2598 * enable V8 profiling.
2599 */
2600 static void PauseProfiler();
2601
2602 /**
2603 * Resumes recording of tick samples in the profiler.
2604 * See also PauseProfiler().
2605 */
2606 static void ResumeProfiler();
2607
ager@chromium.org41826e72009-03-30 13:30:57 +00002608 /**
kasperl@chromium.org71affb52009-05-26 05:44:31 +00002609 * Return whether profiler is currently paused.
2610 */
2611 static bool IsProfilerPaused();
2612
2613 /**
ager@chromium.org5c838252010-02-19 08:53:10 +00002614 * Resumes specified profiler modules. Can be called several times to
2615 * mark the opening of a profiler events block with the given tag.
2616 *
sgjesse@chromium.org0b6db592009-07-30 14:48:31 +00002617 * "ResumeProfiler" is equivalent to "ResumeProfilerEx(PROFILER_MODULE_CPU)".
2618 * See ProfilerModules enum.
2619 *
2620 * \param flags Flags specifying profiler modules.
ager@chromium.org5c838252010-02-19 08:53:10 +00002621 * \param tag Profile tag.
sgjesse@chromium.org0b6db592009-07-30 14:48:31 +00002622 */
ager@chromium.org5c838252010-02-19 08:53:10 +00002623 static void ResumeProfilerEx(int flags, int tag = 0);
sgjesse@chromium.org0b6db592009-07-30 14:48:31 +00002624
2625 /**
ager@chromium.org5c838252010-02-19 08:53:10 +00002626 * Pauses specified profiler modules. Each call to "PauseProfilerEx" closes
2627 * a block of profiler events opened by a call to "ResumeProfilerEx" with the
2628 * same tag value. There is no need for blocks to be properly nested.
2629 * The profiler is paused when the last opened block is closed.
2630 *
sgjesse@chromium.org0b6db592009-07-30 14:48:31 +00002631 * "PauseProfiler" is equivalent to "PauseProfilerEx(PROFILER_MODULE_CPU)".
2632 * See ProfilerModules enum.
2633 *
2634 * \param flags Flags specifying profiler modules.
ager@chromium.org5c838252010-02-19 08:53:10 +00002635 * \param tag Profile tag.
sgjesse@chromium.org0b6db592009-07-30 14:48:31 +00002636 */
ager@chromium.org5c838252010-02-19 08:53:10 +00002637 static void PauseProfilerEx(int flags, int tag = 0);
sgjesse@chromium.org0b6db592009-07-30 14:48:31 +00002638
2639 /**
2640 * Returns active (resumed) profiler modules.
2641 * See ProfilerModules enum.
2642 *
2643 * \returns active profiler modules.
2644 */
2645 static int GetActiveProfilerModules();
2646
2647 /**
ager@chromium.org9085a012009-05-11 19:22:57 +00002648 * If logging is performed into a memory buffer (via --logfile=*), allows to
2649 * retrieve previously written messages. This can be used for retrieving
2650 * profiler log data in the application. This function is thread-safe.
2651 *
2652 * Caller provides a destination buffer that must exist during GetLogLines
2653 * call. Only whole log lines are copied into the buffer.
2654 *
2655 * \param from_pos specified a point in a buffer to read from, 0 is the
2656 * beginning of a buffer. It is assumed that caller updates its current
2657 * position using returned size value from the previous call.
2658 * \param dest_buf destination buffer for log data.
2659 * \param max_size size of the destination buffer.
2660 * \returns actual size of log data copied into buffer.
2661 */
2662 static int GetLogLines(int from_pos, char* dest_buf, int max_size);
2663
sgjesse@chromium.orgc81c8942009-08-21 10:54:26 +00002664 /**
vegorov@chromium.orgf8372902010-03-15 10:26:20 +00002665 * The minimum allowed size for a log lines buffer. If the size of
2666 * the buffer given will not be enough to hold a line of the maximum
2667 * length, an attempt to find a log line end in GetLogLines will
2668 * fail, and an empty result will be returned.
2669 */
2670 static const int kMinimumSizeForLogLinesBuffer = 2048;
2671
2672 /**
sgjesse@chromium.orgc81c8942009-08-21 10:54:26 +00002673 * Retrieve the V8 thread id of the calling thread.
2674 *
2675 * The thread id for a thread should only be retrieved after the V8
2676 * lock has been acquired with a Locker object with that thread.
2677 */
2678 static int GetCurrentThreadId();
2679
2680 /**
2681 * Forcefully terminate execution of a JavaScript thread. This can
2682 * be used to terminate long-running scripts.
2683 *
2684 * TerminateExecution should only be called when then V8 lock has
2685 * been acquired with a Locker object. Therefore, in order to be
2686 * able to terminate long-running threads, preemption must be
2687 * enabled to allow the user of TerminateExecution to acquire the
2688 * lock.
2689 *
2690 * The termination is achieved by throwing an exception that is
2691 * uncatchable by JavaScript exception handlers. Termination
2692 * exceptions act as if they were caught by a C++ TryCatch exception
2693 * handlers. If forceful termination is used, any C++ TryCatch
2694 * exception handler that catches an exception should check if that
2695 * exception is a termination exception and immediately return if
2696 * that is the case. Returning immediately in that case will
2697 * continue the propagation of the termination exception if needed.
2698 *
2699 * The thread id passed to TerminateExecution must have been
2700 * obtained by calling GetCurrentThreadId on the thread in question.
2701 *
2702 * \param thread_id The thread id of the thread to terminate.
2703 */
2704 static void TerminateExecution(int thread_id);
2705
2706 /**
2707 * Forcefully terminate the current thread of JavaScript execution.
2708 *
2709 * This method can be used by any thread even if that thread has not
2710 * acquired the V8 lock with a Locker object.
2711 */
2712 static void TerminateExecution();
ager@chromium.org9085a012009-05-11 19:22:57 +00002713
2714 /**
sgjesse@chromium.org2ab99522010-03-10 09:03:43 +00002715 * Is V8 terminating JavaScript execution.
2716 *
2717 * Returns true if JavaScript execution is currently terminating
2718 * because of a call to TerminateExecution. In that case there are
2719 * still JavaScript frames on the stack and the termination
2720 * exception is still active.
2721 */
2722 static bool IsExecutionTerminating();
2723
2724 /**
ager@chromium.org41826e72009-03-30 13:30:57 +00002725 * Releases any resources used by v8 and stops any utility threads
2726 * that may be running. Note that disposing v8 is permanent, it
2727 * cannot be reinitialized.
2728 *
2729 * It should generally not be necessary to dispose v8 before exiting
2730 * a process, this should happen automatically. It is only necessary
2731 * to use if the process needs the resources taken up by v8.
2732 */
2733 static bool Dispose();
2734
ager@chromium.org3811b432009-10-28 14:53:37 +00002735 /**
2736 * Get statistics about the heap memory usage.
2737 */
2738 static void GetHeapStatistics(HeapStatistics* heap_statistics);
ager@chromium.orgadd848f2009-08-13 12:44:13 +00002739
2740 /**
2741 * Optional notification that the embedder is idle.
2742 * V8 uses the notification to reduce memory footprint.
ager@chromium.orgab99eea2009-08-25 07:05:41 +00002743 * This call can be used repeatedly if the embedder remains idle.
ager@chromium.orgab99eea2009-08-25 07:05:41 +00002744 * Returns true if the embedder should stop calling IdleNotification
2745 * until real work has been done. This indicates that V8 has done
2746 * as much cleanup as it will be able to do.
ager@chromium.orgadd848f2009-08-13 12:44:13 +00002747 */
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00002748 static bool IdleNotification();
ager@chromium.orgadd848f2009-08-13 12:44:13 +00002749
sgjesse@chromium.orgc81c8942009-08-21 10:54:26 +00002750 /**
2751 * Optional notification that the system is running low on memory.
2752 * V8 uses these notifications to attempt to free memory.
2753 */
2754 static void LowMemoryNotification();
2755
kasperl@chromium.org8b2bb262010-03-01 09:46:28 +00002756 /**
2757 * Optional notification that a context has been disposed. V8 uses
ager@chromium.orgce5e87b2010-03-10 10:24:18 +00002758 * these notifications to guide the GC heuristic. Returns the number
2759 * of context disposals - including this one - since the last time
2760 * V8 had a chance to clean up.
kasperl@chromium.org8b2bb262010-03-01 09:46:28 +00002761 */
ager@chromium.orgce5e87b2010-03-10 10:24:18 +00002762 static int ContextDisposedNotification();
kasperl@chromium.org8b2bb262010-03-01 09:46:28 +00002763
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002764 private:
2765 V8();
2766
ager@chromium.org18ad94b2009-09-02 08:22:29 +00002767 static internal::Object** GlobalizeReference(internal::Object** handle);
2768 static void DisposeGlobal(internal::Object** global_handle);
2769 static void MakeWeak(internal::Object** global_handle,
2770 void* data,
2771 WeakReferenceCallback);
2772 static void ClearWeak(internal::Object** global_handle);
2773 static bool IsGlobalNearDeath(internal::Object** global_handle);
2774 static bool IsGlobalWeak(internal::Object** global_handle);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002775
2776 template <class T> friend class Handle;
2777 template <class T> friend class Local;
2778 template <class T> friend class Persistent;
2779 friend class Context;
2780};
2781
2782
2783/**
2784 * An external exception handler.
2785 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002786class V8EXPORT TryCatch {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002787 public:
2788
2789 /**
2790 * Creates a new try/catch block and registers it with v8.
2791 */
2792 TryCatch();
2793
2794 /**
2795 * Unregisters and deletes this try/catch block.
2796 */
2797 ~TryCatch();
2798
2799 /**
2800 * Returns true if an exception has been caught by this try/catch block.
2801 */
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002802 bool HasCaught() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002803
2804 /**
sgjesse@chromium.orgc81c8942009-08-21 10:54:26 +00002805 * For certain types of exceptions, it makes no sense to continue
2806 * execution.
2807 *
2808 * Currently, the only type of exception that can be caught by a
2809 * TryCatch handler and for which it does not make sense to continue
2810 * is termination exception. Such exceptions are thrown when the
2811 * TerminateExecution methods are called to terminate a long-running
2812 * script.
2813 *
2814 * If CanContinue returns false, the correct action is to perform
2815 * any C++ cleanup needed and then return.
2816 */
2817 bool CanContinue() const;
2818
2819 /**
christian.plesner.hansen@gmail.comb9ce6372009-11-03 11:38:18 +00002820 * Throws the exception caught by this TryCatch in a way that avoids
2821 * it being caught again by this same TryCatch. As with ThrowException
2822 * it is illegal to execute any JavaScript operations after calling
2823 * ReThrow; the caller must return immediately to where the exception
2824 * is caught.
2825 */
2826 Handle<Value> ReThrow();
2827
2828 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002829 * Returns the exception caught by this try/catch block. If no exception has
2830 * been caught an empty handle is returned.
2831 *
2832 * The returned handle is valid until this TryCatch block has been destroyed.
2833 */
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002834 Local<Value> Exception() const;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002835
2836 /**
sgjesse@chromium.org911335c2009-08-19 12:59:44 +00002837 * Returns the .stack property of the thrown object. If no .stack
2838 * property is present an empty handle is returned.
2839 */
2840 Local<Value> StackTrace() const;
2841
2842 /**
ager@chromium.org9258b6b2008-09-11 09:11:10 +00002843 * Returns the message associated with this exception. If there is
2844 * no message associated an empty handle is returned.
2845 *
2846 * The returned handle is valid until this TryCatch block has been
2847 * destroyed.
2848 */
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002849 Local<v8::Message> Message() const;
ager@chromium.org9258b6b2008-09-11 09:11:10 +00002850
2851 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002852 * Clears any exceptions that may have been caught by this try/catch block.
2853 * After this method has been called, HasCaught() will return false.
2854 *
2855 * It is not necessary to clear a try/catch block before using it again; if
2856 * another exception is thrown the previously caught exception will just be
2857 * overwritten. However, it is often a good idea since it makes it easier
2858 * to determine which operation threw a given exception.
2859 */
2860 void Reset();
2861
v8.team.kasperl727e9952008-09-02 14:56:44 +00002862 /**
2863 * Set verbosity of the external exception handler.
2864 *
2865 * By default, exceptions that are caught by an external exception
2866 * handler are not reported. Call SetVerbose with true on an
2867 * external exception handler to have exceptions caught by the
2868 * handler reported as if they were not caught.
2869 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002870 void SetVerbose(bool value);
2871
ager@chromium.org9258b6b2008-09-11 09:11:10 +00002872 /**
2873 * Set whether or not this TryCatch should capture a Message object
2874 * which holds source information about where the exception
2875 * occurred. True by default.
2876 */
2877 void SetCaptureMessage(bool value);
2878
ager@chromium.orgc4c92722009-11-18 14:12:51 +00002879 private:
2880 void* next_;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002881 void* exception_;
ager@chromium.org9258b6b2008-09-11 09:11:10 +00002882 void* message_;
christian.plesner.hansen@gmail.comb9ce6372009-11-03 11:38:18 +00002883 bool is_verbose_ : 1;
2884 bool can_continue_ : 1;
2885 bool capture_message_ : 1;
2886 bool rethrow_ : 1;
ager@chromium.orgc4c92722009-11-18 14:12:51 +00002887
2888 friend class v8::internal::Top;
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002889};
2890
2891
2892// --- C o n t e x t ---
2893
2894
2895/**
2896 * Ignore
2897 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002898class V8EXPORT ExtensionConfiguration {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002899 public:
2900 ExtensionConfiguration(int name_count, const char* names[])
2901 : name_count_(name_count), names_(names) { }
2902 private:
2903 friend class ImplementationUtilities;
2904 int name_count_;
2905 const char** names_;
2906};
2907
2908
2909/**
2910 * A sandboxed execution context with its own set of built-in objects
2911 * and functions.
2912 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00002913class V8EXPORT Context {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002914 public:
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002915 /** Returns the global object of the context. */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002916 Local<Object> Global();
2917
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002918 /**
2919 * Detaches the global object from its context before
2920 * the global object can be reused to create a new context.
2921 */
2922 void DetachGlobal();
2923
sgjesse@chromium.orgdf7a2842010-03-25 14:34:15 +00002924 /**
2925 * Reattaches a global object to a context. This can be used to
2926 * restore the connection between a global object and a context
2927 * after DetachGlobal has been called.
2928 *
2929 * \param global_object The global object to reattach to the
2930 * context. For this to work, the global object must be the global
2931 * object that was associated with this context before a call to
2932 * DetachGlobal.
2933 */
2934 void ReattachGlobal(Handle<Object> global_object);
2935
kmillikin@chromium.org9155e252010-05-26 13:27:57 +00002936 /** Creates a new context.
2937 *
2938 * Returns a persistent handle to the newly allocated context. This
2939 * persistent handle has to be disposed when the context is no
2940 * longer used so the context can be garbage collected.
2941 */
v8.team.kasperl727e9952008-09-02 14:56:44 +00002942 static Persistent<Context> New(
kmillikin@chromium.org5d8f0e62010-03-24 08:21:20 +00002943 ExtensionConfiguration* extensions = NULL,
v8.team.kasperl727e9952008-09-02 14:56:44 +00002944 Handle<ObjectTemplate> global_template = Handle<ObjectTemplate>(),
2945 Handle<Value> global_object = Handle<Value>());
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002946
kasper.lund44510672008-07-25 07:37:58 +00002947 /** Returns the last entered context. */
2948 static Local<Context> GetEntered();
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002949
kasper.lund44510672008-07-25 07:37:58 +00002950 /** Returns the context that is on the top of the stack. */
2951 static Local<Context> GetCurrent();
2952
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002953 /**
ager@chromium.org1bf0cd02009-05-20 11:34:19 +00002954 * Returns the context of the calling JavaScript code. That is the
2955 * context of the top-most JavaScript frame. If there are no
2956 * JavaScript frames an empty handle is returned.
2957 */
2958 static Local<Context> GetCalling();
2959
2960 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002961 * Sets the security token for the context. To access an object in
2962 * another context, the security tokens must match.
2963 */
2964 void SetSecurityToken(Handle<Value> token);
2965
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00002966 /** Restores the security token to the default value. */
2967 void UseDefaultSecurityToken();
2968
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002969 /** Returns the security token of this context.*/
2970 Handle<Value> GetSecurityToken();
2971
v8.team.kasperl727e9952008-09-02 14:56:44 +00002972 /**
2973 * Enter this context. After entering a context, all code compiled
2974 * and run is compiled and run in this context. If another context
2975 * is already entered, this old context is saved so it can be
2976 * restored when the new context is exited.
2977 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002978 void Enter();
v8.team.kasperl727e9952008-09-02 14:56:44 +00002979
2980 /**
2981 * Exit this context. Exiting the current context restores the
2982 * context that was in place when entering the current context.
2983 */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002984 void Exit();
2985
v8.team.kasperl727e9952008-09-02 14:56:44 +00002986 /** Returns true if the context has experienced an out of memory situation. */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002987 bool HasOutOfMemoryException();
2988
v8.team.kasperl727e9952008-09-02 14:56:44 +00002989 /** Returns true if V8 has a current context. */
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002990 static bool InContext();
2991
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00002992 /**
ager@chromium.org9085a012009-05-11 19:22:57 +00002993 * Associate an additional data object with the context. This is mainly used
2994 * with the debugger to provide additional information on the context through
2995 * the debugger API.
2996 */
sgjesse@chromium.org499aaa52009-11-30 08:07:20 +00002997 void SetData(Handle<String> data);
ager@chromium.org9085a012009-05-11 19:22:57 +00002998 Local<Value> GetData();
2999
3000 /**
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003001 * Stack-allocated class which sets the execution context for all
3002 * operations executed within a local scope.
3003 */
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00003004 class Scope {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003005 public:
3006 inline Scope(Handle<Context> context) : context_(context) {
3007 context_->Enter();
3008 }
3009 inline ~Scope() { context_->Exit(); }
3010 private:
3011 Handle<Context> context_;
3012 };
3013
3014 private:
3015 friend class Value;
3016 friend class Script;
3017 friend class Object;
3018 friend class Function;
3019};
3020
3021
3022/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00003023 * Multiple threads in V8 are allowed, but only one thread at a time
3024 * is allowed to use V8. The definition of 'using V8' includes
3025 * accessing handles or holding onto object pointers obtained from V8
3026 * handles. It is up to the user of V8 to ensure (perhaps with
3027 * locking) that this constraint is not violated.
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003028 *
3029 * If you wish to start using V8 in a thread you can do this by constructing
3030 * a v8::Locker object. After the code using V8 has completed for the
3031 * current thread you can call the destructor. This can be combined
3032 * with C++ scope-based construction as follows:
3033 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00003034 * \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003035 * ...
3036 * {
3037 * v8::Locker locker;
3038 * ...
3039 * // Code using V8 goes here.
3040 * ...
3041 * } // Destructor called here
v8.team.kasperl727e9952008-09-02 14:56:44 +00003042 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003043 *
3044 * If you wish to stop using V8 in a thread A you can do this by either
3045 * by destroying the v8::Locker object as above or by constructing a
3046 * v8::Unlocker object:
3047 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00003048 * \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003049 * {
3050 * v8::Unlocker unlocker;
3051 * ...
3052 * // Code not using V8 goes here while V8 can run in another thread.
3053 * ...
3054 * } // Destructor called here.
v8.team.kasperl727e9952008-09-02 14:56:44 +00003055 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003056 *
3057 * The Unlocker object is intended for use in a long-running callback
3058 * from V8, where you want to release the V8 lock for other threads to
3059 * use.
3060 *
3061 * The v8::Locker is a recursive lock. That is, you can lock more than
3062 * once in a given thread. This can be useful if you have code that can
3063 * be called either from code that holds the lock or from code that does
3064 * not. The Unlocker is not recursive so you can not have several
3065 * Unlockers on the stack at once, and you can not use an Unlocker in a
3066 * thread that is not inside a Locker's scope.
3067 *
3068 * An unlocker will unlock several lockers if it has to and reinstate
3069 * the correct depth of locking on its destruction. eg.:
3070 *
v8.team.kasperl727e9952008-09-02 14:56:44 +00003071 * \code
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003072 * // V8 not locked.
3073 * {
3074 * v8::Locker locker;
3075 * // V8 locked.
3076 * {
3077 * v8::Locker another_locker;
3078 * // V8 still locked (2 levels).
3079 * {
3080 * v8::Unlocker unlocker;
3081 * // V8 not locked.
3082 * }
3083 * // V8 locked again (2 levels).
3084 * }
3085 * // V8 still locked (1 level).
3086 * }
3087 * // V8 Now no longer locked.
v8.team.kasperl727e9952008-09-02 14:56:44 +00003088 * \endcode
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003089 */
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00003090class V8EXPORT Unlocker {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003091 public:
3092 Unlocker();
3093 ~Unlocker();
3094};
3095
3096
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00003097class V8EXPORT Locker {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003098 public:
3099 Locker();
3100 ~Locker();
v8.team.kasperl727e9952008-09-02 14:56:44 +00003101
3102 /**
3103 * Start preemption.
3104 *
3105 * When preemption is started, a timer is fired every n milli seconds
3106 * that will switch between multiple threads that are in contention
3107 * for the V8 lock.
3108 */
3109 static void StartPreemption(int every_n_ms);
3110
3111 /**
3112 * Stop preemption.
3113 */
3114 static void StopPreemption();
3115
ager@chromium.org9258b6b2008-09-11 09:11:10 +00003116 /**
3117 * Returns whether or not the locker is locked by the current thread.
3118 */
3119 static bool IsLocked();
3120
ager@chromium.orgddb913d2009-01-27 10:01:48 +00003121 /**
3122 * Returns whether v8::Locker is being used by this V8 instance.
3123 */
3124 static bool IsActive() { return active_; }
3125
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003126 private:
3127 bool has_lock_;
3128 bool top_level_;
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00003129
ager@chromium.orgddb913d2009-01-27 10:01:48 +00003130 static bool active_;
3131
kasperl@chromium.org41044eb2008-10-06 08:24:46 +00003132 // Disallow copying and assigning.
3133 Locker(const Locker&);
3134 void operator=(const Locker&);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003135};
3136
3137
3138
3139// --- I m p l e m e n t a t i o n ---
3140
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003141
3142namespace internal {
3143
3144
3145// Tag information for HeapObject.
3146const int kHeapObjectTag = 1;
3147const int kHeapObjectTagSize = 2;
3148const intptr_t kHeapObjectTagMask = (1 << kHeapObjectTagSize) - 1;
3149
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003150// Tag information for Smi.
3151const int kSmiTag = 0;
3152const int kSmiTagSize = 1;
3153const intptr_t kSmiTagMask = (1 << kSmiTagSize) - 1;
3154
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003155template <size_t ptr_size> struct SmiConstants;
3156
3157// Smi constants for 32-bit systems.
3158template <> struct SmiConstants<4> {
3159 static const int kSmiShiftSize = 0;
3160 static const int kSmiValueSize = 31;
3161 static inline int SmiToInt(internal::Object* value) {
3162 int shift_bits = kSmiTagSize + kSmiShiftSize;
3163 // Throw away top 32 bits and shift down (requires >> to be sign extending).
3164 return static_cast<int>(reinterpret_cast<intptr_t>(value)) >> shift_bits;
3165 }
3166};
3167
3168// Smi constants for 64-bit systems.
3169template <> struct SmiConstants<8> {
3170 static const int kSmiShiftSize = 31;
3171 static const int kSmiValueSize = 32;
3172 static inline int SmiToInt(internal::Object* value) {
3173 int shift_bits = kSmiTagSize + kSmiShiftSize;
3174 // Shift down and throw away top 32 bits.
3175 return static_cast<int>(reinterpret_cast<intptr_t>(value) >> shift_bits);
3176 }
3177};
3178
3179const int kSmiShiftSize = SmiConstants<sizeof(void*)>::kSmiShiftSize;
3180const int kSmiValueSize = SmiConstants<sizeof(void*)>::kSmiValueSize;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003181
sgjesse@chromium.orgac6aa172009-12-04 12:29:05 +00003182template <size_t ptr_size> struct InternalConstants;
3183
3184// Internal constants for 32-bit systems.
3185template <> struct InternalConstants<4> {
3186 static const int kStringResourceOffset = 3 * sizeof(void*);
3187};
3188
3189// Internal constants for 64-bit systems.
3190template <> struct InternalConstants<8> {
ager@chromium.orgac091b72010-05-05 07:34:42 +00003191 static const int kStringResourceOffset = 3 * sizeof(void*);
sgjesse@chromium.orgac6aa172009-12-04 12:29:05 +00003192};
3193
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003194/**
3195 * This class exports constants and functionality from within v8 that
3196 * is necessary to implement inline functions in the v8 api. Don't
3197 * depend on functions and constants defined here.
3198 */
3199class Internals {
3200 public:
3201
3202 // These values match non-compiler-dependent values defined within
3203 // the implementation of v8.
3204 static const int kHeapObjectMapOffset = 0;
3205 static const int kMapInstanceTypeOffset = sizeof(void*) + sizeof(int);
sgjesse@chromium.orgac6aa172009-12-04 12:29:05 +00003206 static const int kStringResourceOffset =
3207 InternalConstants<sizeof(void*)>::kStringResourceOffset;
3208
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003209 static const int kProxyProxyOffset = sizeof(void*);
3210 static const int kJSObjectHeaderSize = 3 * sizeof(void*);
3211 static const int kFullStringRepresentationMask = 0x07;
sgjesse@chromium.org82dbbab2010-06-02 08:57:44 +00003212 static const int kExternalTwoByteRepresentationTag = 0x02;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003213
ricow@chromium.org5ad5ace2010-06-23 09:06:43 +00003214 static const int kJSObjectType = 0x9f;
3215 static const int kFirstNonstringType = 0x80;
3216 static const int kProxyType = 0x85;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003217
3218 static inline bool HasHeapObjectTag(internal::Object* value) {
3219 return ((reinterpret_cast<intptr_t>(value) & kHeapObjectTagMask) ==
3220 kHeapObjectTag);
3221 }
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00003222
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003223 static inline bool HasSmiTag(internal::Object* value) {
3224 return ((reinterpret_cast<intptr_t>(value) & kSmiTagMask) == kSmiTag);
3225 }
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00003226
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003227 static inline int SmiValue(internal::Object* value) {
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003228 return SmiConstants<sizeof(void*)>::SmiToInt(value);
3229 }
3230
3231 static inline int GetInstanceType(internal::Object* obj) {
3232 typedef internal::Object O;
3233 O* map = ReadField<O*>(obj, kHeapObjectMapOffset);
3234 return ReadField<uint8_t>(map, kMapInstanceTypeOffset);
3235 }
3236
3237 static inline void* GetExternalPointer(internal::Object* obj) {
3238 if (HasSmiTag(obj)) {
3239 return obj;
3240 } else if (GetInstanceType(obj) == kProxyType) {
3241 return ReadField<void*>(obj, kProxyProxyOffset);
3242 } else {
3243 return NULL;
3244 }
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003245 }
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00003246
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003247 static inline bool IsExternalTwoByteString(int instance_type) {
3248 int representation = (instance_type & kFullStringRepresentationMask);
3249 return representation == kExternalTwoByteRepresentationTag;
3250 }
3251
3252 template <typename T>
3253 static inline T ReadField(Object* ptr, int offset) {
3254 uint8_t* addr = reinterpret_cast<uint8_t*>(ptr) + offset - kHeapObjectTag;
3255 return *reinterpret_cast<T*>(addr);
3256 }
3257
3258};
3259
3260}
3261
3262
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003263template <class T>
3264Handle<T>::Handle() : val_(0) { }
3265
3266
3267template <class T>
3268Local<T>::Local() : Handle<T>() { }
3269
3270
3271template <class T>
3272Local<T> Local<T>::New(Handle<T> that) {
3273 if (that.IsEmpty()) return Local<T>();
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003274 internal::Object** p = reinterpret_cast<internal::Object**>(*that);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003275 return Local<T>(reinterpret_cast<T*>(HandleScope::CreateHandle(*p)));
3276}
3277
3278
3279template <class T>
3280Persistent<T> Persistent<T>::New(Handle<T> that) {
3281 if (that.IsEmpty()) return Persistent<T>();
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003282 internal::Object** p = reinterpret_cast<internal::Object**>(*that);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003283 return Persistent<T>(reinterpret_cast<T*>(V8::GlobalizeReference(p)));
3284}
3285
3286
3287template <class T>
ager@chromium.org32912102009-01-16 10:38:43 +00003288bool Persistent<T>::IsNearDeath() const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003289 if (this->IsEmpty()) return false;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003290 return V8::IsGlobalNearDeath(reinterpret_cast<internal::Object**>(**this));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003291}
3292
3293
3294template <class T>
ager@chromium.org32912102009-01-16 10:38:43 +00003295bool Persistent<T>::IsWeak() const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003296 if (this->IsEmpty()) return false;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003297 return V8::IsGlobalWeak(reinterpret_cast<internal::Object**>(**this));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003298}
3299
3300
3301template <class T>
3302void Persistent<T>::Dispose() {
3303 if (this->IsEmpty()) return;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003304 V8::DisposeGlobal(reinterpret_cast<internal::Object**>(**this));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003305}
3306
3307
3308template <class T>
3309Persistent<T>::Persistent() : Handle<T>() { }
3310
3311template <class T>
3312void Persistent<T>::MakeWeak(void* parameters, WeakReferenceCallback callback) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003313 V8::MakeWeak(reinterpret_cast<internal::Object**>(**this),
3314 parameters,
3315 callback);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003316}
3317
3318template <class T>
3319void Persistent<T>::ClearWeak() {
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003320 V8::ClearWeak(reinterpret_cast<internal::Object**>(**this));
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003321}
3322
kmillikin@chromium.org69ea3962010-07-05 11:01:40 +00003323
3324Arguments::Arguments(v8::Local<v8::Value> data,
3325 v8::Local<v8::Object> holder,
3326 v8::Local<v8::Function> callee,
3327 bool is_construct_call,
3328 void** values, int length)
3329 : data_(data), holder_(holder), callee_(callee),
3330 is_construct_call_(is_construct_call),
3331 values_(values), length_(length) { }
3332
3333
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003334Local<Value> Arguments::operator[](int i) const {
3335 if (i < 0 || length_ <= i) return Local<Value>(*Undefined());
3336 return Local<Value>(reinterpret_cast<Value*>(values_ - i));
3337}
3338
3339
3340Local<Function> Arguments::Callee() const {
3341 return callee_;
3342}
3343
3344
3345Local<Object> Arguments::This() const {
3346 return Local<Object>(reinterpret_cast<Object*>(values_ + 1));
3347}
3348
3349
3350Local<Object> Arguments::Holder() const {
3351 return holder_;
3352}
3353
3354
3355Local<Value> Arguments::Data() const {
3356 return data_;
3357}
3358
3359
3360bool Arguments::IsConstructCall() const {
3361 return is_construct_call_;
3362}
3363
3364
3365int Arguments::Length() const {
3366 return length_;
3367}
3368
3369
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003370template <class T>
3371Local<T> HandleScope::Close(Handle<T> value) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003372 internal::Object** before = reinterpret_cast<internal::Object**>(*value);
3373 internal::Object** after = RawClose(before);
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003374 return Local<T>(reinterpret_cast<T*>(after));
3375}
3376
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00003377Handle<Value> ScriptOrigin::ResourceName() const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003378 return resource_name_;
3379}
3380
3381
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00003382Handle<Integer> ScriptOrigin::ResourceLineOffset() const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003383 return resource_line_offset_;
3384}
3385
3386
kasperl@chromium.org5a8ca6c2008-10-23 13:57:19 +00003387Handle<Integer> ScriptOrigin::ResourceColumnOffset() const {
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003388 return resource_column_offset_;
3389}
3390
3391
3392Handle<Boolean> Boolean::New(bool value) {
3393 return value ? True() : False();
3394}
3395
3396
3397void Template::Set(const char* name, v8::Handle<Data> value) {
3398 Set(v8::String::New(name), value);
3399}
3400
3401
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003402Local<Value> Object::GetInternalField(int index) {
3403#ifndef V8_ENABLE_CHECKS
3404 Local<Value> quick_result = UncheckedGetInternalField(index);
3405 if (!quick_result.IsEmpty()) return quick_result;
3406#endif
3407 return CheckedGetInternalField(index);
3408}
3409
3410
3411Local<Value> Object::UncheckedGetInternalField(int index) {
3412 typedef internal::Object O;
3413 typedef internal::Internals I;
3414 O* obj = *reinterpret_cast<O**>(this);
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003415 if (I::GetInstanceType(obj) == I::kJSObjectType) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003416 // If the object is a plain JSObject, which is the common case,
3417 // we know where to find the internal fields and can return the
3418 // value directly.
3419 int offset = I::kJSObjectHeaderSize + (sizeof(void*) * index);
3420 O* value = I::ReadField<O*>(obj, offset);
3421 O** result = HandleScope::CreateHandle(value);
3422 return Local<Value>(reinterpret_cast<Value*>(result));
3423 } else {
3424 return Local<Value>();
3425 }
3426}
3427
3428
3429void* External::Unwrap(Handle<v8::Value> obj) {
3430#ifdef V8_ENABLE_CHECKS
3431 return FullUnwrap(obj);
3432#else
3433 return QuickUnwrap(obj);
3434#endif
3435}
3436
3437
3438void* External::QuickUnwrap(Handle<v8::Value> wrapper) {
3439 typedef internal::Object O;
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003440 O* obj = *reinterpret_cast<O**>(const_cast<v8::Value*>(*wrapper));
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003441 return internal::Internals::GetExternalPointer(obj);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003442}
3443
3444
3445void* Object::GetPointerFromInternalField(int index) {
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003446 typedef internal::Object O;
3447 typedef internal::Internals I;
3448
3449 O* obj = *reinterpret_cast<O**>(this);
3450
3451 if (I::GetInstanceType(obj) == I::kJSObjectType) {
3452 // If the object is a plain JSObject, which is the common case,
3453 // we know where to find the internal fields and can return the
3454 // value directly.
3455 int offset = I::kJSObjectHeaderSize + (sizeof(void*) * index);
3456 O* value = I::ReadField<O*>(obj, offset);
3457 return I::GetExternalPointer(value);
3458 }
3459
3460 return SlowGetPointerFromInternalField(index);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003461}
3462
3463
3464String* String::Cast(v8::Value* value) {
3465#ifdef V8_ENABLE_CHECKS
3466 CheckCast(value);
3467#endif
3468 return static_cast<String*>(value);
3469}
3470
3471
3472String::ExternalStringResource* String::GetExternalStringResource() const {
3473 typedef internal::Object O;
3474 typedef internal::Internals I;
3475 O* obj = *reinterpret_cast<O**>(const_cast<String*>(this));
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003476 String::ExternalStringResource* result;
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003477 if (I::IsExternalTwoByteString(I::GetInstanceType(obj))) {
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003478 void* value = I::ReadField<void*>(obj, I::kStringResourceOffset);
3479 result = reinterpret_cast<String::ExternalStringResource*>(value);
3480 } else {
3481 result = NULL;
3482 }
3483#ifdef V8_ENABLE_CHECKS
3484 VerifyExternalStringResource(result);
3485#endif
3486 return result;
3487}
3488
3489
3490bool Value::IsString() const {
3491#ifdef V8_ENABLE_CHECKS
3492 return FullIsString();
3493#else
3494 return QuickIsString();
3495#endif
3496}
3497
3498bool Value::QuickIsString() const {
3499 typedef internal::Object O;
3500 typedef internal::Internals I;
3501 O* obj = *reinterpret_cast<O**>(const_cast<Value*>(this));
3502 if (!I::HasHeapObjectTag(obj)) return false;
christian.plesner.hansen@gmail.com9d58c2b2009-10-16 11:48:38 +00003503 return (I::GetInstanceType(obj) < I::kFirstNonstringType);
ager@chromium.org18ad94b2009-09-02 08:22:29 +00003504}
3505
3506
3507Number* Number::Cast(v8::Value* value) {
3508#ifdef V8_ENABLE_CHECKS
3509 CheckCast(value);
3510#endif
3511 return static_cast<Number*>(value);
3512}
3513
3514
3515Integer* Integer::Cast(v8::Value* value) {
3516#ifdef V8_ENABLE_CHECKS
3517 CheckCast(value);
3518#endif
3519 return static_cast<Integer*>(value);
3520}
3521
3522
3523Date* Date::Cast(v8::Value* value) {
3524#ifdef V8_ENABLE_CHECKS
3525 CheckCast(value);
3526#endif
3527 return static_cast<Date*>(value);
3528}
3529
3530
3531Object* Object::Cast(v8::Value* value) {
3532#ifdef V8_ENABLE_CHECKS
3533 CheckCast(value);
3534#endif
3535 return static_cast<Object*>(value);
3536}
3537
3538
3539Array* Array::Cast(v8::Value* value) {
3540#ifdef V8_ENABLE_CHECKS
3541 CheckCast(value);
3542#endif
3543 return static_cast<Array*>(value);
3544}
3545
3546
3547Function* Function::Cast(v8::Value* value) {
3548#ifdef V8_ENABLE_CHECKS
3549 CheckCast(value);
3550#endif
3551 return static_cast<Function*>(value);
3552}
3553
3554
3555External* External::Cast(v8::Value* value) {
3556#ifdef V8_ENABLE_CHECKS
3557 CheckCast(value);
3558#endif
3559 return static_cast<External*>(value);
3560}
3561
3562
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00003563Local<Value> AccessorInfo::Data() const {
ager@chromium.orgb26c50a2010-03-26 09:27:16 +00003564 return Local<Value>(reinterpret_cast<Value*>(&args_[-2]));
sgjesse@chromium.orgc5145742009-10-07 09:00:33 +00003565}
3566
3567
3568Local<Object> AccessorInfo::This() const {
3569 return Local<Object>(reinterpret_cast<Object*>(&args_[0]));
3570}
3571
3572
3573Local<Object> AccessorInfo::Holder() const {
3574 return Local<Object>(reinterpret_cast<Object*>(&args_[-1]));
3575}
3576
3577
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003578/**
v8.team.kasperl727e9952008-09-02 14:56:44 +00003579 * \example shell.cc
3580 * A simple shell that takes a list of expressions on the
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003581 * command-line and executes them.
3582 */
3583
3584
3585/**
3586 * \example process.cc
3587 */
3588
3589
3590} // namespace v8
3591
3592
ager@chromium.orgbb29dc92009-03-24 13:25:23 +00003593#undef V8EXPORT
christian.plesner.hansen43d26ec2008-07-03 15:10:15 +00003594#undef TYPE_CHECK
3595
3596
ager@chromium.org9258b6b2008-09-11 09:11:10 +00003597#endif // V8_H_