001 /*****************************************************************************
002 * *
003 * This file is part of the BeanShell Java Scripting distribution. *
004 * Documentation and updates may be found at http://www.beanshell.org/ *
005 * *
006 * Sun Public License Notice: *
007 * *
008 * The contents of this file are subject to the Sun Public License Version *
009 * 1.0 (the "License"); you may not use this file except in compliance with *
010 * the License. A copy of the License is available at http://www.sun.com *
011 * *
012 * The Original Code is BeanShell. The Initial Developer of the Original *
013 * Code is Pat Niemeyer. Portions created by Pat Niemeyer are Copyright *
014 * (C) 2000. All Rights Reserved. *
015 * *
016 * GNU Public License Notice: *
017 * *
018 * Alternatively, the contents of this file may be used under the terms of *
019 * the GNU Lesser General Public License (the "LGPL"), in which case the *
020 * provisions of LGPL are applicable instead of those above. If you wish to *
021 * allow use of your version of this file only under the terms of the LGPL *
022 * and not to allow others to use your version of this file under the SPL, *
023 * indicate your decision by deleting the provisions above and replace *
024 * them with the notice and other provisions required by the LGPL. If you *
025 * do not delete the provisions above, a recipient may use your version of *
026 * this file under either the SPL or the LGPL. *
027 * *
028 * Patrick Niemeyer (pat@pat.net) *
029 * Author of Learning Java, O'Reilly & Associates *
030 * http://www.pat.net/~pat/ *
031 * *
032 *****************************************************************************/
033
034 package bsh;
035
036 import java.util.Vector;
037
038 /**
039 A stack of NameSpaces representing the call path.
040 Each method invocation, for example, pushes a new NameSpace onto the stack.
041 The top of the stack is always the current namespace of evaluation.
042 <p>
043
044 This is used to support the this.caller magic reference and to print
045 script "stack traces" when evaluation errors occur.
046 <p>
047
048 Note: it would be awefully nice to use the java.util.Stack here.
049 Sigh... have to stay 1.1 compatible.
050 <p>
051
052 Note: How can this be thread safe, you might ask? Wouldn't a thread
053 executing various beanshell methods be mutating the callstack? Don't we
054 need one CallStack per Thread in the interpreter? The answer is that we do.
055 Any java.lang.Thread enters our script via an external (hard) Java
056 reference via a This type interface, e.g. the Runnable interface
057 implemented by This or an arbitrary interface implemented by XThis.
058 In that case the This invokeMethod() method (called by any interface that
059 it exposes) creates a new CallStack for each external call.
060 <p>
061 */
062 public class CallStack
063 {
064 private Vector stack = new Vector(2);
065
066 public CallStack() { }
067
068 public CallStack( NameSpace namespace ) {
069 push( namespace );
070 }
071
072 public void clear() {
073 stack.removeAllElements();
074 }
075
076 public void push( NameSpace ns ) {
077 stack.insertElementAt( ns, 0 );
078 }
079
080 public NameSpace top() {
081 return get(0);
082 }
083
084 /**
085 zero based.
086 */
087 public NameSpace get(int depth) {
088 if ( depth >= depth() )
089 return NameSpace.JAVACODE;
090 else
091 return (NameSpace)(stack.elementAt(depth));
092 }
093
094 /**
095 This is kind of crazy, but used by the setNameSpace command.
096 zero based.
097 */
098 public void set(int depth, NameSpace ns) {
099 stack.setElementAt(ns, depth );
100 }
101
102 public NameSpace pop() {
103 if ( depth() < 1 )
104 throw new InterpreterError("pop on empty CallStack");
105 NameSpace top = top();
106 stack.removeElementAt(0);
107 return top;
108 }
109
110 /**
111 Swap in the value as the new top of the stack and return the old
112 value.
113 */
114 public NameSpace swap( NameSpace newTop ) {
115 NameSpace oldTop = (NameSpace)(stack.elementAt(0));
116 stack.setElementAt( newTop, 0 );
117 return oldTop;
118 }
119
120 public int depth() {
121 return stack.size();
122 }
123
124 public NameSpace [] toArray() {
125 NameSpace [] nsa = new NameSpace [ depth() ];
126 stack.copyInto( nsa );
127 return nsa;
128 }
129
130 public String toString() {
131 StringBuffer sb = new StringBuffer();
132 sb.append("CallStack:\n");
133 NameSpace [] nsa = toArray();
134 for(int i=0; i<nsa.length; i++)
135 sb.append("\t"+nsa[i]+"\n");
136
137 return sb.toString();
138 }
139
140 /**
141 Occasionally we need to freeze the callstack for error reporting
142 purposes, etc.
143 */
144 public CallStack copy() {
145 CallStack cs = new CallStack();
146 cs.stack = (Vector)this.stack.clone();
147 return cs;
148 }
149 }