[Java] toString generation for debugging purpose

xdaragon · xdaragon · commit 49d7a42f9978 · 2016-07-06T11:07:19.000+02:00
Change-Id: I3b45eb18c24ddbc3d6b4c278b38e677d4f6245ed
diff --git a/sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/java/JavaGenerator.java b/sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/java/JavaGenerator.java
@@ -213,6 +213,9 @@ private void generateEncoder(
             out.append(sb);
 
             out.append(generateEncoderVarData(className, varData, indent));
+
+            out.append(generateEncoderDisplay(formatClassName(decoderName(msgToken.name())), indent));
+
             out.append("}\n");
         }
     }
@@ -242,6 +245,8 @@ private void generateDecoder(
 
             out.append(generateDecoderVarData(varData, BASE_INDENT));
 
+            out.append(generateDecoderDisplay(msgToken.name(), fields, groups, varData, BASE_INDENT));
+
             out.append("}\n");
         }
     }
@@ -282,6 +287,8 @@ private void generateDecoderGroups(
             i = collectVarData(tokens, i, varData);
             sb.append(generateDecoderVarData(varData, indent + INDENT));
 
+            appendGroupInstanceDecoderDisplay(sb, fields, groups, varData, indent + INDENT);
+
             sb.append(indent).append("    }\n");
         }
     }
@@ -940,6 +947,7 @@ private void generateBitSet(final List<Token> tokens) throws IOException
         {
             generateFixedFlyweightHeader(token, decoderName, out, readOnlyBuffer, fqReadOnlyBuffer, "");
             out.append(generateChoiceDecoders(messageBody));
+            out.append(generateChoiceDisplay(messageBody));
             out.append("}\n");
         }
 
@@ -1022,6 +1030,8 @@ private void generateComposite(final List<Token> tokens) throws IOException
                 }
             }
 
+            out.append(generateCompositeDecoderDisplay(tokens, BASE_INDENT));
+
             out.append("}\n");
         }
 
@@ -1057,6 +1067,8 @@ private void generateComposite(final List<Token> tokens) throws IOException
                 }
             }
 
+            out.append(generateCompositeEncoderDisplay(decoderName, BASE_INDENT));
+
             out.append("}\n");
         }
     }
@@ -2367,4 +2379,275 @@ private String generateChoicePut(
 
         throw new IllegalArgumentException("primitive type not supported: " + type);
     }
+
+    private CharSequence generateEncoderDisplay(String decoderName, String baseIndent)
+    {
+        final String indent = baseIndent + "    ";
+        final StringBuilder sb = new StringBuilder();
+        appendToString(sb, indent);
+        sb.append("\n");
+        addLine(sb, indent, "public StringBuilder appendTo(StringBuilder builder)");
+        addLine(sb, indent, "{");
+        addLine(sb, indent, "    " + decoderName + " writer = new " + decoderName + "();");
+        addLine(sb, indent, "    writer.wrap(buffer, offset, BLOCK_LENGTH, SCHEMA_VERSION);");
+        addLine(sb, indent, "    return writer.appendTo(builder);");
+        addLine(sb, indent, "}");
+        return sb.toString();
+    }
+
+    private CharSequence generateCompositeEncoderDisplay(String decoderName, String baseIndent)
+    {
+        final String indent = baseIndent + "    ";
+        final StringBuilder sb = new StringBuilder();
+        appendToString(sb, indent);
+        sb.append("\n");
+        addLine(sb, indent, "public StringBuilder appendTo(StringBuilder builder)");
+        addLine(sb, indent, "{");
+        addLine(sb, indent, "    " + decoderName + " writer = new " + decoderName + "();");
+        addLine(sb, indent, "    writer.wrap(buffer, offset);");
+        addLine(sb, indent, "    return writer.appendTo(builder);");
+        addLine(sb, indent, "}");
+        return sb.toString();
+    }
+
+    private CharSequence generateCompositeDecoderDisplay(List<Token> tokens, String baseIndent)
+    {
+        final String indent = baseIndent + "    ";
+        final StringBuilder sb = new StringBuilder();
+        appendToString(sb, indent);
+        sb.append("\n");
+        addLine(sb, indent, "public StringBuilder appendTo(StringBuilder builder)");
+        addLine(sb, indent, "{");
+        addLine(sb, indent, "    builder.append(\"[\");");
+        for (int i = 1, end = tokens.size() - 1; i < end; i++)
+        {
+            final Token encodingToken = tokens.get(i);
+            final String propertyName = formatPropertyName(encodingToken.name());
+            writeTokenDisplay(propertyName, encodingToken, sb, indent + "    ");
+            if (encodingToken.signal() == Signal.BEGIN_COMPOSITE)
+            {
+                i = findEndSignal(tokens, i, Signal.END_COMPOSITE, encodingToken.name());
+            }
+        }
+        addLine(sb, indent, "    builder.setLength(builder.length()-1);");
+        addLine(sb, indent, "    builder.append(\"]\");");
+        addLine(sb, indent, "    return builder;");
+        addLine(sb, indent, "}");
+        return sb.toString();
+    }
+
+    private CharSequence generateChoiceDisplay(List<Token> tokens)
+    {
+        final String indent = "    ";
+        final StringBuilder sb = new StringBuilder();
+        appendToString(sb, indent);
+        sb.append("\n");
+        addLine(sb, indent, "public StringBuilder appendTo(StringBuilder builder)");
+        addLine(sb, indent, "{");
+        addLine(sb, indent, "    builder.append('{');");
+        addLine(sb, indent, "    boolean atLeastOne = false;");
+        tokens
+            .stream()
+            .filter((token) -> token.signal() == Signal.CHOICE)
+            .forEach(
+                (token) ->
+                {
+                    final String choiceName = formatPropertyName(token.name());
+                    addLine(sb, indent, "    if(" + choiceName + "())");
+                    addLine(sb, indent, "    {");
+                    addLine(sb, indent, "        if(atLeastOne)");
+                    addLine(sb, indent, "        {");
+                    addLine(sb, indent, "            builder.append(',');");
+                    addLine(sb, indent, "        }");
+                    addLine(sb, indent, "        builder.append(\"" + choiceName + "\");");
+                    addLine(sb, indent, "        atLeastOne = true;");
+                    addLine(sb, indent, "    }");
+                }
+            );
+        addLine(sb, indent, "    builder.append('}');");
+        addLine(sb, indent, "    return builder;");
+        addLine(sb, indent, "}");
+        return sb.toString();
+    }
+
+    private CharSequence generateDecoderDisplay(
+            final String name,
+            final List<Token> tokens,
+            final List<Token> groups,
+            final List<Token> varLens,
+            final String indent) throws IOException
+    {
+        final StringBuilder sb = new StringBuilder();
+        sb.append("\n");
+        appendToString(sb, indent);
+        sb.append("\n");
+        addLine(sb, indent, "public StringBuilder appendTo(StringBuilder builder)");
+        addLine(sb, indent, "{");
+        addLine(sb, indent, "    int realLimit = limit();");
+        addLine(sb, indent, "    limit(offset + actingBlockLength);");
+        addLine(sb, indent, "    builder.append(\"[" + name + "](sbeTemplateId=\");");
+        addLine(sb, indent, "    builder.append(TEMPLATE_ID);");
+        addLine(sb, indent, "    builder.append(\"|sbeSchemaId=\");");
+        addLine(sb, indent, "    builder.append(SCHEMA_ID);");
+        addLine(sb, indent, "    builder.append(\"|sbeSchemaVersion=\");");
+        addLine(sb, indent, "    if (actingVersion != SCHEMA_VERSION)");
+        addLine(sb, indent, "    {");
+        addLine(sb, indent, "        builder.append(actingVersion);");
+        addLine(sb, indent, "        builder.append('/');");
+        addLine(sb, indent, "    }");
+        addLine(sb, indent, "    builder.append(SCHEMA_VERSION);");
+        addLine(sb, indent, "    builder.append(\"|sbeBlockLength=\");");
+        addLine(sb, indent, "    if (actingBlockLength != BLOCK_LENGTH)");
+        addLine(sb, indent, "    {");
+        addLine(sb, indent, "        builder.append(actingBlockLength);");
+        addLine(sb, indent, "        builder.append('/');");
+        addLine(sb, indent, "    }");
+        addLine(sb, indent, "    builder.append(BLOCK_LENGTH);");
+        addLine(sb, indent, "    builder.append(\"):\");");
+        appendDecoderDisplay(sb, tokens, groups, varLens, indent + "    ");
+        addLine(sb, indent, "    limit(realLimit);");
+        addLine(sb, indent, "    return builder;");
+        addLine(sb, indent, "}");
+        return sb.toString();
+    }
+
+    private StringBuilder appendGroupInstanceDecoderDisplay(
+            final StringBuilder sb,
+            final List<Token> tokens,
+            final List<Token> groups,
+            final List<Token> varLens,
+            final String indent)
+    {
+        sb.append("\n");
+        appendToString(sb, indent);
+        sb.append("\n");
+        addLine(sb, indent, "public StringBuilder appendTo(StringBuilder builder)");
+        addLine(sb, indent, "{");
+        appendDecoderDisplay(sb, tokens, groups, varLens, indent + "    ");
+        addLine(sb, indent, "    return builder;");
+        addLine(sb, indent, "}");
+        return sb;
+    }
+
+    private StringBuilder appendDecoderDisplay(
+            final StringBuilder sb,
+            final List<Token> tokens,
+            final List<Token> groups,
+            final List<Token> varLens,
+            final String indent)
+    {
+        eachField(
+            tokens,
+            (fieldToken, typeToken) ->
+            {
+                final String fieldName = formatPropertyName(fieldToken.name());
+                addLine(sb, indent, "//" + fieldToken);
+                writeTokenDisplay(fieldName, typeToken, sb, indent);
+            }
+        );
+        //groups
+        for (int i = 0, size = groups.size(); i < size; i++)
+        {
+            final Token groupToken = groups.get(i);
+            if (groupToken.signal() != Signal.BEGIN_GROUP)
+            {
+                throw new IllegalStateException("tokens must begin with BEGIN_GROUP: token=" + groupToken);
+            }
+            addLine(sb, indent, "//" + groupToken);
+            final String groupName = formatPropertyName(groupToken.name());
+            final String groupDecoderName = decoderName(formatClassName(groupToken.name()));
+            addLine(sb, indent, "builder.append(\"" + groupName + "={\");");
+            addLine(sb, indent, groupDecoderName + " " + groupName + " = " + groupName + "();");
+            addLine(sb, indent, "while (" + groupName + ".hasNext())");
+            addLine(sb, indent, "{");
+            addLine(sb, indent, "    builder.append('[');");
+            addLine(sb, indent, "    " + groupName + ".next().appendTo(builder);");
+            addLine(sb, indent, "    builder.setLength(builder.length()-1);");
+            addLine(sb, indent, "    builder.append(']');");
+            addLine(sb, indent, "}");
+            addLine(sb, indent, "builder.append(\"}|\");");
+            i = findEndSignal(groups, i, Signal.END_GROUP, groupToken.name());
+        }
+        //varLength
+        for (int i = 0, size = varLens.size(); i < size;)
+        {
+            final Token varLenToken = varLens.get(i);
+            if (varLenToken.signal() != Signal.BEGIN_VAR_DATA)
+            {
+                throw new IllegalStateException("tokens must begin with BEGIN_VAR_DATA: token=" + varLenToken);
+            }
+            addLine(sb, indent, "//" + varLenToken);
+            final String varLenName = formatPropertyName(varLenToken.name());
+            addLine(sb, indent, "builder.append(\"" + varLenName + "=\");");
+            addLine(sb, indent, "builder.append(" + varLenName + "());");
+            addLine(sb, indent, "builder.append('|');");
+            i += varLenToken.componentTokenCount();
+        }
+        return sb;
+    }
+
+    private void writeTokenDisplay(final String fieldName,
+                                   final Token typeToken,
+                                   final StringBuilder sb,
+                                   final String indent)
+    {
+        addLine(sb, indent, "//" + typeToken);
+        // not interested in anything not "binarily" present
+        if (typeToken.encodedLength() <= 0 || typeToken.isConstantEncoding())
+        {
+            return;
+        }
+        addLine(sb, indent, "builder.append(\"" + fieldName + "=\");");
+        switch (typeToken.signal())
+        {
+            case ENCODING:
+                if (typeToken.arrayLength() > 1)
+                {
+                    if (typeToken.encoding().primitiveType() == PrimitiveType.CHAR)
+                    {
+                        addLine(sb, indent, "for(int i = 0; i < " + fieldName + "Length() && " +
+                                fieldName + "(i)>0; i++)");
+                        addLine(sb, indent, "{");
+                        addLine(sb, indent, "    builder.append((char)" + fieldName + "(i));");
+                        addLine(sb, indent, "}");
+                    }
+                    else
+                    {
+                        addLine(sb, indent, "builder.append('[');");
+                        addLine(sb, indent, "if (" +  fieldName + "Length() > 0)");
+                        addLine(sb, indent, "{");
+                        addLine(sb, indent, "    for(int i = 0; i < " + fieldName + "Length(); i++)");
+                        addLine(sb, indent, "    {");
+                        addLine(sb, indent, "        builder.append(" + fieldName + "(i)).append(',');");
+                        addLine(sb, indent, "    }");
+                        addLine(sb, indent, "    builder.setLength(builder.length()-1);");
+                        addLine(sb, indent, "}");
+                        addLine(sb, indent, "builder.append(']');");
+                    }
+                }
+                else
+                {
+                    // have to duplicate because of checkstyle :/
+                    addLine(sb, indent, "builder.append(" + fieldName + "());");
+                }
+                break;
+            case BEGIN_ENUM:
+            case BEGIN_SET:
+                addLine(sb, indent, "builder.append(" + fieldName + "());");
+                break;
+            case BEGIN_COMPOSITE:
+                addLine(sb, indent, fieldName + "().appendTo(builder);");
+                break;
+        }
+        addLine(sb, indent, "builder.append('|');");
+    }
+
+    private void appendToString(final StringBuilder sb, final String indent)
+    {
+        sb.append("\n");
+        addLine(sb, indent, "public String toString()");
+        addLine(sb, indent, "{");
+        addLine(sb, indent, "    return appendTo(new StringBuilder(100)).toString();");
+        addLine(sb, indent, "}");
+    }
 }
diff --git a/sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/java/JavaUtil.java b/sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/java/JavaUtil.java
@@ -116,4 +116,17 @@ public static String formatClassName(final String value)
     {
         return toUpperFirstChar(value);
     }
+
+
+    /**
+     * Shortcut to add a line of generated code
+     *
+     * @param builder string builder to which to add the line
+     * @param indent current text indentation
+     * @param line line to be added
+     */
+    public static  void addLine(StringBuilder builder, String indent, String line)
+    {
+        builder.append(indent + line + "\n");
+    }
 }
diff --git a/sbe-tool/src/test/java/uk/co/real_logic/sbe/generation/java/JavaGeneratorTest.java b/sbe-tool/src/test/java/uk/co/real_logic/sbe/generation/java/JavaGeneratorTest.java
@@ -36,6 +36,7 @@
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.Matchers.greaterThan;
 import static org.hamcrest.Matchers.hasToString;
+import static org.hamcrest.Matchers.startsWith;
 import static org.junit.Assert.*;
 import static org.mockito.Mockito.*;
 import static uk.co.real_logic.sbe.generation.CodeGenerator.MESSAGE_HEADER_DECODER_TYPE;
@@ -242,6 +243,8 @@ public void shouldGenerateBasicMessage() throws Exception
         final Object groupFlyweight = fuelFiguresCount(msgFlyweight, 0);
 
         assertNotNull(groupFlyweight);
+
+        assertThat(msgFlyweight.toString(), startsWith("[Car]"));
     }
 
     @Test

Original file line number	Diff line number	Diff line change
`@@ -116,4 +116,17 @@ public static String formatClassName(final String value)`
`116`	`116`	`{`
`117`	`117`	`return toUpperFirstChar(value);`
`118`	`118`	`}`
	`119`	`+`
	`120`	`+`
	`121`	`+ /**`
	`122`	`+ * Shortcut to add a line of generated code`
	`123`	`+ *`
	`124`	`+ * @param builder string builder to which to add the line`
	`125`	`+ * @param indent current text indentation`
	`126`	`+ * @param line line to be added`
	`127`	`+ */`
	`128`	`+ public static void addLine(StringBuilder builder, String indent, String line)`
	`129`	`+ {`
	`130`	`+ builder.append(indent + line + "\n");`
	`131`	`+ }`
`119`	`132`	`}`