started 1.2.0 version, improved compilation and parsing to support fields of custom types

Author: raydac

changelog.txt

@@ -1,10 +1,12 @@
 Change log
 --------------------------
 
-1.1.1
+1.2.0
 - Refactoring
 - Improved tree of JBBP exceptions
 - Fixed NPE in JBBPTextWriter for String field mapped to byte array 
+- Added support of custom field types through JBBPCustomFieldTypeProcessor
+- Added JBBPCustomFieldTypeProcessorAggregator, auxiliary class to join several JBBPCustomFieldTypeProcessors
 
 1.1.0
 - Added support to write mapped classes into JBBPOut

pom.xml

@@ -4,7 +4,7 @@
 
   <groupId>com.igormaznitsa</groupId>
   <artifactId>jbbp</artifactId>
-  <version>1.1.1-SNAPSHOT</version>
+  <version>1.2.0-SNAPSHOT</version>
   <packaging>jar</packaging>
 
   <name>jbbp</name>

src/main/java/com/igormaznitsa/jbbp/JBBPCustomFieldTypeProcessor.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2015 Igor Maznitsa.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.igormaznitsa.jbbp;
+
+import com.igormaznitsa.jbbp.compiler.JBBPNamedFieldInfo;
+import com.igormaznitsa.jbbp.compiler.tokenizer.JBBPFieldTypeParameterContainer;
+import com.igormaznitsa.jbbp.io.JBBPBitInputStream;
+import com.igormaznitsa.jbbp.io.JBBPBitOrder;
+import com.igormaznitsa.jbbp.model.JBBPAbstractField;
+import java.io.IOException;
+
+/**
+ * Allows to define and process own custom field types during parsing.
+ * 
+ * @since 1.2.0
+ */
+public interface JBBPCustomFieldTypeProcessor  {
+  /**
+   * Get custom types of fields supported by the custom type field processor.
+   * @return array of strings where every string is custom field type in lower-case.
+   */
+  String [] getCustomFieldTypes();
+  
+  /**
+   * Called by compiler to check parameters for custom field.
+   * @param fieldType field type info, it must not be null
+   * @param fieldName name of the field, it can be null for anonymous fields
+   * @param extraData number placed as extra value for field, followed by ':' if not presented then zero
+   * @param isArray flag shows that the field describes an array
+   * @return true if such configuration allowed, false otherwise
+   */
+  boolean isAllowed(JBBPFieldTypeParameterContainer fieldType, String fieldName, int extraData, boolean isArray);
+  
+  /**
+   * Read custom field from stream and return the data as a JBBP field.
+   * @param in the data source stream, must not be null
+   * @param bitOrder the bit order defined for parsing, must not be null
+   * @param parserFlags the flags defined for parsing
+   * @param customTypeFieldInfo the current field type info, must not be null
+   * @param fieldName the field name info, it can be null if the field is anonymous one
+   * @param extraData extra numeric value for the field, followed by ':', if not presented then 0
+   * @param readWholeStream if true then the field is array which should contain parse data for whole stream till the end
+   * @param arrayLength -1 if it is not array else length of the array to be read.
+   * @return parsed data as JBBP field, must not be null
+   * @throws IOException it can be thrown for transport errors
+   */
+  JBBPAbstractField readCustomFieldType(JBBPBitInputStream in, JBBPBitOrder bitOrder, int parserFlags, JBBPFieldTypeParameterContainer customTypeFieldInfo, JBBPNamedFieldInfo fieldName, int extraData, boolean readWholeStream, int arrayLength) throws IOException;
+}

src/main/java/com/igormaznitsa/jbbp/JBBPParser.java

@@ -16,6 +16,7 @@
 package com.igormaznitsa.jbbp;
 
 import com.igormaznitsa.jbbp.compiler.*;
+import com.igormaznitsa.jbbp.compiler.tokenizer.JBBPFieldTypeParameterContainer;
 import com.igormaznitsa.jbbp.compiler.varlen.JBBPIntegerValueEvaluator;
 import com.igormaznitsa.jbbp.exceptions.JBBPParsingException;
 import com.igormaznitsa.jbbp.io.*;
@@ -61,21 +62,28 @@ public final class JBBPParser {
   private final int flags;
 
   /**
-   * The Constructor.
+   * Custom field type processor for the parser, it can be null.
+   */
+  private final JBBPCustomFieldTypeProcessor customFieldTypeProcessor;
+  
+  /**
+   * Constructor.
    *
    * @param source the source script to parse binary blocks and streams, must
    * not be null
    * @param bitOrder the bit order for bit reading operations, must not be null
+   * @param customFieldTypeProcessor custom field type processor for the parser instance, it can be null
    * @param flags special flags for parsing process
    * @see #FLAG_SKIP_REMAINING_FIELDS_IF_EOF
    */
-  private JBBPParser(final String source, final JBBPBitOrder bitOrder, final int flags) {
+  private JBBPParser(final String source, final JBBPBitOrder bitOrder, final JBBPCustomFieldTypeProcessor customFieldTypeProcessor, final int flags) {
     JBBPUtils.assertNotNull(source, "Script is null");
     JBBPUtils.assertNotNull(bitOrder, "Bit order is null");
+    this.customFieldTypeProcessor = customFieldTypeProcessor;
     this.bitOrder = bitOrder;
     this.flags = flags;
     try {
-      this.compiledBlock = JBBPCompiler.compile(source);
+      this.compiledBlock = JBBPCompiler.compile(source, customFieldTypeProcessor);
     }
     catch (IOException ex) {
       throw new RuntimeException("Can't compile script for unexpected IOException", ex);
@@ -231,6 +239,15 @@ private List<JBBPAbstractField> parseStruct(final JBBPBitInputStream inStream, f
             }
           }
           break;
+          case JBBPCompiler.CODE_CUSTOMTYPE: {
+            if (resultNotIgnored){
+              final int extraData = JBBPUtils.unpackInt(compiled, positionAtCompiledBlock);
+              final JBBPFieldTypeParameterContainer fieldTypeInfo = this.compiledBlock.getCustomTypeFields()[JBBPUtils.unpackInt(compiled, positionAtCompiledBlock)];
+              final JBBPAbstractField field = this.customFieldTypeProcessor.readCustomFieldType(inStream, this.bitOrder, this.flags, fieldTypeInfo, name, extraData, wholeStreamArray, arrayLength);
+              JBBPUtils.assertNotNull(field, "Must not return null as read result");
+              structureFields.add(field);
+            }
+          }break;
           case JBBPCompiler.CODE_BOOL: {
             if (resultNotIgnored) {
               if (arrayLength < 0) {
@@ -511,7 +528,7 @@ public JBBPFieldStruct parse(final byte[] array, final JBBPVarFieldProcessor var
    * @see JBBPBitOrder#MSB0
    */
   public static JBBPParser prepare(final String script, final JBBPBitOrder bitOrder) {
-    return new JBBPParser(script, bitOrder, 0);
+    return new JBBPParser(script, bitOrder, null, 0);
   }
 
   /**
@@ -529,9 +546,27 @@ public static JBBPParser prepare(final String script, final JBBPBitOrder bitOrde
    * @since 1.1
    */
   public static JBBPParser prepare(final String script, final JBBPBitOrder bitOrder, final int flags) {
-    return new JBBPParser(script, bitOrder, flags);
+    return new JBBPParser(script, bitOrder, null, flags);
   }
 
+  /**
+   * Prepare a parser for a script with defined bit order and special flags.
+   *
+   * @param script a text script contains field order and types reference, it
+   * must not be null
+   * @param bitOrder the bit order for reading operations, it must not be null
+   * @param customFieldTypeProcessor custom field type processor, it can be null
+   * @param flags special flags for parsing
+   * @return the prepared parser for the script
+   * @see JBBPBitOrder#LSB0
+   * @see JBBPBitOrder#MSB0
+   * @see #FLAG_SKIP_REMAINING_FIELDS_IF_EOF
+   *
+   * @since 1.1.1
+   */
+  public static JBBPParser prepare(final String script, final JBBPBitOrder bitOrder, final JBBPCustomFieldTypeProcessor customFieldTypeProcessor, final int flags) {
+    return new JBBPParser(script, bitOrder, customFieldTypeProcessor, flags);
+  }
 
   /**
    * Prepare a parser for a script with default bit order (LSB0) use.

src/main/java/com/igormaznitsa/jbbp/compiler/JBBPCompiledBlock.java

@@ -15,6 +15,7 @@
  */
 package com.igormaznitsa.jbbp.compiler;
 
+import com.igormaznitsa.jbbp.compiler.tokenizer.JBBPFieldTypeParameterContainer;
 import com.igormaznitsa.jbbp.compiler.varlen.JBBPIntegerValueEvaluator;
 import com.igormaznitsa.jbbp.exceptions.JBBPException;
 import com.igormaznitsa.jbbp.exceptions.JBBPIllegalArgumentException;
@@ -40,11 +41,17 @@ public final class JBBPCompiledBlock {
    * The Compiled script data.
    */
   private final byte[] compiledArray;
+
   /**
    * The Array of variable size array evaluators.
    */
   private final JBBPIntegerValueEvaluator[] arraySizeEvaluators;
 
+  /**
+   * The Array of variable size array evaluators.
+   */
+  private final JBBPFieldTypeParameterContainer[] customTypeFields;
+
   /**
    * The Flag shows that the compiled block contains var fields.
    */
@@ -60,6 +67,7 @@ public final static class Builder {
     private byte[] compiledData;
     private boolean hasVarFields;
     private final List<JBBPIntegerValueEvaluator> varLenProcessors = new ArrayList<JBBPIntegerValueEvaluator>();
+    private final List<JBBPFieldTypeParameterContainer> customTypeFields = new ArrayList<JBBPFieldTypeParameterContainer>();
 
     /**
      * Build a compiled block based on the data and check that all needed data
@@ -72,7 +80,7 @@ public JBBPCompiledBlock build() {
       JBBPUtils.assertNotNull(source, "Source is not defined");
       JBBPUtils.assertNotNull(compiledData, "Compiled data is not defined");
 
-      return new JBBPCompiledBlock(this.source, this.namedFields.toArray(new JBBPNamedFieldInfo[this.namedFields.size()]), this.varLenProcessors.isEmpty() ? null : this.varLenProcessors.toArray(new JBBPIntegerValueEvaluator[this.varLenProcessors.size()]), this.compiledData, this.hasVarFields);
+      return new JBBPCompiledBlock(this.source, this.namedFields.toArray(new JBBPNamedFieldInfo[this.namedFields.size()]), this.varLenProcessors.isEmpty() ? null : this.varLenProcessors.toArray(new JBBPIntegerValueEvaluator[this.varLenProcessors.size()]), this.compiledData, this.hasVarFields, this.customTypeFields.toArray(new JBBPFieldTypeParameterContainer[this.customTypeFields.size()]));
     }
 
     /**
@@ -136,6 +144,19 @@ public Builder setArraySizeEvaluators(final List<JBBPIntegerValueEvaluator> eval
       }
       return this;
     }
+    
+    /**
+     * Set list of fields processed by custom type field processor.
+     * @param list list of field token info, it can be null
+     * @return this object
+     */
+    public Builder setCustomTypeFields(final List<JBBPFieldTypeParameterContainer> list){
+      this.customTypeFields.clear();
+      if (list != null) {
+        this.customTypeFields.addAll(list);
+      }
+      return this;
+    }
   }
 
   /**
@@ -156,12 +177,13 @@ public static Builder prepare() {
    * @param compiledData compiled data block
    * @param hasVarFields the flag shows that te block contains var fields
    */
-  private JBBPCompiledBlock(final String source, final JBBPNamedFieldInfo[] namedFields, final JBBPIntegerValueEvaluator[] arraySizeEvaluators, final byte[] compiledData, final boolean hasVarFields) {
+  private JBBPCompiledBlock(final String source, final JBBPNamedFieldInfo[] namedFields, final JBBPIntegerValueEvaluator[] arraySizeEvaluators, final byte[] compiledData, final boolean hasVarFields, final JBBPFieldTypeParameterContainer [] customTypeFields) {
     this.source = source;
     this.namedFieldData = namedFields;
     this.hasVarFields = hasVarFields;
     this.compiledArray = compiledData;
     this.arraySizeEvaluators = arraySizeEvaluators;
+    this.customTypeFields = customTypeFields;
   }
 
   /**
@@ -210,6 +232,14 @@ public JBBPNamedFieldInfo[] getNamedFields() {
     return this.namedFieldData;
   }
 
+  /**
+   * Get array contains parameter info of detected custom type fields.
+   * @return the array contains the info for every registered custom type field.
+   */
+  public JBBPFieldTypeParameterContainer[] getCustomTypeFields(){
+    return this.customTypeFields;
+  }
+  
   /**
    * Get the array size evaluators
    *