jruby · Apr 10, 2015 · Apr 10, 2015 · Apr 10, 2015 · Apr 10, 2015 · Apr 10, 2015
diff --git a/core/src/main/java/org/jruby/RubyArray.java b/core/src/main/java/org/jruby/RubyArray.java
@@ -39,7 +39,6 @@
 
 import org.jcodings.Encoding;
 import org.jcodings.specific.USASCIIEncoding;
-import org.jcodings.specific.UTF16BEEncoding;
 import org.jcodings.specific.UTF8Encoding;
 import org.jruby.anno.JRubyClass;
 import org.jruby.anno.JRubyMethod;
@@ -59,12 +58,11 @@
 import org.jruby.runtime.marshal.MarshalStream;
 import org.jruby.runtime.marshal.UnmarshalStream;
 import org.jruby.truffle.pack.runtime.*;
+import org.jruby.truffle.pack.runtime.exceptions.*;
 import org.jruby.util.ByteList;
 import org.jruby.util.Pack;
-import org.jruby.util.PerlHash;
 import org.jruby.util.Qsort;
 import org.jruby.util.RecursiveComparator;
-import org.jruby.util.SipHashInline;
 import org.jruby.util.TypeConverter;
 import org.jruby.util.cli.Options;
 
@@ -77,7 +75,6 @@
 import static org.jruby.RubyEnumerator.enumeratorize;
 import static org.jruby.RubyEnumerator.enumeratorizeWithSize;
 import static org.jruby.runtime.Helpers.invokedynamic;
-import static org.jruby.runtime.Helpers.memchr;
 import static org.jruby.runtime.Visibility.PRIVATE;
 import static org.jruby.runtime.invokedynamic.MethodNames.HASH;
 import static org.jruby.runtime.invokedynamic.MethodNames.OP_CMP;
@@ -4108,6 +4105,8 @@ public RubyString pack(ThreadContext context, IRubyObject obj) {
                     throw context.getRuntime().newArgumentError(e.getMessage());
                 }
 
+                // TODO CS 10-Apr-15 how do we limit the size of the cache
+
                 // We can race on this, but it doesn't matter as long as something goes in the cache
                 trufflePackerCache.put(iFmt.getByteList().dup(), packer);
             }
@@ -4151,7 +4150,7 @@ public RubyString pack(ThreadContext context, IRubyObject obj) {
                 }
             }
 
-            if (result.isTainted()) {
+            if (result.isTainted() || iFmt.isTaint()) {
                 string.taint(context.getRuntime());
             }
 

diff --git a/core/src/main/java/org/jruby/TrufflePackBridge.java b/core/src/main/java/org/jruby/TrufflePackBridge.java
@@ -12,10 +12,30 @@
 import org.jruby.runtime.builtin.IRubyObject;
 import org.jruby.truffle.pack.runtime.PackResult;
 
+/**
+ * Interface to the Truffle implementation of pack. The implementation is in
+ * the {@code truffle} package, so is only available if the {@code truffle.jar}
+ * is available on the classpath.
+ * <p>
+ * To instantiate the implementation, use reflection to look for
+ * {@code org.jruby.truffle.pack.TrufflePackBridgeImpl}.
+ * <p>
+ * Using the Truffle implementation only makes sense on a JVM that has the
+ * Graal compiler.
+ */
 public interface TrufflePackBridge {
 
+    /**
+     * Compile a format expression into code that can apply that expression
+     * to an array.
+     */
     Packer compileFormat(String format);
 
+    /**
+     * Represents a Truffle implementation of a particular pack format
+     * expression. Both interpretation and dynamic compilation implementations
+     * of the format are contained behind this interface.
+     */
     interface Packer {
 
         PackResult pack(IRubyObject[] objects, int size);

diff --git a/core/src/main/java/org/jruby/truffle/pack/runtime/PackEncoding.java b/core/src/main/java/org/jruby/truffle/pack/runtime/PackEncoding.java
@@ -1,11 +1,31 @@
+/*
+ * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved. This
+ * code is released under a tri EPL/GPL/LGPL license. You can use it,
+ * redistribute it and/or modify it under the terms of the:
+ *
+ * Eclipse Public License version 1.0
+ * GNU General Public License version 2
+ * GNU Lesser General Public License version 2.1
+ */
 package org.jruby.truffle.pack.runtime;
 
+/**
+ * The encoding to be used for the string resulting from pack.
+ * <p>
+ * We use this enum as the range of encodings possible are very limited and
+ * we want to abstracted between JRuby's pack and Truffle's pack.
+ */
 public enum PackEncoding {
     DEFAULT,
     ASCII_8BIT,
     US_ASCII,
     UTF_8;
 
+    /**
+     * Given the current encoding for a pack string, and something that requires
+     * another encoding, give us the encoding that we should use for the result
+     * of pack.
+     */
     public PackEncoding unifyWith(PackEncoding other) {
         if (this == DEFAULT) {
             return other;

diff --git a/core/src/main/java/org/jruby/truffle/pack/runtime/PackResult.java b/core/src/main/java/org/jruby/truffle/pack/runtime/PackResult.java
@@ -1,3 +1,12 @@
+/*
+ * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved. This
+ * code is released under a tri EPL/GPL/LGPL license. You can use it,
+ * redistribute it and/or modify it under the terms of the:
+ *
+ * Eclipse Public License version 1.0
+ * GNU General Public License version 2
+ * GNU Lesser General Public License version 2.1
+ */
 package org.jruby.truffle.pack.runtime;
 
 public class PackResult {

diff --git a/...untime/CantCompressNegativeException.java → ...ptions/CantCompressNegativeException.java b/...untime/CantCompressNegativeException.java → ...ptions/CantCompressNegativeException.java
@@ -7,7 +7,7 @@
  * GNU General Public License version 2
  * GNU Lesser General Public License version 2.1
  */
-package org.jruby.truffle.pack.runtime;
+package org.jruby.truffle.pack.runtime.exceptions;
 
 public class CantCompressNegativeException extends RuntimeException {
 

diff --git a/...le/pack/runtime/CantConvertException.java → ...time/exceptions/CantConvertException.java b/...le/pack/runtime/CantConvertException.java → ...time/exceptions/CantConvertException.java
@@ -7,7 +7,7 @@
  * GNU General Public License version 2
  * GNU Lesser General Public License version 2.1
  */
-package org.jruby.truffle.pack.runtime;
+package org.jruby.truffle.pack.runtime.exceptions;
 
 public class CantConvertException extends RuntimeException {
 

diff --git a/...truffle/pack/runtime/FormatException.java → ...k/runtime/exceptions/FormatException.java b/...truffle/pack/runtime/FormatException.java → ...k/runtime/exceptions/FormatException.java
@@ -7,7 +7,7 @@
  * GNU General Public License version 2
  * GNU Lesser General Public License version 2.1
  */
-package org.jruby.truffle.pack.runtime;
+package org.jruby.truffle.pack.runtime.exceptions;
 
 public class FormatException extends RuntimeException {
 

diff --git a/...untime/NoImplicitConversionException.java → ...ptions/NoImplicitConversionException.java b/...untime/NoImplicitConversionException.java → ...ptions/NoImplicitConversionException.java
@@ -7,7 +7,7 @@
  * GNU General Public License version 2
  * GNU Lesser General Public License version 2.1
  */
-package org.jruby.truffle.pack.runtime;
+package org.jruby.truffle.pack.runtime.exceptions;
 
 public class NoImplicitConversionException extends RuntimeException {
 

diff --git a/...ack/runtime/OutsideOfStringException.java → .../exceptions/OutsideOfStringException.java b/...ack/runtime/OutsideOfStringException.java → .../exceptions/OutsideOfStringException.java
@@ -7,7 +7,7 @@
  * GNU General Public License version 2
  * GNU Lesser General Public License version 2.1
  */
-package org.jruby.truffle.pack.runtime;
+package org.jruby.truffle.pack.runtime.exceptions;
 
 public class OutsideOfStringException extends RuntimeException {
 }
diff --git a/.../truffle/pack/runtime/RangeException.java → ...ck/runtime/exceptions/RangeException.java b/.../truffle/pack/runtime/RangeException.java → ...ck/runtime/exceptions/RangeException.java
@@ -7,7 +7,7 @@
  * GNU General Public License version 2
  * GNU Lesser General Public License version 2.1
  */
-package org.jruby.truffle.pack.runtime;
+package org.jruby.truffle.pack.runtime.exceptions;
 
 public class RangeException extends RuntimeException {
 

diff --git a/...ack/runtime/TooFewArgumentsException.java → .../exceptions/TooFewArgumentsException.java b/...ack/runtime/TooFewArgumentsException.java → .../exceptions/TooFewArgumentsException.java
@@ -7,7 +7,7 @@
  * GNU General Public License version 2
  * GNU Lesser General Public License version 2.1
  */
-package org.jruby.truffle.pack.runtime;
+package org.jruby.truffle.pack.runtime.exceptions;
 
 public class TooFewArgumentsException extends RuntimeException {
 }
diff --git a/spec/truffle/tags/core/array/pack/b_tags.txt b/spec/truffle/tags/core/array/pack/b_tags.txt
diff --git a/spec/truffle/tags/core/array/pack/m_tags.txt b/spec/truffle/tags/core/array/pack/m_tags.txt
diff --git a/truffle/src/main/java/org/jruby/truffle/nodes/core/ArrayNodes.java b/truffle/src/main/java/org/jruby/truffle/nodes/core/ArrayNodes.java
@@ -26,7 +26,6 @@
 
 import org.jcodings.specific.USASCIIEncoding;
 import org.jcodings.specific.UTF8Encoding;
-import org.jruby.RubyObject;
 import org.jruby.runtime.Visibility;
 import org.jruby.runtime.builtin.IRubyObject;
 import org.jruby.truffle.nodes.CoreSourceSection;
@@ -47,6 +46,7 @@
 import org.jruby.truffle.nodes.yield.YieldDispatchHeadNode;
 import org.jruby.truffle.pack.parser.PackParser;
 import org.jruby.truffle.pack.runtime.*;
+import org.jruby.truffle.pack.runtime.exceptions.*;
 import org.jruby.truffle.runtime.*;
 import org.jruby.truffle.runtime.control.BreakException;
 import org.jruby.truffle.runtime.control.NextException;
@@ -61,7 +61,6 @@
 import org.jruby.util.Memo;
 
 import java.util.Arrays;
-import java.util.Comparator;
 
 @CoreClass(name = "Array")
 public abstract class ArrayNodes {

diff --git a/truffle/src/main/java/org/jruby/truffle/pack/TrufflePackBridgeImpl.java b/truffle/src/main/java/org/jruby/truffle/pack/TrufflePackBridgeImpl.java
@@ -1,3 +1,12 @@
+/*
+ * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved. This
+ * code is released under a tri EPL/GPL/LGPL license. You can use it,
+ * redistribute it and/or modify it under the terms of the:
+ *
+ * Eclipse Public License version 1.0
+ * GNU General Public License version 2
+ * GNU Lesser General Public License version 2.1
+ */
 package org.jruby.truffle.pack;
 
 import com.oracle.truffle.api.CallTarget;
@@ -6,6 +15,12 @@
 import org.jruby.truffle.pack.parser.PackParser;
 import org.jruby.truffle.pack.runtime.PackResult;
 
+/**
+ * The implementation of the interface from the {@code core} package.
+ * <p>
+ * Instantiated by {@code core} using reflection, as there is normally no
+ * dependency on {@code truffle} from {@code core}.
+ */
 public class TrufflePackBridgeImpl implements TrufflePackBridge {
 
     @Override

diff --git a/truffle/src/main/java/org/jruby/truffle/pack/nodes/PackGuards.java b/truffle/src/main/java/org/jruby/truffle/pack/nodes/PackGuards.java
@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved. This
+ * code is released under a tri EPL/GPL/LGPL license. You can use it,
+ * redistribute it and/or modify it under the terms of the:
+ *
+ * Eclipse Public License version 1.0
+ * GNU General Public License version 2
+ * GNU Lesser General Public License version 2.1
+ */
+package org.jruby.truffle.pack.nodes;
+
+import org.jruby.runtime.builtin.IRubyObject;
+import org.jruby.truffle.runtime.core.RubyArray;
+import org.jruby.truffle.runtime.core.RubyBignum;
+import org.jruby.truffle.runtime.core.RubyString;
+
+import java.math.BigInteger;
+
+public class PackGuards {
+
+    public static boolean isNull(Object object) {
+        return object == null;
+    }
+
+    public static boolean isRubyNilClass(Object object) {
+        return object instanceof RubyString;
+    }
+
+    public static boolean isBoolean(Object object) {
+        return object instanceof Boolean;
+    }
+
+    public static boolean isInteger(Object object) {
+        return object instanceof Integer;
+    }
+
+    public static boolean isLong(Object object) {
+        return object instanceof Long;
+    }
+
+    public static boolean isBigInteger(Object object) {
+        return object instanceof BigInteger;
+    }
+
+    public static boolean isRubyBignum(Object object) {
+        return object instanceof RubyBignum;
+    }
+
+    public static boolean isRubyString(Object object) {
+        return object instanceof RubyString;
+    }
+
+    public static boolean isRubyArray(Object object) {
+        return object instanceof RubyArray;
+    }
+
+    public static boolean isIRubyArray(Object[] array) {
+        return array instanceof IRubyObject[];
+    }
+
+}