Source for gnu.classpath.jdwp.VMFrame

   1: /* VMFrame.java -- Reference implementation of VM hooks for JDWP Frame access.
   2:    Copyright (C) 2005, 2006, 2007 Free Software Foundation
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: terms of your choice, provided that you also meet, for each linked
  32: independent module, the terms and conditions of the license of that
  33: module.  An independent module is a module which is not derived from
  34: or based on this library.  If you modify this library, you may extend
  35: this exception to your version of the library, but you are not
  36: obligated to do so.  If you do not wish to do so, delete this
  37: exception statement from your version. */
  38: 
  39: 
  40: package gnu.classpath.jdwp;
  41: 
  42: import gnu.classpath.jdwp.util.Location;
  43: import gnu.classpath.jdwp.value.Value;
  44: 
  45: /**
  46:  * Reference implementation of VM hooks for JDWP Frame access.
  47:  * 
  48:  * @author aluchko 
  49:  */
  50: 
  51: public class VMFrame
  52: {
  53:   /**
  54:    * Returns the size of a frame ID over JDWP
  55:    */
  56:   public static final int SIZE = 8;
  57: 
  58:   // The thread this frame resides in
  59:   private Thread thread;
  60:    
  61:   //The object of this frame
  62:   private Object obj;
  63:   
  64:   // The current location of this frame
  65:   private Location loc;
  66:   
  67:   // id of this frame
  68:   private long id;
  69:   
  70:   /**
  71:    * Create a new VMFrame object.
  72:    * 
  73:    * @param thr a Thread, the thread this frame is in
  74:    * @param frame_id a long, the jframeID of this frame
  75:    * @param frame_loc a Location, the location of this frame
  76:    */
  77:   public VMFrame(Thread thr, long frame_id, Location frame_loc,
  78:                  Object frame_obj)
  79:   {
  80:     thread = thr;
  81:     id = frame_id;
  82:     loc = frame_loc;
  83:     obj = frame_obj;
  84:   }
  85:   
  86:   /**
  87:    * Gets the current location of the frame.
  88:    */
  89:   public Location getLocation()
  90:   {
  91:     return loc;
  92:   }
  93: 
  94:   /**
  95:    * Returns the value of the variable in the given slot.
  96:    * 
  97:    * @param slot the slot containing the variable
  98:    */
  99:   public native Value getValue(int slot, byte sig);
 100: 
 101:   /**
 102:    * Assigns the given variable to the given value. 
 103:    * @param slot The slot which contains the variable
 104:    * @param value The value to assign the variable to
 105:    */
 106:   public native void setValue(int slot, Value value);
 107:   
 108:   /**
 109:    * Get the thread this frame is in.
 110:    */
 111:   public Thread getThread()
 112:   {
 113:     return thread;
 114:   }
 115: 
 116:   /**
 117:    * Get the object which is represented by 'this' in the context of the frame,
 118:    * returns null if the method is native or static.
 119:    */
 120:   public Object getObject()
 121:   {
 122:     return obj;
 123:   }
 124: 
 125:   /**
 126:    * Get the frameID
 127:    * @return an id which is unique within the scope of the VM
 128:    */
 129:   public long getId()
 130:   {
 131:     return id;
 132:   }
 133: 
 134: }