refactoring, improved result of source conversion

Author: raydac

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

@@ -35,8 +35,7 @@
 import java.io.EOFException;
 import java.io.IOException;
 import java.io.InputStream;
-import java.util.ArrayList;
-import java.util.List;
+import java.util.*;
 
 /**
  * the Main class allows a user to parse a binary stream or block for predefined
@@ -639,18 +638,23 @@ public JBBPCompiledBlock getCompiledBlock() {
      *
      * @param target target to generate sources, must not be null
      * @param name   name of result, depends on target, must not be null, for instance class name (example 'com.test.jbbp.Parser')
-     * @return array of generated sources, must not be null
+     * @return list of source items generated during operation, must not be null and must not be empty
      * @throws IllegalArgumentException if target is unsupported
      * @see JBBPToJava6Converter
      * @see JBBPToJava6Converter.Builder
      * @since 1.3.0
      */
-    public String[] convertToSrc(final TargetSources target, final String name) {
+    public List<ResultSrcItem> convertToSrc(final TargetSources target, final String name) {
         JBBPUtils.assertNotNull(name, "Name must not be null");
-        final String[] result;
 
         switch (target) {
             case JAVA_1_6: {
+                final Properties metadata = new Properties();
+                metadata.setProperty("source", this.compiledBlock.getSource());
+                metadata.setProperty("name", name);
+                metadata.setProperty("target", target.name());
+                metadata.setProperty("converter", JBBPToJava6Converter.class.getCanonicalName());
+
                 final int nameStart = name.lastIndexOf('.');
                 final String packageName;
                 final String className;
@@ -661,16 +665,26 @@ public String[] convertToSrc(final TargetSources target, final String name) {
                     packageName = name.substring(0, nameStart);
                     className = name.substring(nameStart + 1);
                 }
-                result = new String[]{
-                        JBBPToJava6Converter.makeBuilder(this).setClassPackage(packageName).setClassName(className).build().convert()
-                };
+
+                final String resultSources = JBBPToJava6Converter.makeBuilder(this).setClassPackage(packageName).setClassName(className).build().convert();
+
+                final Map<String, String> resultMap = Collections.<String, String>singletonMap(name, resultSources);
+
+                return Collections.<ResultSrcItem>singletonList(new ResultSrcItem() {
+                    @Override
+                    public Properties getMetadata() {
+                        return metadata;
+                    }
+
+                    @Override
+                    public Map<String, String> getResult() {
+                        return resultMap;
+                    }
+                });
             }
-            break;
             default: {
                 throw new IllegalArgumentException("Unsupported target : " + target);
             }
         }
-
-        return result;
     }
 }

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

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2017 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 java.util.Map;
+import java.util.Properties;
+
+/**
+ * Contains result of conversion of JBBPParser into source.
+ *
+ * @since 1.3.0
+ */
+public interface ResultSrcItem {
+    /**
+     * Get metadata generated during operation for the item, depends on converter.
+     *
+     * @return the metadata container as properties, must not be null
+     */
+    Properties getMetadata();
+
+    /**
+     * Get generated sources mapped by some key which defined by converter.
+     *
+     * @return map containing result of conversion, must not be null and can't be empty.
+     */
+    Map<String, String> getResult();
+}

src/main/java/com/igormaznitsa/jbbp/compiler/varlen/JBBPEvaluatorFactory.java

@@ -15,8 +15,8 @@
  */
 package com.igormaznitsa.jbbp.compiler.varlen;
 
-import com.igormaznitsa.jbbp.compiler.JBBPNamedFieldInfo;
 import com.igormaznitsa.jbbp.compiler.JBBPCompilerUtils;
+import com.igormaznitsa.jbbp.compiler.JBBPNamedFieldInfo;
 
 import java.util.List;
 

src/main/java/com/igormaznitsa/jbbp/compiler/varlen/JBBPExpressionEvaluator.java

@@ -17,9 +17,9 @@
 
 import com.igormaznitsa.jbbp.JBBPNamedNumericFieldMap;
 import com.igormaznitsa.jbbp.compiler.JBBPCompiledBlock;
+import com.igormaznitsa.jbbp.compiler.JBBPCompilerUtils;
 import com.igormaznitsa.jbbp.compiler.JBBPNamedFieldInfo;
 import com.igormaznitsa.jbbp.compiler.conversion.ExpressionEvaluatorVisitor;
-import com.igormaznitsa.jbbp.compiler.JBBPCompilerUtils;
 import com.igormaznitsa.jbbp.exceptions.JBBPCompilationException;
 import com.igormaznitsa.jbbp.exceptions.JBBPEvalException;
 import com.igormaznitsa.jbbp.io.JBBPBitInputStream;

src/main/java/com/igormaznitsa/jbbp/exceptions/JBBPFinderException.java

@@ -50,15 +50,16 @@ public JBBPFinderException(final String message, final String nameOrPath, final
 
     /**
      * Do not use the metod, it will be removed in future. It just presented for back compatibility.
+     *
      * @return the name or the path used for search, it can be null
+     * @see #getNameOrPath()
      * @deprecated
-     * @see #getNameOrPath() 
      */
     @Deprecated
     public String getNamrOrPath() {
         return this.getNameOrPath();
     }
-    
+
     /**
      * Get the name or the path used for search.
      *

src/main/java/com/igormaznitsa/jbbp/utils/JavaSrcTextBuffer.java

@@ -35,6 +35,7 @@ public JavaSrcTextBuffer() {
 
     /**
      * Constructor with capacity value.
+     *
      * @param capacity capacity of the created buffer
      */
     public JavaSrcTextBuffer(final int capacity) {
@@ -43,6 +44,7 @@ public JavaSrcTextBuffer(final int capacity) {
 
     /**
      * Increase indent
+     *
      * @return this instance
      */
     public JavaSrcTextBuffer incIndent() {
@@ -52,6 +54,7 @@ public JavaSrcTextBuffer incIndent() {
 
     /**
      * Decrease indent
+     *
      * @return this instance
      */
     public JavaSrcTextBuffer decIndent() {
@@ -61,6 +64,7 @@ public JavaSrcTextBuffer decIndent() {
 
     /**
      * Print integer value
+     *
      * @param value integer value
      * @return this instance
      */
@@ -71,6 +75,7 @@ public JavaSrcTextBuffer print(final int value) {
 
     /**
      * Print boolean value
+     *
      * @param value boolean value
      * @return this instance
      */
@@ -81,6 +86,7 @@ public JavaSrcTextBuffer print(final boolean value) {
 
     /**
      * Foratted print.
+     *
      * @param text format string
      * @param args arguments for formatted string
      * @return this instance
@@ -93,6 +99,7 @@ public JavaSrcTextBuffer printf(final String text, final Object... args) {
 
     /**
      * Print string
+     *
      * @param text string
      * @return this instance
      */
@@ -103,6 +110,7 @@ public JavaSrcTextBuffer print(final String text) {
 
     /**
      * Clean buffer
+     *
      * @return this instance
      */
     public JavaSrcTextBuffer clean() {
@@ -113,6 +121,7 @@ public JavaSrcTextBuffer clean() {
 
     /**
      * Print tab char
+     *
      * @return this instance
      */
     public JavaSrcTextBuffer tab() {
@@ -122,6 +131,7 @@ public JavaSrcTextBuffer tab() {
 
     /**
      * Print tabs for current indent number
+     *
      * @return this instance
      */
     public JavaSrcTextBuffer indent() {
@@ -131,6 +141,7 @@ public JavaSrcTextBuffer indent() {
 
     /**
      * Print next line char
+     *
      * @return this instance
      */
     public JavaSrcTextBuffer println() {
@@ -140,6 +151,7 @@ public JavaSrcTextBuffer println() {
 
     /**
      * Check that the buffer is empty
+     *
      * @return true if the buffer is empty, false otherwise
      */
     public boolean isEmpty() {
@@ -148,6 +160,7 @@ public boolean isEmpty() {
 
     /**
      * Print text and next line char in the end
+     *
      * @param text the text to be printed
      * @return this instance
      */
@@ -157,6 +170,7 @@ public JavaSrcTextBuffer println(final String text) {
 
     /**
      * Parse string to lines and print each line with current indent
+     *
      * @param text the text to be printed
      * @return this instance
      */
@@ -172,6 +186,7 @@ public JavaSrcTextBuffer printLinesWithIndent(final String text) {
 
     /**
      * Parse string to lines and print each line with '//' comment
+     *
      * @param text text to be printed
      * @return this instance
      */
@@ -187,6 +202,7 @@ public JavaSrcTextBuffer printCommentLinesWithIndent(final String text) {
 
     /**
      * Print string as multiline java comment started with '/*'
+     *
      * @param text text to be printed as multiline comment
      * @return this instance
      */
@@ -204,6 +220,7 @@ public JavaSrcTextBuffer printCommentMultiLinesWithIndent(final String text) {
 
     /**
      * Print string as multiline java comment started with '/**'
+     *
      * @param text text to be printed as multiline comment
      * @return this instance
      */

src/main/java/com/igormaznitsa/jbbp/utils/TargetSources.java

@@ -18,6 +18,7 @@
 
 /**
  * Allowed sourcws for source generation in JBBPParser
+ *
  * @see com.igormaznitsa.jbbp.JBBPParser#convertToSrc(TargetSources, String)
  * @since 1.3.0
  */

src/test/java/com/igormaznitsa/jbbp/JBBPParserTest.java

@@ -1707,7 +1707,7 @@ public void testParse_NoErrorForIgnoreRemainingFieldsFlag() throws Exception {
     @Test
     public void testConvertToSrc_Java16() throws Exception {
         final JBBPParser parser = JBBPParser.prepare("byte a;");
-        assertTrue(parser.convertToSrc(TargetSources.JAVA_1_6, "someclass").length != 0);
+        assertTrue(parser.convertToSrc(TargetSources.JAVA_1_6, "someclass").get(0).getResult().values().iterator().next().length() > 128);
     }
 
 }

src/test/java/com/igormaznitsa/jbbp/compiler/conversion/JBBPToJBBPToJava6ConverterExpressionTest.java

@@ -46,7 +46,7 @@ public int read() throws IOException {
         final int detectedlength = getField(obj, "data", byte[].class).length;
 
         if (etalonValue != detectedlength) {
-            System.err.println(JBBPParser.prepare(String.format("byte [%s] data;", expression)).convertToSrc(TargetSources.JAVA_1_6,PACKAGE_NAME+"."+CLASS_NAME)[0]);
+            System.err.println(JBBPParser.prepare(String.format("byte [%s] data;", expression)).convertToSrc(TargetSources.JAVA_1_6,PACKAGE_NAME+"."+CLASS_NAME).get(0).getResult().values().iterator().next());
             fail(etalonValue + "!=" + detectedlength);
         }
     }

src/test/java/com/igormaznitsa/jbbp/testaux/AbstractJBBPToJava6ConverterTest.java

@@ -112,7 +112,7 @@ protected Object compileAndMakeInstance(final String instanceClassName, final St
 
     protected Object compileAndMakeInstance(final String instanceClassName, final String script, final int parserFlags, final JBBPCustomFieldTypeProcessor customFieldProcessor, final JavaClassContent... extraClasses) throws Exception {
         final List<JavaClassContent> klazzes = new ArrayList<JavaClassContent>(Arrays.asList(extraClasses));
-        klazzes.add(0, new JavaClassContent(PACKAGE_NAME + '.' + CLASS_NAME, JBBPParser.prepare(script, JBBPBitOrder.LSB0, customFieldProcessor, parserFlags).convertToSrc(TargetSources.JAVA_1_6, PACKAGE_NAME+"."+CLASS_NAME)[0]));
+        klazzes.add(0, new JavaClassContent(PACKAGE_NAME + '.' + CLASS_NAME, JBBPParser.prepare(script, JBBPBitOrder.LSB0, customFieldProcessor, parserFlags).convertToSrc(TargetSources.JAVA_1_6, PACKAGE_NAME+"."+CLASS_NAME).get(0).getResult().values().iterator().next()));
         final ClassLoader cloader = saveAndCompile(klazzes.toArray(new JavaClassContent[klazzes.size()]));
         return cloader.loadClass(instanceClassName).newInstance();
     }