pass through the buffer implementation into java templates

Author: RichardWarburton

main/java/uk/co/real_logic/sbe/SbeTool.java

@@ -128,7 +128,7 @@ public static void main(final String[] args) throws Exception
  {
  validateAgainstSchema(fileName, xsdFilename);
  }
- 
+
  ir = new IrGenerator().generate(parseSchema(fileName), System.getProperty(TARGET_NAMESPACE));
  }
  else if (fileName.endsWith(".sbeir"))

main/java/uk/co/real_logic/sbe/generation/java/JavaGenerator.java

@@ -16,6 +16,7 @@
 package uk.co.real_logic.sbe.generation.java;
 
 import uk.co.real_logic.sbe.PrimitiveType;
+import uk.co.real_logic.sbe.codec.java.DirectBuffer;
 import uk.co.real_logic.sbe.generation.CodeGenerator;
 import uk.co.real_logic.sbe.generation.OutputManager;
 import uk.co.real_logic.sbe.ir.*;
@@ -37,15 +38,39 @@ public class JavaGenerator implements CodeGenerator
 
  private final Ir ir;
  private final OutputManager outputManager;
+ private final String fullyQualifiedBufferImplementation;
+ private final String bufferImplementation;
 
- public JavaGenerator(final Ir ir, final String bufferImplementation, final OutputManager outputManager)
+ public JavaGenerator(
+ final Ir ir, final String fullyQualifiedBufferImplementation, final OutputManager outputManager)
  throws IOException
  {
  Verify.notNull(ir, "ir");
  Verify.notNull(outputManager, "outputManager");
 
  this.ir = ir;
  this.outputManager = outputManager;
+ this.bufferImplementation = validateBufferImplementation(fullyQualifiedBufferImplementation);
+ this.fullyQualifiedBufferImplementation = fullyQualifiedBufferImplementation;
+ }
+
+ private String validateBufferImplementation(final String fullyQualifiedBufferImplementation)
+ {
+ try
+ {
+ final Class<?> cls = Class.forName(fullyQualifiedBufferImplementation);
+ if (!cls.isAssignableFrom(DirectBuffer.class))
+ {
+ throw new IllegalArgumentException(
+ fullyQualifiedBufferImplementation + " doesn't implement " + DirectBuffer.class.getName());
+ }
+ return cls.getSimpleName();
+ }
+ catch (ClassNotFoundException e)
+ {
+ throw new IllegalArgumentException(
+ "Unable to validate " + fullyQualifiedBufferImplementation + " because it can't be found", e);
+ }
  }
 
  public void generateMessageHeaderStub() throws IOException
@@ -206,28 +231,11 @@ private void generateGroupClassHeader(
  final String dimensionsClassName = formatClassName(tokens.get(index + 1).name());
  final Integer dimensionHeaderSize = Integer.valueOf(tokens.get(index + 1).size());
 
- sb.append(String.format(
- "\n" +
- indent + "public static class %1$s implements Iterable<%1$s>, java.util.Iterator<%1$s>\n" +
- indent + "{\n" +
- indent + " private static final int HEADER_SIZE = %2$d;\n" +
- indent + " private final %3$s dimensions = new %3$s();\n" +
- indent + " private %4$s parentMessage;\n" +
- indent + " private DirectBuffer buffer;\n" +
- indent + " private int blockLength;\n" +
- indent + " private int actingVersion;\n" +
- indent + " private int count;\n" +
- indent + " private int index;\n" +
- indent + " private int offset;\n\n",
- formatClassName(groupName),
- dimensionHeaderSize,
- dimensionsClassName,
- parentMessageClassName
- ));
+ generateClassDeclaration(sb, groupName, parentMessageClassName, indent, dimensionsClassName, dimensionHeaderSize);
 
  sb.append(String.format(
  indent + " public void wrapForDecode(\n" +
- indent + " final %s parentMessage, final DirectBuffer buffer, final int actingVersion)\n" +
+ indent + " final %s parentMessage, final %s buffer, final int actingVersion)\n" +
  indent + " {\n" +
  indent + " this.parentMessage = parentMessage;\n" +
  indent + " this.buffer = buffer;\n" +
@@ -238,15 +246,16 @@ private void generateGroupClassHeader(
  indent + " index = -1;\n" +
  indent + " parentMessage.limit(parentMessage.limit() + HEADER_SIZE);\n" +
  indent + " }\n\n",
- parentMessageClassName
+ parentMessageClassName,
+ bufferImplementation
  ));
 
  final Integer blockLength = Integer.valueOf(tokens.get(index).size());
  final String javaTypeForBlockLength = javaTypeName(tokens.get(index + 2).encoding().primitiveType());
  final String javaTypeForNumInGroup = javaTypeName(tokens.get(index + 3).encoding().primitiveType());
 
  sb.append(String.format(
- indent + " public void wrapForEncode(final %1$s parentMessage, final DirectBuffer buffer, final int count)\n" +
+ indent + " public void wrapForEncode(final %1$s parentMessage, final %5$s buffer, final int count)\n" +
  indent + " {\n" +
  indent + " this.parentMessage = parentMessage;\n" +
  indent + " this.buffer = buffer;\n" +
@@ -262,7 +271,8 @@ private void generateGroupClassHeader(
  parentMessageClassName,
  javaTypeForBlockLength,
  blockLength,
- javaTypeForNumInGroup
+ javaTypeForNumInGroup,
+ bufferImplementation
  ));
 
  sb.append(String.format(
@@ -323,6 +333,32 @@ private void generateGroupClassHeader(
  ));
  }
 
+ private void generateClassDeclaration(
+ final StringBuilder sb, final String groupName, final String parentMessageClassName, final String indent,
+ final String dimensionsClassName, final Integer dimensionHeaderSize)
+ {
+
+ sb.append(String.format(
+ "\n" +
+ indent + "public static class %1$s implements Iterable<%1$s>, java.util.Iterator<%1$s>\n" +
+ indent + "{\n" +
+ indent + " private static final int HEADER_SIZE = %2$d;\n" +
+ indent + " private final %3$s dimensions = new %3$s();\n" +
+ indent + " private %4$s parentMessage;\n" +
+ indent + " private %5$s buffer;\n" +
+ indent + " private int blockLength;\n" +
+ indent + " private int actingVersion;\n" +
+ indent + " private int count;\n" +
+ indent + " private int index;\n" +
+ indent + " private int offset;\n\n",
+ formatClassName(groupName),
+ dimensionHeaderSize,
+ dimensionsClassName,
+ parentMessageClassName,
+ bufferImplementation
+ ));
+ }
+
  private CharSequence generateGroupProperty(final String groupName, final Token token, final String indent)
  {
  final StringBuilder sb = new StringBuilder();
@@ -651,8 +687,10 @@ private CharSequence generateFileHeader(final String packageName)
  return String.format(
  "/* Generated SBE (Simple Binary Encoding) message codec */\n" +
  "package %s;\n\n" +
- "import uk.co.real_logic.sbe.codec.java.*;\n\n",
- packageName
+ "import uk.co.real_logic.sbe.codec.java.*;\n" +
+ "import %s;\n\n",
+ packageName,
+ fullyQualifiedBufferImplementation
  );
  }
 
@@ -1135,10 +1173,10 @@ private CharSequence generateByteLiteralList(final byte[] bytes)
  private CharSequence generateFixedFlyweightCode(final String className, final int size)
  {
  return String.format(
- " private DirectBuffer buffer;\n" +
+ " private %3$s buffer;\n" +
  " private int offset;\n" +
  " private int actingVersion;\n\n" +
- " public %s wrap(final DirectBuffer buffer, final int offset, final int actingVersion)\n" +
+ " public %1$s wrap(final %3$s buffer, final int offset, final int actingVersion)\n" +
  " {\n" +
  " this.buffer = buffer;\n" +
  " this.offset = offset;\n" +
@@ -1147,10 +1185,11 @@ private CharSequence generateFixedFlyweightCode(final String className, final in
  " }\n\n" +
  " public int size()\n" +
  " {\n" +
- " return %d;\n" +
+ " return %2$d;\n" +
  " }\n",
  className,
- Integer.valueOf(size)
+ Integer.valueOf(size),
+ bufferImplementation
  );
  }
 
@@ -1168,7 +1207,7 @@ private CharSequence generateMessageFlyweightCode(final String className, final
  " public static final %5$s SCHEMA_ID = %6$s;\n" +
  " public static final %7$s SCHEMA_VERSION = %8$s;\n\n" +
  " private final %9$s parentMessage = this;\n" +
- " private DirectBuffer buffer;\n" +
+ " private %11$s buffer;\n" +
  " private int offset;\n" +
  " private int limit;\n" +
  " private int actingBlockLength;\n" +
@@ -1198,7 +1237,7 @@ private CharSequence generateMessageFlyweightCode(final String className, final
  " {\n" +
  " return offset;\n" +
  " }\n\n" +
- " public %9$s wrapForEncode(final DirectBuffer buffer, final int offset)\n" +
+ " public %9$s wrapForEncode(final %11$s buffer, final int offset)\n" +
  " {\n" +
  " this.buffer = buffer;\n" +
  " this.offset = offset;\n" +
@@ -1208,7 +1247,7 @@ private CharSequence generateMessageFlyweightCode(final String className, final
  " return this;\n" +
  " }\n\n" +
  " public %9$s wrapForDecode(\n" +
- " final DirectBuffer buffer, final int offset, final int actingBlockLength, final int actingVersion)\n" +
+ " final %11$s buffer, final int offset, final int actingBlockLength, final int actingVersion)\n" +
  " {\n" +
  " this.buffer = buffer;\n" +
  " this.offset = offset;\n" +
@@ -1239,7 +1278,8 @@ private CharSequence generateMessageFlyweightCode(final String className, final
  schemaVersionType,
  generateLiteral(ir.headerStructure().schemaVersionType(), Integer.toString(token.version())),
  className,
- semanticType
+ semanticType,
+ bufferImplementation
  );
  }