1/*
2 * Copyright (C) 2008 Apple Inc. All Rights Reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26[
27    WillBeGarbageCollected,
28    NoInterfaceObject,
29    DoNotCheckConstants
30] interface JavaScriptCallFrame {
31
32    // Scope type
33    const unsigned short GLOBAL_SCOPE = 0;
34    const unsigned short LOCAL_SCOPE = 1;
35    const unsigned short WITH_SCOPE = 2;
36    const unsigned short CLOSURE_SCOPE = 3;
37    const unsigned short CATCH_SCOPE = 4;
38
39    [Custom] void evaluateWithExceptionDetails(DOMString script);
40    [Custom] any restart();
41
42    // Only declarative scope (local, with and catch) is accepted. Returns undefined.
43    [CallWith=ScriptState] any setVariableValue([Default=Undefined] optional long scopeIndex, [TreatUndefinedAs=NullString, Default=Undefined] optional DOMString? variableName, [Default=Undefined] optional any newValue);
44
45    readonly attribute JavaScriptCallFrame caller;
46    readonly attribute long sourceID;
47    readonly attribute long line;
48    readonly attribute long column;
49    [Custom=Getter] readonly attribute object scopeChain;
50    [Custom] unsigned short scopeType(long scopeIndex);
51    [Custom=Getter] readonly attribute object thisObject;
52    readonly attribute DOMString stepInPositions;
53    readonly attribute DOMString functionName;
54    [Custom=Getter] readonly attribute DOMString type;
55    readonly attribute boolean isAtReturn;
56    [Custom=Getter] readonly attribute any returnValue;
57};
58