Util.java

  1. /***** BEGIN LICENSE BLOCK *****
  2.  * Version: EPL 1.0/GPL 2.0/LGPL 2.1
  3.  *
  4.  * The contents of this file are subject to the Eclipse Public
  5.  * License Version 1.0 (the "License"); you may not use this file
  6.  * except in compliance with the License. You may obtain a copy of
  7.  * the License at http://www.eclipse.org/legal/epl-v10.html
  8.  *
  9.  * Software distributed under the License is distributed on an "AS
  10.  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  11.  * implied. See the License for the specific language governing
  12.  * rights and limitations under the License.
  13.  *
  14.  * Copyright (C) 2008 JRuby project
  15.  *
  16.  * Alternatively, the contents of this file may be used under the terms of
  17.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  18.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  19.  * in which case the provisions of the GPL or the LGPL are applicable instead
  20.  * of those above. If you wish to allow use of your version of this file only
  21.  * under the terms of either the GPL or the LGPL, and not to allow others to
  22.  * use your version of this file under the terms of the EPL, indicate your
  23.  * decision by deleting the provisions above and replace them with the notice
  24.  * and other provisions required by the GPL or the LGPL. If you do not delete
  25.  * the provisions above, a recipient may use your version of this file under
  26.  * the terms of any one of the EPL, the GPL or the LGPL.
  27.  ***** END LICENSE BLOCK *****/

  29. package org.jruby.ext.ffi;

  31. import java.math.BigInteger;
  32. import java.nio.ByteBuffer;
  33. import java.nio.ByteOrder;
  34. import org.jruby.Ruby;
  35. import org.jruby.RubyBignum;
  36. import org.jruby.RubyHash;
  37. import org.jruby.RubyInteger;
  38. import org.jruby.RubyNumeric;
  39. import org.jruby.RubyString;
  40. import org.jruby.RubySymbol;
  41. import org.jruby.javasupport.JavaObject;
  42. import org.jruby.runtime.ThreadContext;
  43. import org.jruby.runtime.builtin.IRubyObject;

  45. /**
  46.  *
  47.  */
  48. public final class Util {
  49.     private Util() {}
  50.     public static final byte int8Value(IRubyObject parameter) {
  51.         return (byte) longValue(parameter);
  52.     }

  54.     public static final short uint8Value(IRubyObject parameter) {
  55.         return (short) longValue(parameter);
  56.     }

  58.     public static final short int16Value(IRubyObject parameter) {
  59.         return (short) longValue(parameter);
  60.     }
  61.     
  62.     public static final int uint16Value(IRubyObject parameter) {
  63.         return (int) longValue(parameter);
  64.     }

  66.     public static final int int32Value(IRubyObject parameter) {
  67.         return (int) longValue(parameter);
  68.     }

  70.     public static final long uint32Value(IRubyObject parameter) {
  71.         return longValue(parameter);
  72.     }

  74.     public static final long int64Value(IRubyObject parameter) {
  75.         return longValue(parameter);
  76.     }

  78.     public static final long uint64Value(IRubyObject parameter) {
  79.         final long value = parameter instanceof RubyBignum
  80.                 ? ((RubyBignum) parameter).getValue().longValue()
  81.                 :longValue(parameter);
  82.         return value;
  83.     }

  85.     public static final float floatValue(IRubyObject parameter) {
  86.         return (float) RubyNumeric.num2dbl(parameter);
  87.     }

  89.     public static final double doubleValue(IRubyObject parameter) {
  90.         return RubyNumeric.num2dbl(parameter);
  91.     }

  93.     /**
  94.      * Converts characters like 'a' or 't' to an integer value
  95.      *
  96.      * @param parameter
  97.      * @return
  98.      */
  99.     public static final long longValue(IRubyObject parameter) {
  100.         return RubyNumeric.num2long(parameter);
  101.     }

  103.     public static int intValue(IRubyObject obj, RubyHash enums) {
  104.         if (obj instanceof RubyInteger) {
  105.                 return (int) ((RubyInteger) obj).getLongValue();

  107.         } else if (obj instanceof RubySymbol) {
  108.             IRubyObject value = enums.fastARef(obj);
  109.             if (value.isNil()) {
  110.                 throw obj.getRuntime().newArgumentError("invalid enum value, " + obj.inspect());
  111.             }
  112.             return (int) longValue(value);
  113.         } else {
  114.             return (int) longValue(obj);
  115.         }
  116.     }

  118.     public static final IRubyObject newSigned8(Ruby runtime, byte value) {
  119.         return runtime.newFixnum(value);
  120.     }

  122.     public static final IRubyObject newUnsigned8(Ruby runtime, byte value) {
  123.         return runtime.newFixnum(value < 0 ? (long)((value & 0x7FL) + 0x80L) : value);
  124.     }

  126.     public static final IRubyObject newSigned16(Ruby runtime, short value) {
  127.         return runtime.newFixnum(value);
  128.     }

  130.     public static final IRubyObject newUnsigned16(Ruby runtime, short value) {
  131.         return runtime.newFixnum(value < 0 ? (long)((value & 0x7FFFL) + 0x8000L) : value);
  132.     }

  134.     public static final IRubyObject newSigned32(Ruby runtime, int value) {
  135.         return runtime.newFixnum(value);
  136.     }

  138.     public static final IRubyObject newUnsigned32(Ruby runtime, int value) {
  139.         return runtime.newFixnum(value < 0 ? (long)((value & 0x7FFFFFFFL) + 0x80000000L) : value);
  140.     }

  142.     public static final IRubyObject newSigned64(Ruby runtime, long value) {
  143.         return runtime.newFixnum(value);
  144.     }

  146.     private static final BigInteger UINT64_BASE = BigInteger.valueOf(Long.MAX_VALUE).add(BigInteger.ONE);
  147.     public static final IRubyObject newUnsigned64(Ruby runtime, long value) {
  148.         return value < 0
  149.                     ? RubyBignum.newBignum(runtime, BigInteger.valueOf(value & 0x7fffffffffffffffL).add(UINT64_BASE))
  150.                     : runtime.newFixnum(value);
  151.     }

  153.     @Deprecated
  154.     public static final <T> T convertParameter(IRubyObject parameter, Class<T> paramClass) {
  155.         return paramClass.cast(parameter instanceof JavaObject
  156.             ? ((JavaObject) parameter).getValue()
  157.             : parameter.toJava(paramClass));
  158.     }

  160.     public static final ByteBuffer slice(ByteBuffer buf, int offset) {
  161.         ByteBuffer tmp = buf.duplicate();
  162.         tmp.position((int) offset);
  163.         return tmp.slice();
  164.     }

  166.     public static final void checkBounds(Ruby runtime, long size, long off, long len) {
  167.         if ((off | len | (off + len) | (size - (off + len))) < 0) {
  168.             throw runtime.newIndexError("Memory access offset="
  169.                     + off + " size=" + len + " is out of bounds");
  170.         }
  171.     }

  173.     public static Type findType(ThreadContext context, IRubyObject name) {
  174.         return context.runtime.getFFI().getTypeResolver().findType(context.runtime, name);
  175.     }

  177.     public static Type findType(ThreadContext context, IRubyObject name, IRubyObject typeMap) {
  178.         return context.runtime.getFFI().getTypeResolver().findType(context.runtime, name, typeMap);
  179.     }

  181.     public static ByteOrder parseByteOrder(Ruby runtime, IRubyObject byte_order) {
  182.         if (byte_order instanceof RubySymbol || byte_order instanceof RubyString) {
  183.             String orderName = byte_order.asJavaString();
  184.             if ("network".equals(orderName) || "big".equals(orderName)) {
  185.                 return ByteOrder.BIG_ENDIAN;

  187.             } else if ("little".equals(orderName)) {
  188.                 return ByteOrder.LITTLE_ENDIAN;
  189.             
  190.             } else {
  191.                 return ByteOrder.nativeOrder();
  192.             }

  194.         } else {
  195.             throw runtime.newTypeError(byte_order, runtime.getSymbol());
  196.         }
  197.     }

  199.     public static int roundUpToPowerOfTwo(int v) {
  200.         if (v < 1) return 1;
  201.         v--;
  202.         v |= v >> 1;
  203.         v |= v >> 2;
  204.         v |= v >> 4;
  205.         v |= v >> 8;
  206.         v |= v >> 16;

  208.         return v + 1;
  209.     }
  210. }
Created with JaCoCo 0.7.3.201501050207