Split Rope#toString between a safe and unsafe version

Author: chrisseaton

src/main/java/org/truffleruby/core/rope/ManagedRope.java

@@ -54,16 +54,4 @@ public final byte[] getBytes() {
         return bytes;
     }
 
-    @Override
-    public final String toString() {
-        if (DEBUG_ROPE_BYTES) {
-            final byte[] bytesBefore = bytes;
-            final String string = RopeOperations.decodeOrEscapeBinaryRope(this, RopeOperations.flattenBytes(this));
-            assert bytes == bytesBefore : "bytes should not be modified by Rope#toString() as otherwise inspecting a Rope would have a side effect";
-            return string;
-        } else {
-            return RopeOperations.decodeRope(this);
-        }
-    }
-
 }

src/main/java/org/truffleruby/core/rope/NativeRope.java

@@ -183,11 +183,6 @@ public int hashCode() {
         return RopeOperations.hashForRange(this, 1, 0, byteLength());
     }
 
-    @Override
-    public String toString() {
-        return toLeafRope().toString();
-    }
-
     @Override
     Rope withEncoding7bit(Encoding newEncoding, ConditionProfile bytesNotNull) {
         return withEncoding(newEncoding);

src/main/java/org/truffleruby/core/rope/Rope.java

@@ -21,9 +21,6 @@ public abstract class Rope implements Comparable<Rope> {
     // NativeRope, RepeatingRope, 3 LeafRope, ConcatRope, SubstringRope, 1 LazyRope
     public static final int NUMBER_OF_CONCRETE_CLASSES = 8;
 
-    // Useful for debugging. Setting to true avoids ManagedRope#toString to populate bytes as a side-effect of the debugger calling toString().
-    protected static final boolean DEBUG_ROPE_BYTES = false;
-
     public final Encoding encoding;
     private final int byteLength;
     private int hashCode = 0;
@@ -161,8 +158,15 @@ public byte get(int index) {
         return getByteSlow(index);
     }
 
+    @Override
+    public String toString() {
+        // This is designed to not have any side effects - compare to getString
+        return RopeOperations.decode(encoding, RopeOperations.flattenBytes(this));
+    }
+
     /** Should only be used by the parser */
-    public final String getString() {
+    public final String normaliseAndGetJavaString() {
+        // This will have side effects such as flattening a ConcatString
         return RopeOperations.decodeRope(this);
     }
 

src/main/java/org/truffleruby/core/rope/RopeCache.java

@@ -54,7 +54,7 @@ private void register(LeafRope rope) {
         final BytesKey key = new BytesKey(rope.getBytes(), rope.getEncoding());
         final Rope existing = bytesToRope.put(key, rope);
         if (existing != null && existing != rope) {
-            throw new AssertionError("Duplicate Rope in RopeCache: " + existing.getString());
+            throw new AssertionError("Duplicate Rope in RopeCache: " + existing);
         }
     }
 

src/main/java/org/truffleruby/core/rope/RopeConstants.java

@@ -112,7 +112,7 @@ private static Rope ascii(String string) {
             final LeafRope rope = new AsciiOnlyLeafRope(bytes, USASCIIEncoding.INSTANCE).computeHashCode();
             final Rope existing = ROPE_CONSTANTS.putIfAbsent(string, rope);
             if (existing != null) {
-                throw new AssertionError("Duplicate Rope in RopeConstants: " + existing.getString());
+                throw new AssertionError("Duplicate Rope in RopeConstants: " + existing);
             }
             return rope;
         }

src/main/java/org/truffleruby/parser/ast/ClassVarAsgnParseNode.java

@@ -47,7 +47,7 @@ public class ClassVarAsgnParseNode extends AssignableParseNode implements INameN
     public ClassVarAsgnParseNode(SourceIndexLength position, Rope name, ParseNode valueNode) {
         super(position, valueNode);
 
-        this.name = name.getString();
+        this.name = name.normaliseAndGetJavaString();
     }
 
     @Override

src/main/java/org/truffleruby/parser/ast/ClassVarParseNode.java

@@ -43,7 +43,7 @@ public class ClassVarParseNode extends ParseNode implements INameNode, SideEffec
     private String name;
 
     public ClassVarParseNode(SourceIndexLength position, Rope name) {
-        this(position, name.getString());
+        this(position, name.normaliseAndGetJavaString());
     }
 
     public ClassVarParseNode(SourceIndexLength position, String name) {

src/main/java/org/truffleruby/parser/ast/Colon3ParseNode.java

@@ -45,7 +45,7 @@ public class Colon3ParseNode extends ParseNode implements INameNode {
 
     public Colon3ParseNode(SourceIndexLength position, Rope name) {
         super(position);
-        this.name = name.getString();
+        this.name = name.normaliseAndGetJavaString();
     }
 
     @Override

src/main/java/org/truffleruby/parser/ast/ConstDeclParseNode.java

@@ -48,7 +48,7 @@ public ConstDeclParseNode(SourceIndexLength position, Rope name, INameNode const
         super(position, valueNode);
 
         assert constNode != null || (name != null && !name.isEmpty());
-        this.name = name == null ? null : name.getString();
+        this.name = name == null ? null : name.normaliseAndGetJavaString();
         this.constNode = constNode;
     }
 

src/main/java/org/truffleruby/parser/ast/ConstParseNode.java

@@ -43,7 +43,7 @@ public class ConstParseNode extends ParseNode implements INameNode {
     private String name;
 
     public ConstParseNode(SourceIndexLength position, Rope name) {
-        this(position, name.getString());
+        this(position, name.normaliseAndGetJavaString());
     }
 
     public ConstParseNode(SourceIndexLength position, String name) {