modules/debug-jdwp/src/main/java/cc/squirreljme/jdwp/host/JDWPHostCommandSetObjectReference.java

   1 // -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the Mozilla Public License Version 2.0.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package cc.squirreljme.jdwp.host;
  11
  12 import cc.squirreljme.jdwp.JDWPCommand;
  13 import cc.squirreljme.jdwp.JDWPCommandSetObjectReference;
  14 import cc.squirreljme.jdwp.JDWPErrorType;
  15 import cc.squirreljme.jdwp.JDWPException;
  16 import cc.squirreljme.jdwp.JDWPHostController;
  17 import cc.squirreljme.jdwp.JDWPPacket;
  18 import cc.squirreljme.jdwp.JDWPValue;
  19 import cc.squirreljme.jdwp.JDWPValueTag;
  20 import cc.squirreljme.jdwp.host.views.JDWPViewObject;
  21 import cc.squirreljme.jdwp.host.views.JDWPViewType;
  22
  23 /**
  24  * Object reference command set.
  25  *
  26  * @since 2021/03/14
  27  */
  28 public enum JDWPHostCommandSetObjectReference
  29         implements JDWPCommandHandler
  30 {
  31         /** The type that an object is. */
  32         REFERENCE_TYPE(JDWPCommandSetObjectReference.REFERENCE_TYPE)
  33         {
  34                 /**
  35                  * {@inheritDoc}
  36                  * @since 2021/03/14
  37                  */
  38                 @Override
  39                 public JDWPPacket execute(JDWPHostController __controller,
  40                         JDWPPacket __packet)
  41                         throws JDWPException
  42                 {
  43                         // Obtain the object and the type of that object
  44                         Object object = __controller.readObject(__packet, false);
  45                         Object type = (__controller.viewType().isValid(object) ?
  46                                 object : __controller.viewObject().type(object));
  47
  48                         // Register it for future reference
  49                         __controller.getState().items.put(object);
  50                         if (type != null)
  51                                 __controller.getState().items.put(type);
  52
  53                         JDWPPacket rv = __controller.reply(
  54                                 __packet.id(), JDWPErrorType.NO_ERROR);
  55
  56                         // Write the details of this class
  57                         __controller.writeTaggedId(rv, type);
  58
  59                         return rv;
  60                 }
  61         },
  62
  63         /** Get field values. */
  64         GET_VALUES(JDWPCommandSetObjectReference.GET_VALUES)
  65         {
  66                 /**
  67                  * {@inheritDoc}
  68                  * @since 2021/03/17
  69                  */
  70                 @Override
  71                 public JDWPPacket execute(JDWPHostController __controller,
  72                         JDWPPacket __packet)
  73                         throws JDWPException
  74                 {
  75                         JDWPViewObject viewObject = __controller.viewObject();
  76                         JDWPViewType viewType = __controller.viewType();
  77
  78                         // The type is needed to ensure the field class is valid
  79                         Object object = __controller.readObject(__packet, false);
  80                         Object type = viewObject.type(object);
  81
  82                         // Read in all field indexes and check for their validity
  83                         int numFields = __packet.readInt();
  84                         int[] fields = new int[numFields];
  85                         for (int i = 0; i < numFields; i++)
  86                         {
  87                                 int fieldDx = __packet.readId();
  88                                 if (!viewType.isValidField(type, fieldDx))
  89                                         throw JDWPErrorType.INVALID_FIELD_ID.toss(type, fieldDx);
  90
  91                                 fields[i] = fieldDx;
  92                         }
  93
  94                         JDWPPacket rv = __controller.reply(
  95                                 __packet.id(), JDWPErrorType.NO_ERROR);
  96
  97                         // Write field mappings
  98                         rv.writeInt(numFields);
  99                         for (int i = 0; i < numFields; i++)
 100                                 try (JDWPValue value = __controller.value())
 101                                 {
 102                                         // Determine the field type and its tag
 103                                         String fieldSig = viewType.fieldSignature(type, fields[i]);
 104                                         JDWPValueTag tag = JDWPValueTag.fromSignature(fieldSig);
 105
 106                                         // Read the field value, fallback if not valid
 107                                         if (!viewObject.readValue(object, fields[i], value))
 108                                                 value.set(tag.defaultValue);
 109
 110                                         // Always write as tagged value
 111                                         __controller.writeValue(rv, value, tag, false);
 112
 113                                         // Store object for later use
 114                                         if (value.get() != null && tag.isObject)
 115                                                 __controller.getState().items.put(value.get());
 116                                 }
 117
 118                         return rv;
 119                 }
 120         },
 121
 122         /** Is this object garbage collected? */
 123         IS_COLLECTED(JDWPCommandSetObjectReference.IS_COLLECTED)
 124         {
 125                 /**
 126                  * {@inheritDoc}
 127                  * @since 2021/03/14
 128                  */
 129                 @Override
 130                 public JDWPPacket execute(JDWPHostController __controller,
 131                         JDWPPacket __packet)
 132                         throws JDWPException
 133                 {
 134                         // Read the value but do nothing for it
 135                         __controller.readObject(__packet, false);
 136
 137                         // If we still know about this object it was not GCed
 138                         JDWPPacket rv = __controller.reply(
 139                                 __packet.id(), JDWPErrorType.NO_ERROR);
 140                         rv.writeBoolean(false);
 141
 142                         return rv;
 143                 }
 144         },
 145
 146         /* End. */
 147         ;
 148
 149         /** The base command. */
 150         public final JDWPCommand command;
 151
 152         /** The ID of the packet. */
 153         public final int id;
 154
 155         /**
 156          * Returns the ID used.
 157          *
 158          * @param __id The ID used.
 159          * @since 2021/03/14
 160          */
 161         JDWPHostCommandSetObjectReference(JDWPCommand __id)
 162         {
 163                 this.command = __id;
 164                 this.id = __id.debuggerId();
 165         }
 166
 167         /**
 168          * {@inheritDoc}
 169          * @since 2024/01/23
 170          */
 171         @Override
 172         public final JDWPCommand command()
 173         {
 174                 return this.command;
 175         }
 176
 177         /**
 178          * {@inheritDoc}
 179          * @since 2021/03/14
 180          */
 181         @Override
 182         public final int debuggerId()
 183         {
 184                 return this.id;
 185         }
 186 }