modules/tool-classfile/src/main/java/net/multiphasicapps/classfile/InstructionAddressRange.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 GNU General Public License v3+, or later.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package net.multiphasicapps.classfile;
  11
  12 import java.lang.ref.Reference;
  13 import java.lang.ref.WeakReference;
  14
  15 /**
  16  * This represents a range of instruction addresses, the start is inclusive
  17  * and the end is exclusive.
  18  *
  19  * @since 2019/03/21
  20  */
  21 public final class InstructionAddressRange
  22         implements Comparable<InstructionAddressRange>
  23 {
  24         /** The start address. */
  25         protected final int start;
  26
  27         /** The end address. */
  28         protected final int end;
  29
  30         /** String representation. */
  31         private Reference<String> _string;
  32
  33         /**
  34          * Initializes the address range.
  35          *
  36          * @param __s The start address.
  37          * @param __e The end address.
  38          * @since 2019/03/21
  39          */
  40         public InstructionAddressRange(int __s, int __e)
  41         {
  42                 this.start = __s;
  43                 this.end = __e;
  44         }
  45
  46         /**
  47          * {@inheritDoc}
  48          * @since 2019/03/21
  49          */
  50         @Override
  51         public final int compareTo(InstructionAddressRange __b)
  52         {
  53                 int rv = this.start - __b.start;
  54                 if (rv != 0)
  55                         return rv;
  56
  57                 return this.end - __b.end;
  58         }
  59
  60         /**
  61          * {@inheritDoc}
  62          * @since 2019/03/21
  63          */
  64         @Override
  65         public final boolean equals(Object __o)
  66         {
  67                 if (__o == this)
  68                         return true;
  69
  70                 if (!(__o instanceof InstructionAddressRange))
  71                         return false;
  72
  73                 InstructionAddressRange o = (InstructionAddressRange)__o;
  74                 return this.start == o.start &&
  75                         this.end == o.end;
  76         }
  77
  78         /**
  79          * {@inheritDoc}
  80          * @since 2019/03/21
  81          */
  82         @Override
  83         public final int hashCode()
  84         {
  85                 return this.start ^ (~this.end);
  86         }
  87
  88         /**
  89          * Checks if the given address is in the range of this range.
  90          *
  91          * @param __pc The address to check.
  92          * @return If the address is in range.
  93          * @since 2019/03/22
  94          */
  95         public final boolean inRange(int __pc)
  96         {
  97                 return __pc >= this.start && __pc < this.end;
  98         }
  99
 100         /**
 101          * {@inheritDoc}
 102          * @since 2019/03/21
 103          */
 104         @Override
 105         public final String toString()
 106         {
 107                 Reference<String> ref = this._string;
 108                 String rv;
 109
 110                 if (ref == null || null == (rv = ref.get()))
 111                         this._string = new WeakReference<>((rv = "@[" + this.start +
 112                                 "-" + this.end + ")"));
 113
 114                 return rv;
 115         }
 116 }
 117