Record generator fix plus new record. Must write email regarding it's uses but first got to sleep. 2am.. zzzz

git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352159 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/poi/hssf/dev/BiffViewer.java

@@ -613,6 +613,10 @@ public class BiffViewer
                 retval = new ValueRangeRecord(rectype, size, data);
                 break;
 
+            case SeriesListRecord.sid :
+                retval = new ValueRangeRecord(rectype, size, data);
+                break;
+
             default :
                 retval = new UnknownRecord(rectype, size, data);
         }

src/java/org/apache/poi/hssf/record/SeriesListRecord.java

@@ -0,0 +1,191 @@
+
+/* ====================================================================
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2002 The Apache Software Foundation.  All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ *
+ * 3. The end-user documentation included with the redistribution,
+ *    if any, must include the following acknowledgment:
+ *       "This product includes software developed by the
+ *        Apache Software Foundation (http://www.apache.org/)."
+ *    Alternately, this acknowledgment may appear in the software itself,
+ *    if and wherever such third-party acknowledgments normally appear.
+ *
+ * 4. The names "Apache" and "Apache Software Foundation" and
+ *    "Apache POI" must not be used to endorse or promote products
+ *    derived from this software without prior written permission. For
+ *    written permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache",
+ *    "Apache POI", nor may "Apache" appear in their name, without
+ *    prior written permission of the Apache Software Foundation.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation.  For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ */
+
+
+package org.apache.poi.hssf.record;
+
+
+
+import org.apache.poi.util.BitField;
+import org.apache.poi.util.LittleEndian;
+import org.apache.poi.util.StringUtil;
+import org.apache.poi.util.HexDump;
+
+/**
+ * The series list record defines the series displayed as an overlay to the main chart record.
+ * NOTE: This source is automatically generated please do not modify this file.  Either subclass or
+ *       remove the record in src/records/definitions.
+
+ * @author Glen Stampoultzis (glens at apache.org)
+ */
+public class SeriesListRecord
+    extends Record
+{
+    public final static short      sid                             = 0x1016;
+    private  short[]    field_1_seriesNumbers;
+
+
+    public SeriesListRecord()
+    {
+
+    }
+
+    /**
+     * Constructs a SeriesList record and sets its fields appropriately.
+     *
+     * @param id    id must be 0x1016 or an exception
+     *              will be throw upon validation
+     * @param size  size the size of the data area of the record
+     * @param data  data of the record (should not contain sid/len)
+     */
+
+    public SeriesListRecord(short id, short size, byte [] data)
+    {
+        super(id, size, data);
+    }
+
+    /**
+     * Constructs a SeriesList record and sets its fields appropriately.
+     *
+     * @param id    id must be 0x1016 or an exception
+     *              will be throw upon validation
+     * @param size  size the size of the data area of the record
+     * @param data  data of the record (should not contain sid/len)
+     * @param offset of the record's data
+     */
+
+    public SeriesListRecord(short id, short size, byte [] data, int offset)
+    {
+        super(id, size, data, offset);
+    }
+
+    /**
+     * Checks the sid matches the expected side for this record
+     *
+     * @param id   the expected sid.
+     */
+    protected void validateSid(short id)
+    {
+        if (id != sid)
+        {
+            throw new RecordFormatException("Not a SeriesList record");
+        }
+    }
+
+    protected void fillFields(byte [] data, short size, int offset)
+    {
+        field_1_seriesNumbers           = LittleEndian.getShortArray(data, 0 + offset);
+
+    }
+
+    public String toString()
+    {
+        StringBuffer buffer = new StringBuffer();
+
+        buffer.append("[SeriesList]\n");
+
+        buffer.append("    .seriesNumbers        = ")
+            .append(" (").append(getSeriesNumbers()).append(" )\n");
+
+        buffer.append("[/SeriesList]\n");
+        return buffer.toString();
+    }
+
+    public int serialize(int offset, byte[] data)
+    {
+        LittleEndian.putShort(data, 0 + offset, sid);
+        LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
+
+        LittleEndian.putShortArray(data, 4 + offset, field_1_seriesNumbers);
+
+        return getRecordSize();
+    }
+
+    /**
+     * Size of record (exluding 4 byte header)
+     */
+    public int getRecordSize()
+    {
+        return 4 + field_1_seriesNumbers.length * 2 + 2;
+    }
+
+    public short getSid()
+    {
+        return this.sid;
+    }
+
+
+    /**
+     * Get the series numbers field for the SeriesList record.
+     */
+    public short[] getSeriesNumbers()
+    {
+        return field_1_seriesNumbers;
+    }
+
+    /**
+     * Set the series numbers field for the SeriesList record.
+     */
+    public void setSeriesNumbers(short[] field_1_seriesNumbers)
+    {
+        this.field_1_seriesNumbers = field_1_seriesNumbers;
+    }
+
+
+}  // END OF CLASS
+
+
+
+

src/java/org/apache/poi/util/LittleEndian.java

@@ -95,6 +95,21 @@ public class LittleEndian
         return ( short ) getNumber(data, offset, SHORT_SIZE);
     }
 
+    /**
+     * get a short array from a byte array.  The short array is assumed
+     * to start with a word describing the length of the array.
+     */
+    public static short[] getShortArray(final byte [] data, final int offset)
+    {
+        int size = ( short) getNumber(data, offset, SHORT_SIZE);
+        short[] results = new short[size];
+        for (int i = 0; i < size; i++)
+        {
+            results[i] = getShort(data, offset + 2 + (i*2));
+        }
+        return results;
+    }
+
     /**
      * get a short value from the beginning of a byte array
      *
@@ -221,6 +236,24 @@ public class LittleEndian
         putNumber(data, offset, value, SHORT_SIZE);
     }
 
+    /**
+     * put a array of shorts into a byte array
+     *
+     * @param data the byte array
+     * @param offset a starting offset into the byte array
+     * @param value the short array
+     *
+     * @exception ArrayIndexOutOfBoundsException may be thrown
+     */
+    public static void putShortArray(final byte [] data, final int offset, final short[] value)
+    {
+        putNumber(data, offset, value.length, SHORT_SIZE);
+        for (int i = 0; i < value.length; i++)
+        {
+            putNumber(data, offset + 2 + (i * 2), value[i], SHORT_SIZE);
+        }
+    }
+
     /**
      * put a short value into beginning of a byte array
      *

src/records/definitions/series_list_record.xml

@@ -0,0 +1,7 @@
+<record id="0x1016" name="SeriesList" package="org.apache.poi.hssf.record">
+    <description>The series list record defines the series displayed as an overlay to the main chart record.</description>
+    <author>Glen Stampoultzis (glens at apache.org)</author>
+    <fields>
+        <field type="int" size="varword" name="series numbers"/>
+    </fields>
+</record>

src/records/styles/record.xsl

@@ -246,9 +246,9 @@ public class <xsl:value-of select="@name"/>Record
 </xsl:template>
 
 <xsl:template match="field" mode="tostring">
-        buffer.append("    .<xsl:value-of select="recutil:getFieldName(@name,20)"/> = ")<xsl:if test="@type != 'string' and @type != 'float'">
+        buffer.append("    .<xsl:value-of select="recutil:getFieldName(@name,20)"/> = ")<xsl:choose><xsl:when test="@type != 'string' and @type != 'float' and @size != 'varword'">
             .append("0x")
-            .append(HexDump.toHex((<xsl:value-of select="recutil:getType(@size,@type,00)"/>)get<xsl:value-of select="recutil:getFieldName1stCap(@name,0)"/>()))</xsl:if>
+            .append(HexDump.toHex((<xsl:value-of select="recutil:getType(@size,@type,00)"/>)get<xsl:value-of select="recutil:getFieldName1stCap(@name,0)"/>()))</xsl:when></xsl:choose>
             .append(" (").append(get<xsl:value-of select="recutil:getFieldName1stCap(@name,0)"/>()).append(" )\n");
 <xsl:apply-templates select="bit" mode="bittostring"/>
 </xsl:template>

src/scratchpad/src/org/apache/poi/generator/FieldIterator.java

@@ -81,6 +81,8 @@ public class FieldIterator
         String result = "";
         if (javaType.equals("short"))
             result = "LittleEndian.getShort(data, " + offset + " + offset)";
+        else if (javaType.equals("short[]"))
+            result = "LittleEndian.getShortArray(data, " + offset + " + offset)";
         else if (javaType.equals("int"))
             result = "LittleEndian.getInt(data, " + offset + " + offset)";
         else if (javaType.equals("byte"))
@@ -109,6 +111,8 @@ public class FieldIterator
         String result = "";
         if (javaType.equals("short"))
             result = "LittleEndian.putShort(data, " + (offset+4) + " + offset, " + javaFieldName + ");";
+        else if (javaType.equals("short[]"))
+            result = "LittleEndian.putShortArray(data, " + (offset+4) + " + offset, " + javaFieldName + ");";
         else if (javaType.equals("int"))
             result = "LittleEndian.putInt(data, " + (offset+4) + " + offset, " + javaFieldName + ");";
         else if (javaType.equals("byte"))
@@ -137,6 +141,11 @@ public class FieldIterator
             String javaFieldName = RecordUtil.getFieldName(fieldNumber,fieldName,0);
             return result + javaFieldName + ".sizeInBytes()";
         }
+        else if ("varword".equals(size))
+        {
+            String javaFieldName = RecordUtil.getFieldName(fieldNumber,fieldName,0);
+            return result + javaFieldName + ".length * 2 + 2";
+        }
         else
         {
             return result + size;

src/scratchpad/src/org/apache/poi/generator/RecordUtil.java

@@ -122,11 +122,14 @@ public class RecordUtil
 
     public static String getType(String size, String type, int padTo)
     {
+
         boolean wholeNumber = type.equals("bits") || type.equals("int");
         if (wholeNumber && "1".equals(size))
             return pad(new StringBuffer("byte"), padTo).toString();
         else if (wholeNumber && "2".equals(size))
             return pad(new StringBuffer("short"), padTo).toString();
+        else if (type.equals("int") && "varword".equals(size))
+            return pad(new StringBuffer("short[]"), padTo).toString();
         else if (wholeNumber && "4".equals(size))
             return pad(new StringBuffer("int"), padTo).toString();
         else if (type.equals("float") && "8".equals(size))
@@ -143,6 +146,8 @@ public class RecordUtil
         boolean numeric = type.equals("bits") || type.equals("int");
         if (numeric && "1".equals(size))
             result = pad(new StringBuffer("byte"), padTo);
+        else if (type.equals("int") && "varword".equals(size))
+            result = pad(new StringBuffer("short[]"), padTo);
         else if (numeric && "2".equals(size))
             result = pad(new StringBuffer("short"), padTo);
         else if (type.equals("string"))

src/testcases/org/apache/poi/hssf/record/TestSeriesListRecord.java

@@ -0,0 +1,106 @@
+
+/* ====================================================================
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2002 The Apache Software Foundation.  All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ *
+ * 3. The end-user documentation included with the redistribution,
+ *    if any, must include the following acknowledgment:
+ *       "This product includes software developed by the
+ *        Apache Software Foundation (http://www.apache.org/)."
+ *    Alternately, this acknowledgment may appear in the software itself,
+ *    if and wherever such third-party acknowledgments normally appear.
+ *
+ * 4. The names "Apache" and "Apache Software Foundation" and
+ *    "Apache POI" must not be used to endorse or promote products
+ *    derived from this software without prior written permission. For
+ *    written permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache",
+ *    "Apache POI", nor may "Apache" appear in their name, without
+ *    prior written permission of the Apache Software Foundation.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation.  For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ */
+
+
+package org.apache.poi.hssf.record;
+
+
+import junit.framework.TestCase;
+
+/**
+ * Tests the serialization and deserialization of the SeriesListRecord
+ * class works correctly.  Test data taken directly from a real
+ * Excel file.
+ *
+
+ * @author Glen Stampoultzis (glens at apache.org)
+ */
+public class TestSeriesListRecord
+        extends TestCase
+{
+    byte[] data = new byte[] {
+        (byte)0x02,(byte)0x00,(byte)0x01,(byte)0x20,(byte)0xff,(byte)0xf0
+    };
+
+    public TestSeriesListRecord(String name)
+    {
+        super(name);
+    }
+
+    public void testLoad()
+            throws Exception
+    {
+
+        SeriesListRecord record = new SeriesListRecord((short)0x1016, (short)data.length, data);
+        assertEquals( (short)0x2001, record.getSeriesNumbers()[0]);
+        assertEquals( (short)0xf0ff, record.getSeriesNumbers()[1]);
+        assertEquals( 2, record.getSeriesNumbers().length);
+
+        assertEquals( 4 + 6, record.getRecordSize() );
+
+        record.validateSid((short)0x1016);
+    }
+
+    public void testStore()
+    {
+        SeriesListRecord record = new SeriesListRecord();
+        record.setSeriesNumbers( new short[] { (short)0x2001, (short)0xf0ff } );
+
+        byte [] recordBytes = record.serialize();
+        assertEquals(recordBytes.length - 4, data.length);
+        for (int i = 0; i < data.length; i++)
+            assertEquals("At offset " + i, data[i], recordBytes[i+4]);
+    }
+}

tools/targets/dev.xtarget

@@ -215,7 +215,7 @@
           <arg value="src/java"/>
           <arg value="src/testcases"/>
           <classpath>
-              <path refid="classpath"/>
+              <path refid="scratchpad.classpath"/>
               <pathelement location="${build.dest}"/>
           </classpath>
       </java>

tools/targets/preinit.xtarget

@@ -47,7 +47,7 @@
       <include name="*.jar"/>
     </fileset>
     <!-- FIXME : how to build a path that references a property set in 'init' target ? -->
-    <pathelement path="./build/${name}/classes"/>
+    <pathelement path="./build/${name}/scratchpad/classes"/>
   </path>
 
   <path id="examples.classpath">