modules/cldc-compact/src/main/java/cc/squirreljme/jvm/mle/ObjectShelf.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 cc.squirreljme.jvm.mle;
  11
  12 import cc.squirreljme.jvm.mle.brackets.TypeBracket;
  13 import cc.squirreljme.jvm.mle.constants.MonitorResultType;
  14 import cc.squirreljme.jvm.mle.exceptions.MLECallError;
  15 import cc.squirreljme.runtime.cldc.annotation.Api;
  16
  17 /**
  18  * This shelf supports object anything that has to do with objects.
  19  *
  20  * @since 2020/06/09
  21  */
  22 @SquirrelJMEVendorApi
  23 public final class ObjectShelf
  24 {
  25         /**
  26          * Not used.
  27          *
  28          * @since 2020/06/09
  29          */
  30         private ObjectShelf()
  31         {
  32         }
  33
  34         /**
  35          * Checks if the given object can be stored in the specified array.
  36          *
  37          * @param __array The array to check.
  38          * @param __val The value to check
  39          * @return If the value can be stored in the given array.
  40          * @throws MLECallError If given type is not an array or {@code __array}
  41          * is {@code null}.
  42          * @since 2021/02/07
  43          */
  44         @SquirrelJMEVendorApi
  45         public static native boolean arrayCheckStore(Object __array, Object __val)
  46                 throws MLECallError;
  47
  48         /**
  49          * Copies the given arrays. If the source and destination are the same
  50          * array, the copy operation will not collide with itself.
  51          *
  52          * @param __src The source array.
  53          * @param __srcOff The source offset.
  54          * @param __dest The destination array.
  55          * @param __destOff The destination offset.
  56          * @param __len The elements to copy.
  57          * @since 2020/06/22
  58          */
  59         @SquirrelJMEVendorApi
  60         public static native void arrayCopy(boolean[] __src, int __srcOff,
  61                 boolean[] __dest, int __destOff, int __len);
  62
  63         /**
  64          * Copies the given arrays. If the source and destination are the same
  65          * array, the copy operation will not collide with itself.
  66          *
  67          * @param __src The source array.
  68          * @param __srcOff The source offset.
  69          * @param __dest The destination array.
  70          * @param __destOff The destination offset.
  71          * @param __len The elements to copy.
  72          * @since 2020/06/22
  73          */
  74         @SquirrelJMEVendorApi
  75         public static native void arrayCopy(byte[] __src, int __srcOff,
  76                 byte[] __dest, int __destOff, int __len);
  77
  78         /**
  79          * Copies the given arrays. If the source and destination are the same
  80          * array, the copy operation will not collide with itself.
  81          *
  82          * @param __src The source array.
  83          * @param __srcOff The source offset.
  84          * @param __dest The destination array.
  85          * @param __destOff The destination offset.
  86          * @param __len The elements to copy.
  87          * @since 2020/06/22
  88          */
  89         @SquirrelJMEVendorApi
  90         public static native void arrayCopy(short[] __src, int __srcOff,
  91                 short[] __dest, int __destOff, int __len);
  92
  93         /**
  94          * Copies the given arrays. If the source and destination are the same
  95          * array, the copy operation will not collide with itself.
  96          *
  97          * @param __src The source array.
  98          * @param __srcOff The source offset.
  99          * @param __dest The destination array.
 100          * @param __destOff The destination offset.
 101          * @param __len The elements to copy.
 102          * @since 2020/06/22
 103          */
 104         @SquirrelJMEVendorApi
 105         public static native void arrayCopy(char[] __src, int __srcOff,
 106                 char[] __dest, int __destOff, int __len);
 107
 108         /**
 109          * Copies the given arrays. If the source and destination are the same
 110          * array, the copy operation will not collide with itself.
 111          *
 112          * @param __src The source array.
 113          * @param __srcOff The source offset.
 114          * @param __dest The destination array.
 115          * @param __destOff The destination offset.
 116          * @param __len The elements to copy.
 117          * @since 2020/06/22
 118          */
 119         @SquirrelJMEVendorApi
 120         public static native void arrayCopy(int[] __src, int __srcOff,
 121                 int[] __dest, int __destOff, int __len);
 122
 123         /**
 124          * Copies the given arrays. If the source and destination are the same
 125          * array, the copy operation will not collide with itself.
 126          *
 127          * @param __src The source array.
 128          * @param __srcOff The source offset.
 129          * @param __dest The destination array.
 130          * @param __destOff The destination offset.
 131          * @param __len The elements to copy.
 132          * @since 2020/06/22
 133          */
 134         @SquirrelJMEVendorApi
 135         public static native void arrayCopy(long[] __src, int __srcOff,
 136                 long[] __dest, int __destOff, int __len);
 137
 138         /**
 139          * Copies the given arrays. If the source and destination are the same
 140          * array, the copy operation will not collide with itself.
 141          *
 142          * @param __src The source array.
 143          * @param __srcOff The source offset.
 144          * @param __dest The destination array.
 145          * @param __destOff The destination offset.
 146          * @param __len The elements to copy.
 147          * @since 2020/06/22
 148          */
 149         @SquirrelJMEVendorApi
 150         public static native void arrayCopy(float[] __src, int __srcOff,
 151                 float[] __dest, int __destOff, int __len);
 152
 153         /**
 154          * Copies the given arrays. If the source and destination are the same
 155          * array, the copy operation will not collide with itself.
 156          *
 157          * @param __src The source array.
 158          * @param __srcOff The source offset.
 159          * @param __dest The destination array.
 160          * @param __destOff The destination offset.
 161          * @param __len The elements to copy.
 162          * @since 2020/06/22
 163          */
 164         @SquirrelJMEVendorApi
 165         public static native void arrayCopy(double[] __src, int __srcOff,
 166                 double[] __dest, int __destOff, int __len);
 167
 168         /**
 169          * Fills part of the given array with the specified value.
 170          *
 171          * @param __b The buffer to fill.
 172          * @param __o The offset into the buffer.
 173          * @param __l The length of the bytes to fill.
 174          * @param __v The value to store into the buffer.
 175          * @throws MLECallError If any argument is {@code null}, or the offset
 176          * and/or length exceed the array bounds.
 177          * @since 2021/12/26
 178          */
 179         @SquirrelJMEVendorApi
 180         public static native void arrayFill(boolean[] __b, int __o, int __l,
 181                 boolean __v)
 182                 throws MLECallError;
 183
 184         /**
 185          * Fills part of the given array with the specified value.
 186          *
 187          * @param __b The buffer to fill.
 188          * @param __o The offset into the buffer.
 189          * @param __l The length of the bytes to fill.
 190          * @param __v The value to store into the buffer.
 191          * @throws MLECallError If any argument is {@code null}, or the offset
 192          * and/or length exceed the array bounds.
 193          * @since 2021/12/26
 194          */
 195         @SquirrelJMEVendorApi
 196         public static native void arrayFill(byte[] __b, int __o, int __l,
 197                 byte __v)
 198                 throws MLECallError;
 199
 200         /**
 201          * Fills part of the given array with the specified value.
 202          *
 203          * @param __b The buffer to fill.
 204          * @param __o The offset into the buffer.
 205          * @param __l The length of the bytes to fill.
 206          * @param __v The value to store into the buffer.
 207          * @throws MLECallError If any argument is {@code null}, or the offset
 208          * and/or length exceed the array bounds.
 209          * @since 2021/12/26
 210          */
 211         @SquirrelJMEVendorApi
 212         public static native void arrayFill(short[] __b, int __o, int __l,
 213                 short __v)
 214                 throws MLECallError;
 215
 216         /**
 217          * Fills part of the given array with the specified value.
 218          *
 219          * @param __b The buffer to fill.
 220          * @param __o The offset into the buffer.
 221          * @param __l The length of the bytes to fill.
 222          * @param __v The value to store into the buffer.
 223          * @throws MLECallError If any argument is {@code null}, or the offset
 224          * and/or length exceed the array bounds.
 225          * @since 2021/12/26
 226          */
 227         @SquirrelJMEVendorApi
 228         public static native void arrayFill(char[] __b, int __o, int __l,
 229                 char __v)
 230                 throws MLECallError;
 231
 232         /**
 233          * Fills part of the given array with the specified value.
 234          *
 235          * @param __b The buffer to fill.
 236          * @param __o The offset into the buffer.
 237          * @param __l The length of the bytes to fill.
 238          * @param __v The value to store into the buffer.
 239          * @throws MLECallError If any argument is {@code null}, or the offset
 240          * and/or length exceed the array bounds.
 241          * @since 2021/12/26
 242          */
 243         @SquirrelJMEVendorApi
 244         public static native void arrayFill(int[] __b, int __o, int __l,
 245                 int __v)
 246                 throws MLECallError;
 247
 248         /**
 249          * Fills part of the given array with the specified value.
 250          *
 251          * @param __b The buffer to fill.
 252          * @param __o The offset into the buffer.
 253          * @param __l The length of the bytes to fill.
 254          * @param __v The value to store into the buffer.
 255          * @throws MLECallError If any argument is {@code null}, or the offset
 256          * and/or length exceed the array bounds.
 257          * @since 2021/12/26
 258          */
 259         @SquirrelJMEVendorApi
 260         public static native void arrayFill(long[] __b, int __o, int __l,
 261                 long __v)
 262                 throws MLECallError;
 263
 264         /**
 265          * Fills part of the given array with the specified value.
 266          *
 267          * @param __b The buffer to fill.
 268          * @param __o The offset into the buffer.
 269          * @param __l The length of the bytes to fill.
 270          * @param __v The value to store into the buffer.
 271          * @throws MLECallError If any argument is {@code null}, or the offset
 272          * and/or length exceed the array bounds.
 273          * @since 2021/12/26
 274          */
 275         @SquirrelJMEVendorApi
 276         public static native void arrayFill(float[] __b, int __o, int __l,
 277                 float __v)
 278                 throws MLECallError;
 279
 280         /**
 281          * Fills part of the given array with the specified value.
 282          *
 283          * @param __b The buffer to fill.
 284          * @param __o The offset into the buffer.
 285          * @param __l The length of the bytes to fill.
 286          * @param __v The value to store into the buffer.
 287          * @throws MLECallError If any argument is {@code null}, or the offset
 288          * and/or length exceed the array bounds.
 289          * @since 2021/12/26
 290          */
 291         @SquirrelJMEVendorApi
 292         public static native void arrayFill(double[] __b, int __o, int __l,
 293                 double __v)
 294                 throws MLECallError;
 295
 296         /**
 297          * Returns the length of the array if this object is an array.
 298          *
 299          * @param __object The object to get the length of.
 300          * @return The length of the array or a negative value if this is not an
 301          * array.
 302          * @since 2020/06/09
 303          */
 304         @SquirrelJMEVendorApi
 305         public static native int arrayLength(Object __object);
 306
 307         /**
 308          * Allocates a new array.
 309          *
 310          * @param <T> The resultant type of the array.
 311          * @param __type The type to allocate the array for.
 312          * @param __len The length of the array.
 313          * @return The newly allocated array as the given object.
 314          * @since 2020/06/09
 315          */
 316         @SquirrelJMEVendorApi
 317         public static native <T> T arrayNew(TypeBracket __type, int __len);
 318
 319         /**
 320          * Checks if the given thread holds the lock on the given method.
 321          *
 322          * @param __javaThread The Java thread to check if it holds the lock.
 323          * @param __o The object to check.
 324          * @return If the given thread holds the lock.
 325          * @since 2020/06/17
 326          */
 327         @SquirrelJMEVendorApi
 328         public static native boolean holdsLock(Thread __javaThread, Object __o);
 329
 330         /**
 331          * Returns the identity hashcode of the object.
 332          *
 333          * @param __o The object to get the hashcode of.
 334          * @return The identity hashcode of the object.
 335          * @since 2020/06/18
 336          */
 337         @SquirrelJMEVendorApi
 338         public static native int identityHashCode(Object __o);
 339
 340         /**
 341          * Checks if this object is an array.
 342          *
 343          * @param __object The object to check.
 344          * @return If this object is an array.
 345          * @since 2021/04/07
 346          */
 347         @SquirrelJMEVendorApi
 348         public static native boolean isArray(Object __object);
 349
 350         /**
 351          * Checks if this object is an instance of the given type.
 352          *
 353          * @param __o The object to check.
 354          * @param __type The type it may be.
 355          * @return If this object is an instance of the given type.
 356          * @throws MLECallError If {@code __type} is null.
 357          * @since 2021/02/07
 358          */
 359         @SquirrelJMEVendorApi
 360         public static native boolean isInstance(Object __o, TypeBracket __type)
 361                 throws MLECallError;
 362
 363         /**
 364          * Creates a new instance of the given type.
 365          *
 366          * @param __type The type to instantiate.
 367          * @return The newly created object or {@code null} if there was no
 368          * memory left.
 369          * @since 2020/06/17
 370          */
 371         @SquirrelJMEVendorApi
 372         public static native Object newInstance(TypeBracket __type);
 373
 374         /**
 375          * Notifies the monitors holding onto this object.
 376          *
 377          * @param __object The object to signal.
 378          * @param __all Notify all threads?
 379          * @return The {@link MonitorResultType}.
 380          * @since 2020/06/22
 381          */
 382         @SquirrelJMEVendorApi
 383         public static native int notify(Object __object, boolean __all);
 384
 385         /**
 386          * Waits on the given monitor.
 387          *
 388          * If the monitor will block and SquirrelJME is running in cooperative
 389          * single threaded mode, this will relinquish control of the current
 390          * thread.
 391          *
 392          * @param __object The object to wait on.
 393          * @param __ms The milliseconds to wait.
 394          * @param __ns The nanoseconds to wait.
 395          * @return The {@link MonitorResultType}.
 396          * @since 2020/06/22
 397          */
 398         @SquirrelJMEVendorApi
 399         public static native int wait(Object __object, long __ms, int __ns);
 400 }