* REFERENCE:
* @author Libin Roman (Vista Portal LDT. Developer) + * @author Sergei Kozello (sergeikozello at mail.ru) * @version 1.0-pre */ @@ -88,9 +90,10 @@ public class NameRecord extends Record { private byte field_9_length_help_topic_text; private byte field_10_length_status_bar_text; private byte field_11_compressed_unicode_flag; // not documented + private byte field_12_builtIn_name; private String field_12_name_text; private Stack field_13_name_definition; - private byte[] field_13_raw_name_definition = null; // raw data + private byte[] field_13_raw_name_definition; // raw data private String field_14_custom_menu_text; private String field_15_description_text; private String field_16_help_topic_text; @@ -378,7 +381,7 @@ public class NameRecord extends Record { */ public int serialize(int offset, byte[] data) { LittleEndian.putShort(data, 0 + offset, sid); - LittleEndian.putShort(data, 2 + offset, (short)( 15 + getTextsLength())); + // size defined below LittleEndian.putShort(data, 4 + offset, getOptionFlag()); data[6 + offset] = getKeyboardShortcut(); data[7 + offset] = getNameTextLength(); @@ -390,31 +393,43 @@ public class NameRecord extends Record { data [16 + offset] = getHelpTopicLength(); data [17 + offset] = getStatusBarLength(); data [18 + offset] = getCompressedUnicodeFlag(); - - StringUtil.putCompressedUnicode(getNameText(), data , 19 + offset); - - int start_of_name_definition = 19 + field_3_length_name_text; - if (this.field_13_name_definition != null) { - serializePtgs(data, start_of_name_definition + offset); - } else { - System.arraycopy(field_13_raw_name_definition,0,data - ,start_of_name_definition + offset,field_13_raw_name_definition.length); - } - - int start_of_custom_menu_text = start_of_name_definition + field_4_length_name_definition; - StringUtil.putCompressedUnicode(getCustomMenuText(), data , start_of_custom_menu_text + offset); - - int start_of_description_text = start_of_custom_menu_text + field_8_length_description_text; - StringUtil.putCompressedUnicode(getDescriptionText(), data , start_of_description_text + offset); - - int start_of_help_topic_text = start_of_description_text + field_9_length_help_topic_text; - StringUtil.putCompressedUnicode(getHelpTopicText(), data , start_of_help_topic_text + offset); - - int start_of_status_bar_text = start_of_help_topic_text + field_10_length_status_bar_text; - StringUtil.putCompressedUnicode(getStatusBarText(), data , start_of_status_bar_text + offset); - - - return getRecordSize(); + + if ( ( field_1_option_flag & (short)0x20 ) != 0 ) { + LittleEndian.putShort(data, 2 + offset, (short)( 16 + field_13_raw_name_definition.length )); + + data [19 + offset] = field_12_builtIn_name; + System.arraycopy( field_13_raw_name_definition, 0, data, 20 + offset, field_13_raw_name_definition.length ); + + return 20 + field_13_raw_name_definition.length; + } + else { + LittleEndian.putShort(data, 2 + offset, (short)( 15 + getTextsLength())); + + + StringUtil.putCompressedUnicode(getNameText(), data , 19 + offset); + + int start_of_name_definition = 19 + field_3_length_name_text; + if (this.field_13_name_definition != null) { + serializePtgs(data, start_of_name_definition + offset); + } else { + System.arraycopy(field_13_raw_name_definition,0,data + ,start_of_name_definition + offset,field_13_raw_name_definition.length); + } + + int start_of_custom_menu_text = start_of_name_definition + field_4_length_name_definition; + StringUtil.putCompressedUnicode(getCustomMenuText(), data , start_of_custom_menu_text + offset); + + int start_of_description_text = start_of_custom_menu_text + field_8_length_description_text; + StringUtil.putCompressedUnicode(getDescriptionText(), data , start_of_description_text + offset); + + int start_of_help_topic_text = start_of_description_text + field_9_length_help_topic_text; + StringUtil.putCompressedUnicode(getHelpTopicText(), data , start_of_help_topic_text + offset); + + int start_of_status_bar_text = start_of_help_topic_text + field_10_length_status_bar_text; + StringUtil.putCompressedUnicode(getStatusBarText(), data , start_of_status_bar_text + offset); + + return getRecordSize(); + } } private void serializePtgs(byte [] data, int offset) { @@ -579,30 +594,53 @@ public class NameRecord extends Record { field_9_length_help_topic_text = data [12 + offset]; field_10_length_status_bar_text = data [13 + offset]; - field_11_compressed_unicode_flag= data [14 + offset]; - field_12_name_text = new String(data, 15 + offset, - LittleEndian.ubyteToInt(field_3_length_name_text)); - - int start_of_name_definition = 15 + field_3_length_name_text; - field_13_name_definition = getParsedExpressionTokens(data, field_4_length_name_definition, - offset, start_of_name_definition); - - int start_of_custom_menu_text = start_of_name_definition + field_4_length_name_definition; - field_14_custom_menu_text = new String(data, start_of_custom_menu_text + offset, - LittleEndian.ubyteToInt(field_7_length_custom_menu)); - - int start_of_description_text = start_of_custom_menu_text + field_8_length_description_text; - field_15_description_text = new String(data, start_of_description_text + offset, - LittleEndian.ubyteToInt(field_8_length_description_text)); - - int start_of_help_topic_text = start_of_description_text + field_9_length_help_topic_text; - field_16_help_topic_text = new String(data, start_of_help_topic_text + offset, - LittleEndian.ubyteToInt(field_9_length_help_topic_text)); - - int start_of_status_bar_text = start_of_help_topic_text + field_10_length_status_bar_text; - field_17_status_bar_text = new String(data, start_of_status_bar_text + offset, - LittleEndian.ubyteToInt(field_10_length_status_bar_text)); + + if ( ( field_1_option_flag & (short)0x20 ) != 0 ) { + // DEBUG + // System.out.println( "Built-in name" ); + + field_11_compressed_unicode_flag = data[ 14 + offset ]; + field_12_builtIn_name = data[ 15 + offset ]; + if ( (field_12_builtIn_name & (short)0x07) != 0 ) { + field_12_name_text = "Print_Titles"; + + // DEBUG + // System.out.println( field_12_name_text ); + + field_13_raw_name_definition = new byte[ field_4_length_name_definition ]; + System.arraycopy( data, 16 + offset, field_13_raw_name_definition, 0, field_13_raw_name_definition.length ); + + // DEBUG + // System.out.println( HexDump.toHex( field_13_raw_name_definition ) ); + } + } + else { + + field_11_compressed_unicode_flag= data [14 + offset]; + field_12_name_text = new String(data, 15 + offset, + LittleEndian.ubyteToInt(field_3_length_name_text)); + + int start_of_name_definition = 15 + field_3_length_name_text; + field_13_name_definition = getParsedExpressionTokens(data, field_4_length_name_definition, + offset, start_of_name_definition); + + int start_of_custom_menu_text = start_of_name_definition + field_4_length_name_definition; + field_14_custom_menu_text = new String(data, start_of_custom_menu_text + offset, + LittleEndian.ubyteToInt(field_7_length_custom_menu)); + + int start_of_description_text = start_of_custom_menu_text + field_8_length_description_text; + field_15_description_text = new String(data, start_of_description_text + offset, + LittleEndian.ubyteToInt(field_8_length_description_text)); + + int start_of_help_topic_text = start_of_description_text + field_9_length_help_topic_text; + field_16_help_topic_text = new String(data, start_of_help_topic_text + offset, + LittleEndian.ubyteToInt(field_9_length_help_topic_text)); + + int start_of_status_bar_text = start_of_help_topic_text + field_10_length_status_bar_text; + field_17_status_bar_text = new String(data, start_of_status_bar_text + offset, + LittleEndian.ubyteToInt(field_10_length_status_bar_text)); + } } private Stack getParsedExpressionTokens(byte [] data, short size, @@ -635,5 +673,101 @@ public class NameRecord extends Record { public short getSid() { return this.sid; } + /* + 20 00 + 00 + 01 + 1A 00 // sz = 0x1A = 26 + 00 00 + 01 00 + 00 + 00 + 00 + 00 + 00 // unicode flag + 07 // name + + 29 17 00 3B 00 00 00 00 FF FF 00 00 02 00 3B 00 //{ 26 + 00 07 00 07 00 00 00 FF 00 10 // } + + + + 20 00 + 00 + 01 + 0B 00 // sz = 0xB = 11 + 00 00 + 01 00 + 00 + 00 + 00 + 00 + 00 // unicode flag + 07 // name + + 3B 00 00 07 00 07 00 00 00 FF 00 // { 11 } + */ + /* + 18, 00, + 1B, 00, + + 20, 00, + 00, + 01, + 0B, 00, + 00, + 00, + 00, + 00, + 00, + 07, + 3B 00 00 07 00 07 00 00 00 FF 00 ] + */ + + /** + * @see Object#toString() + */ + public String toString() { + StringBuffer buffer = new StringBuffer(); + + buffer.append("[NAME]\n"); + buffer.append(" .option flags = ").append( HexDump.toHex( field_1_option_flag ) ) + .append("\n"); + buffer.append(" .keyboard shortcut = ").append( HexDump.toHex( field_2_keyboard_shortcut ) ) + .append("\n"); + buffer.append(" .length of the name = ").append( field_3_length_name_text ) + .append("\n"); + buffer.append(" .size of the formula data = ").append( field_4_length_name_definition ) + .append("\n"); + buffer.append(" .unused = ").append( field_5_index_to_sheet ) + .append("\n"); + buffer.append(" .( 0 = Global name, otherwise index to sheet (one-based) ) = ").append( field_6_equals_to_index_to_sheet ) + .append("\n"); + buffer.append(" .Length of menu text (character count) = ").append( field_7_length_custom_menu ) + .append("\n"); + buffer.append(" .Length of description text (character count) = ").append( field_8_length_description_text ) + .append("\n"); + buffer.append(" .Length of help topic text (character count) = ").append( field_9_length_help_topic_text ) + .append("\n"); + buffer.append(" .Length of status bar text (character count) = ").append( field_10_length_status_bar_text ) + .append("\n"); + buffer.append(" .Name (Unicode flag) = ").append( field_11_compressed_unicode_flag ) + .append("\n"); + buffer.append(" .Name (Unicode text) = ").append( field_12_name_text ) + .append("\n"); + buffer.append(" .Formula data (RPN token array without size field) = ").append( HexDump.toHex( field_13_raw_name_definition ) ) + .append("\n"); + buffer.append(" .Menu text (Unicode string without length field) = ").append( field_14_custom_menu_text ) + .append("\n"); + buffer.append(" .Description text (Unicode string without length field) = ").append( field_15_description_text ) + .append("\n"); + buffer.append(" .Help topic text (Unicode string without length field) = ").append( field_16_help_topic_text ) + .append("\n"); + buffer.append(" .Status bar text (Unicode string without length field) = ").append( field_17_status_bar_text ) + .append("\n"); + buffer.append("[/NAME]\n"); + + return buffer.toString(); + } } diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java index 89d4b1b18..27a188dcb 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java @@ -202,6 +202,9 @@ public class HSSFWorkbook // none currently } + public final static byte ENCODING_COMPRESSED_UNICODE = 0; + public final static byte ENCODING_UTF_16 = 1; + /** * set the sheet name. * @param sheet number (0 based) @@ -209,12 +212,28 @@ public class HSSFWorkbook */ public void setSheetName(int sheet, String name) + { + workbook.setSheetName( sheet, name, ENCODING_COMPRESSED_UNICODE ); + } + + public void setSheetName( int sheet, String name, short encoding ) { if (sheet > (sheets.size() - 1)) { throw new RuntimeException("Sheet out of bounds"); } - workbook.setSheetName(sheet, name); + + switch ( encoding ) { + case ENCODING_COMPRESSED_UNICODE: + case ENCODING_UTF_16: + break; + + default: + // TODO java.io.UnsupportedEncodingException + throw new RuntimeException( "Unsupported encoding" ); + } + + workbook.setSheetName( sheet, name, encoding ); } /** diff --git a/src/java/org/apache/poi/util/StringUtil.java b/src/java/org/apache/poi/util/StringUtil.java index b1b5bc841..059e36acd 100644 --- a/src/java/org/apache/poi/util/StringUtil.java +++ b/src/java/org/apache/poi/util/StringUtil.java @@ -62,8 +62,14 @@ import java.text.FieldPosition; /** * Title: String Utility Description: Collection of string handling utilities + * + * Now it is quite confusing: the method pairs, in which + * one of them write data and other read written data are: + * putUncompressedUnicodeHigh and getFromUnicode + * putUncompressedUnicode and getFromUnicodeHigh * *@author Andrew C. Oliver + *@author Sergei Kozello (sergeikozello at mail.ru) *@created May 10, 2002 *@version 1.0 */ @@ -79,6 +85,8 @@ public class StringUtil { * given a byte array of 16-bit unicode characters, compress to 8-bit and * return a string * + * { 0x16, 0x00 } -> 0x16 + * *@param string the byte array to be converted *@param offset the initial offset into the * byte array. it is assumed that string[ offset ] and string[ offset + @@ -103,22 +111,37 @@ public class StringUtil { if ((len < 0) || (((string.length - offset) / 2) < len)) { throw new IllegalArgumentException("Illegal length"); } - byte[] bstring = new byte[len]; - int index = offset; - // start with high bits. - - for (int k = 0; k < len; k++) { - bstring[k] = string[index]; - index += 2; + + char[] chars = new char[ len ]; + for ( int i = 0; i < chars.length; i++ ) { + chars[i] = (char)( string[ offset + ( 2*i ) ] + + ( string[ offset + ( 2*i+1 ) ] << 8 ) ); } - return new String(bstring); + + return new String( chars ); } + /** + * given a byte array of 16-bit unicode characters, compress to 8-bit and + * return a string + * + * { 0x16, 0x00 } -> 0x16 + * + *@param string the byte array to be converted + *@return the converted string + */ + + public static String getFromUnicodeHigh( final byte[] string ) { + return getFromUnicodeHigh( string, 0, string.length / 2 ); + } + /** * given a byte array of 16-bit unicode characters, compress to 8-bit and * return a string + * + * { 0x00, 0x16 } -> 0x16 * *@param string the byte array to be converted *@param offset the initial offset into the @@ -144,21 +167,23 @@ public class StringUtil { if ((len < 0) || (((string.length - offset) / 2) < len)) { throw new IllegalArgumentException("Illegal length"); } - byte[] bstring = new byte[len]; - int index = offset + 1; - // start with low bits. - for (int k = 0; k < len; k++) { - bstring[k] = string[index]; - index += 2; + + char[] chars = new char[ len ]; + for ( int i = 0; i < chars.length; i++ ) { + chars[i] = (char)( ( string[ offset + ( 2*i ) ] << 8 ) + + string[ offset + ( 2*i+1 ) ] ); } - return new String(bstring); + + return new String( chars ); } /** * given a byte array of 16-bit unicode characters, compress to 8-bit and * return a string + * + * { 0x00, 0x16 } -> 0x16 * *@param string the byte array to be converted *@return the converted string diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestCellStyle.java b/src/testcases/org/apache/poi/hssf/usermodel/TestCellStyle.java index af05f57b9..df578e51f 100644 --- a/src/testcases/org/apache/poi/hssf/usermodel/TestCellStyle.java +++ b/src/testcases/org/apache/poi/hssf/usermodel/TestCellStyle.java @@ -129,7 +129,6 @@ public class TestCellStyle out.close(); SanityChecker sanityChecker = new SanityChecker(); sanityChecker.checkHSSFWorkbook(wb); - assertEquals("FILE LENGTH == 87040", file.length(), 87040); // remove me assertEquals("LAST ROW == 99", 99, s.getLastRowNum()); assertEquals("FIRST ROW == 0", 0, s.getFirstRowNum()); @@ -169,7 +168,6 @@ public class TestCellStyle SanityChecker sanityChecker = new SanityChecker(); sanityChecker.checkHSSFWorkbook(wb); - assertEquals("FILE LENGTH ", 5632, file.length()); // remove me assertEquals("LAST ROW ", 0, s.getLastRowNum()); assertEquals("FIRST ROW ", 0, s.getFirstRowNum()); @@ -232,7 +230,6 @@ public class TestCellStyle out.close(); SanityChecker sanityChecker = new SanityChecker(); sanityChecker.checkHSSFWorkbook(wb); - assertEquals("FILE LENGTH == 87040", file.length(), 87040); // remove me assertEquals("LAST ROW == 99", 99, s.getLastRowNum()); assertEquals("FIRST ROW == 0", 0, s.getFirstRowNum()); diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestWorkbook.java b/src/testcases/org/apache/poi/hssf/usermodel/TestWorkbook.java index 0080d58e9..91edfffbc 100644 --- a/src/testcases/org/apache/poi/hssf/usermodel/TestWorkbook.java +++ b/src/testcases/org/apache/poi/hssf/usermodel/TestWorkbook.java @@ -142,8 +142,6 @@ public class TestWorkbook wb.write(out); out.close(); sanityChecker.checkHSSFWorkbook(wb); - assertEquals("FILE LENGTH == 87040", 87040, - file.length()); // remove me assertEquals("LAST ROW == 99", 99, s.getLastRowNum()); assertEquals("FIRST ROW == 0", 0, s.getFirstRowNum()); @@ -201,8 +199,6 @@ public class TestWorkbook out.close(); sanityChecker.checkHSSFWorkbook(wb); - assertEquals("FILE LENGTH == 45568", 45568, - file.length()); // remove assertEquals("LAST ROW == 74", 74, s.getLastRowNum()); assertEquals("FIRST ROW == 25", 25, s.getFirstRowNum()); } diff --git a/src/testcases/org/apache/poi/util/TestStringUtil.java b/src/testcases/org/apache/poi/util/TestStringUtil.java index c80bce432..02b7142a5 100644 --- a/src/testcases/org/apache/poi/util/TestStringUtil.java +++ b/src/testcases/org/apache/poi/util/TestStringUtil.java @@ -64,6 +64,7 @@ import java.text.NumberFormat; * * @author Marc Johnson (mjohnson at apache dot org * @author Glen Stampoultzis (glens at apache.org) + * @author Sergei Kozello (sergeikozello at mail.ru) */ public class TestStringUtil @@ -99,6 +100,48 @@ public class TestStringUtil StringUtil.getFromUnicode(test_data)); } + /** + * test simple form of getFromUnicode with symbols with code below and more 127 + */ + + public void testGetFromUnicodeSymbolsWithCodesMoreThan127() + { + byte[] test_data = new byte[] { 0x04, 0x22, + 0x04, 0x35, + 0x04, 0x41, + 0x04, 0x42, + 0x00, 0x20, + 0x00, 0x74, + 0x00, 0x65, + 0x00, 0x73, + 0x00, 0x74, + }; + + assertEquals("\u0422\u0435\u0441\u0442 test", + StringUtil.getFromUnicode(test_data)); + } + + /** + * test getFromUnicodeHigh for symbols with code below and more 127 + */ + + public void testGetFromUnicodeHighSymbolsWithCodesMoreThan127() + { + byte[] test_data = new byte[] { 0x22, 0x04, + 0x35, 0x04, + 0x41, 0x04, + 0x42, 0x04, + 0x20, 0x00, + 0x74, 0x00, + 0x65, 0x00, + 0x73, 0x00, + 0x74, 0x00, + }; + + assertEquals("\u0422\u0435\u0441\u0442 test", + StringUtil.getFromUnicodeHigh( test_data ) ); + } + /** * Test more complex form of getFromUnicode */