blob: ddde8e1bcd88009fdca3dbbe8927f2ac5d370bf0 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
/*******************************************************************************
* Copyright (c) 2000, 2005 QNX Software Systems and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* QNX Software Systems - Initial API and implementation
*******************************************************************************/
package org.eclipse.cdt.debug.core.cdi.model;
import org.eclipse.cdt.debug.core.cdi.CDIException;
import org.eclipse.cdt.debug.core.cdi.ICDILocator;
/**
*
* A stack frame in a suspended thread.
* A stack frame contains variables representing visible locals and
* arguments at the current execution location.
*
* @since Jul 8, 2002
*/
public interface ICDIStackFrame extends ICDIExecuteStepReturn, ICDIObject {
/**
* Returns the location of the instruction pointer in this
* stack frame.
*
* @return the location of the instruction pointer
*/
ICDILocator getLocator();
/**
* Returns the visible variables in this stack frame. An empty
* collection is returned if there are no visible variables.
*
* @return a collection of visible variables
* @throws CDIException if this method fails. Reasons include:
*/
ICDILocalVariableDescriptor[] getLocalVariableDescriptors() throws CDIException;
/**
* Create a variable from the descriptor for evaluation. A CreatedEvent will be trigger and
* ChangedEvent will also be trigger when the variable is assign a new value.
* DestroyedEvent is fired when the variable is out of scope and automatically
* removed from the manager list.
* @param varDesc ICDThreadStorageDesc
* @return
* @throws CDIException
*/
ICDIArgument createArgument(ICDIArgumentDescriptor varDesc) throws CDIException;
/**
* Create a variable from the descriptor for evaluation. A CreatedEvent will be trigger and
* ChangedEvent will also be trigger when the variable is assign a new value.
* DestroyedEvent is fired when the variable is out of scope and automatically
* removed from the manager list.
* @param varDesc ICDThreadStorageDesc
* @return
* @throws CDIException
*/
ICDILocalVariable createLocalVariable(ICDILocalVariableDescriptor varDesc) throws CDIException;
/**
* Returns the arguments in this stack frame. An empty collection
* is returned if there are no arguments.
*
* @return a collection of arguments
* @throws CDIException if this method fails. Reasons include:
*/
ICDIArgumentDescriptor[] getArgumentDescriptors() throws CDIException;
/**
* Returns the thread this stackframe is contained in.
*
* @return the thread
*/
ICDIThread getThread();
/**
* Returns the level of the stack frame, 1 based.
*
* @return the level of the stack frame
*/
int getLevel();
/**
* Return true if the frames are the same.
*/
boolean equals(ICDIStackFrame stackframe);
}
|
