580 lines
18 KiB
Java
580 lines
18 KiB
Java
/* ====================================================================
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
this work for additional information regarding copyright ownership.
|
|
The ASF licenses this file to You 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 org.apache.poi.hssf.record;
|
|
|
|
import java.util.ArrayList;
|
|
import java.util.Collections;
|
|
import java.util.Iterator;
|
|
import java.util.List;
|
|
|
|
import org.apache.poi.hssf.record.cont.ContinuableRecordOutput;
|
|
import org.apache.poi.util.BitField;
|
|
import org.apache.poi.util.BitFieldFactory;
|
|
import org.apache.poi.util.HexDump;
|
|
import org.apache.poi.util.LittleEndianInput;
|
|
import org.apache.poi.util.LittleEndianOutput;
|
|
|
|
/**
|
|
* Title: Unicode String<p/>
|
|
* Description: Unicode String - just standard fields that are in several records.
|
|
* It is considered more desirable then repeating it in all of them.<p/>
|
|
* REFERENCE: PG 264 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
|
|
* @author Andrew C. Oliver
|
|
* @author Marc Johnson (mjohnson at apache dot org)
|
|
* @author Glen Stampoultzis (glens at apache.org)
|
|
*/
|
|
public final class UnicodeString implements Comparable {
|
|
private short field_1_charCount;
|
|
private byte field_2_optionflags;
|
|
private String field_3_string;
|
|
private List field_4_format_runs;
|
|
private byte[] field_5_ext_rst;
|
|
private static final BitField highByte = BitFieldFactory.getInstance(0x1);
|
|
private static final BitField extBit = BitFieldFactory.getInstance(0x4);
|
|
private static final BitField richText = BitFieldFactory.getInstance(0x8);
|
|
|
|
public static class FormatRun implements Comparable {
|
|
short character;
|
|
short fontIndex;
|
|
|
|
public FormatRun(short character, short fontIndex) {
|
|
this.character = character;
|
|
this.fontIndex = fontIndex;
|
|
}
|
|
|
|
public FormatRun(LittleEndianInput in) {
|
|
this(in.readShort(), in.readShort());
|
|
}
|
|
|
|
public short getCharacterPos() {
|
|
return character;
|
|
}
|
|
|
|
public short getFontIndex() {
|
|
return fontIndex;
|
|
}
|
|
|
|
public boolean equals(Object o) {
|
|
if (!(o instanceof FormatRun)) {
|
|
return false;
|
|
}
|
|
FormatRun other = ( FormatRun ) o;
|
|
|
|
return character == other.character && fontIndex == other.fontIndex;
|
|
}
|
|
|
|
public int compareTo(Object obj) {
|
|
FormatRun r = (FormatRun)obj;
|
|
if ((character == r.character) && (fontIndex == r.fontIndex))
|
|
return 0;
|
|
if (character == r.character)
|
|
return fontIndex - r.fontIndex;
|
|
else return character - r.character;
|
|
}
|
|
|
|
public String toString() {
|
|
return "character="+character+",fontIndex="+fontIndex;
|
|
}
|
|
|
|
public void serialize(LittleEndianOutput out) {
|
|
out.writeShort(character);
|
|
out.writeShort(fontIndex);
|
|
}
|
|
}
|
|
|
|
private UnicodeString() {
|
|
//Used for clone method.
|
|
}
|
|
|
|
public UnicodeString(String str)
|
|
{
|
|
setString(str);
|
|
}
|
|
|
|
|
|
|
|
public int hashCode()
|
|
{
|
|
int stringHash = 0;
|
|
if (field_3_string != null)
|
|
stringHash = field_3_string.hashCode();
|
|
return field_1_charCount + stringHash;
|
|
}
|
|
|
|
/**
|
|
* Our handling of equals is inconsistent with compareTo. The trouble is because we don't truely understand
|
|
* rich text fields yet it's difficult to make a sound comparison.
|
|
*
|
|
* @param o The object to compare.
|
|
* @return true if the object is actually equal.
|
|
*/
|
|
public boolean equals(Object o)
|
|
{
|
|
if (!(o instanceof UnicodeString)) {
|
|
return false;
|
|
}
|
|
UnicodeString other = (UnicodeString) o;
|
|
|
|
//OK lets do this in stages to return a quickly, first check the actual string
|
|
boolean eq = ((field_1_charCount == other.field_1_charCount)
|
|
&& (field_2_optionflags == other.field_2_optionflags)
|
|
&& field_3_string.equals(other.field_3_string));
|
|
if (!eq) return false;
|
|
|
|
//OK string appears to be equal but now lets compare formatting runs
|
|
if ((field_4_format_runs == null) && (other.field_4_format_runs == null))
|
|
//Strings are equal, and there are not formatting runs.
|
|
return true;
|
|
if (((field_4_format_runs == null) && (other.field_4_format_runs != null)) ||
|
|
(field_4_format_runs != null) && (other.field_4_format_runs == null))
|
|
//Strings are equal, but one or the other has formatting runs
|
|
return false;
|
|
|
|
//Strings are equal, so now compare formatting runs.
|
|
int size = field_4_format_runs.size();
|
|
if (size != other.field_4_format_runs.size())
|
|
return false;
|
|
|
|
for (int i=0;i<size;i++) {
|
|
FormatRun run1 = (FormatRun)field_4_format_runs.get(i);
|
|
FormatRun run2 = (FormatRun)other.field_4_format_runs.get(i);
|
|
|
|
if (!run1.equals(run2))
|
|
return false;
|
|
}
|
|
|
|
//Well the format runs are equal as well!, better check the ExtRst data
|
|
//Which by the way we dont know how to decode!
|
|
if ((field_5_ext_rst == null) && (other.field_5_ext_rst == null))
|
|
return true;
|
|
if (((field_5_ext_rst == null) && (other.field_5_ext_rst != null)) ||
|
|
((field_5_ext_rst != null) && (other.field_5_ext_rst == null)))
|
|
return false;
|
|
size = field_5_ext_rst.length;
|
|
if (size != field_5_ext_rst.length)
|
|
return false;
|
|
|
|
//Check individual bytes!
|
|
for (int i=0;i<size;i++) {
|
|
if (field_5_ext_rst[i] != other.field_5_ext_rst[i])
|
|
return false;
|
|
}
|
|
//Phew!! After all of that we have finally worked out that the strings
|
|
//are identical.
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* construct a unicode string record and fill its fields, ID is ignored
|
|
* @param in the RecordInputstream to read the record from
|
|
*/
|
|
public UnicodeString(RecordInputStream in) {
|
|
field_1_charCount = in.readShort();
|
|
field_2_optionflags = in.readByte();
|
|
|
|
int runCount = 0;
|
|
int extensionLength = 0;
|
|
//Read the number of rich runs if rich text.
|
|
if ( isRichText() )
|
|
{
|
|
runCount = in.readShort();
|
|
}
|
|
//Read the size of extended data if present.
|
|
if ( isExtendedText() )
|
|
{
|
|
extensionLength = in.readInt();
|
|
}
|
|
|
|
boolean isCompressed = ((field_2_optionflags & 1) == 0);
|
|
if (isCompressed) {
|
|
field_3_string = in.readCompressedUnicode(field_1_charCount);
|
|
} else {
|
|
field_3_string = in.readUnicodeLEString(field_1_charCount);
|
|
}
|
|
|
|
|
|
if (isRichText() && (runCount > 0)) {
|
|
field_4_format_runs = new ArrayList(runCount);
|
|
for (int i=0;i<runCount;i++) {
|
|
field_4_format_runs.add(new FormatRun(in));
|
|
}
|
|
}
|
|
|
|
if (isExtendedText() && (extensionLength > 0)) {
|
|
field_5_ext_rst = new byte[extensionLength];
|
|
for (int i=0;i<extensionLength;i++) {
|
|
field_5_ext_rst[i] = in.readByte();
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* get the number of characters in the string
|
|
*
|
|
*
|
|
* @return number of characters
|
|
*
|
|
*/
|
|
|
|
public short getCharCount()
|
|
{
|
|
return field_1_charCount;
|
|
}
|
|
|
|
/**
|
|
* set the number of characters in the string
|
|
* @param cc - number of characters
|
|
*/
|
|
|
|
public void setCharCount(short cc)
|
|
{
|
|
field_1_charCount = cc;
|
|
}
|
|
|
|
/**
|
|
* get the option flags which among other things return if this is a 16-bit or
|
|
* 8 bit string
|
|
*
|
|
* @return optionflags bitmask
|
|
*
|
|
*/
|
|
|
|
public byte getOptionFlags()
|
|
{
|
|
return field_2_optionflags;
|
|
}
|
|
|
|
/**
|
|
* set the option flags which among other things return if this is a 16-bit or
|
|
* 8 bit string
|
|
*
|
|
* @param of optionflags bitmask
|
|
*
|
|
*/
|
|
|
|
public void setOptionFlags(byte of)
|
|
{
|
|
field_2_optionflags = of;
|
|
}
|
|
|
|
/**
|
|
* @return the actual string this contains as a java String object
|
|
*/
|
|
public String getString()
|
|
{
|
|
return field_3_string;
|
|
}
|
|
|
|
/**
|
|
* set the actual string this contains
|
|
* @param string the text
|
|
*/
|
|
|
|
public void setString(String string)
|
|
{
|
|
field_3_string = string;
|
|
setCharCount((short)field_3_string.length());
|
|
// scan for characters greater than 255 ... if any are
|
|
// present, we have to use 16-bit encoding. Otherwise, we
|
|
// can use 8-bit encoding
|
|
boolean useUTF16 = false;
|
|
int strlen = string.length();
|
|
|
|
for ( int j = 0; j < strlen; j++ )
|
|
{
|
|
if ( string.charAt( j ) > 255 )
|
|
{
|
|
useUTF16 = true;
|
|
break;
|
|
}
|
|
}
|
|
if (useUTF16)
|
|
//Set the uncompressed bit
|
|
field_2_optionflags = highByte.setByte(field_2_optionflags);
|
|
else field_2_optionflags = highByte.clearByte(field_2_optionflags);
|
|
}
|
|
|
|
public int getFormatRunCount() {
|
|
if (field_4_format_runs == null)
|
|
return 0;
|
|
return field_4_format_runs.size();
|
|
}
|
|
|
|
public FormatRun getFormatRun(int index) {
|
|
if (field_4_format_runs == null)
|
|
return null;
|
|
if ((index < 0) || (index >= field_4_format_runs.size()))
|
|
return null;
|
|
return (FormatRun)field_4_format_runs.get(index);
|
|
}
|
|
|
|
private int findFormatRunAt(int characterPos) {
|
|
int size = field_4_format_runs.size();
|
|
for (int i=0;i<size;i++) {
|
|
FormatRun r = (FormatRun)field_4_format_runs.get(i);
|
|
if (r.character == characterPos)
|
|
return i;
|
|
else if (r.character > characterPos)
|
|
return -1;
|
|
}
|
|
return -1;
|
|
}
|
|
|
|
/** Adds a font run to the formatted string.
|
|
*
|
|
* If a font run exists at the current charcter location, then it is
|
|
* replaced with the font run to be added.
|
|
*/
|
|
public void addFormatRun(FormatRun r) {
|
|
if (field_4_format_runs == null)
|
|
field_4_format_runs = new ArrayList();
|
|
|
|
int index = findFormatRunAt(r.character);
|
|
if (index != -1)
|
|
field_4_format_runs.remove(index);
|
|
|
|
field_4_format_runs.add(r);
|
|
//Need to sort the font runs to ensure that the font runs appear in
|
|
//character order
|
|
Collections.sort(field_4_format_runs);
|
|
|
|
//Make sure that we now say that we are a rich string
|
|
field_2_optionflags = richText.setByte(field_2_optionflags);
|
|
}
|
|
|
|
public Iterator formatIterator() {
|
|
if (field_4_format_runs != null)
|
|
return field_4_format_runs.iterator();
|
|
return null;
|
|
}
|
|
|
|
public void removeFormatRun(FormatRun r) {
|
|
field_4_format_runs.remove(r);
|
|
if (field_4_format_runs.size() == 0) {
|
|
field_4_format_runs = null;
|
|
field_2_optionflags = richText.clearByte(field_2_optionflags);
|
|
}
|
|
}
|
|
|
|
public void clearFormatting() {
|
|
field_4_format_runs = null;
|
|
field_2_optionflags = richText.clearByte(field_2_optionflags);
|
|
}
|
|
|
|
|
|
void setExtendedRst(byte[] ext_rst) {
|
|
if (ext_rst != null)
|
|
field_2_optionflags = extBit.setByte(field_2_optionflags);
|
|
else field_2_optionflags = extBit.clearByte(field_2_optionflags);
|
|
this.field_5_ext_rst = ext_rst;
|
|
}
|
|
|
|
|
|
/**
|
|
* Swaps all use in the string of one font index
|
|
* for use of a different font index.
|
|
* Normally only called when fonts have been
|
|
* removed / re-ordered
|
|
*/
|
|
public void swapFontUse(short oldFontIndex, short newFontIndex) {
|
|
Iterator i = field_4_format_runs.iterator();
|
|
while(i.hasNext()) {
|
|
FormatRun run = (FormatRun)i.next();
|
|
if(run.fontIndex == oldFontIndex) {
|
|
run.fontIndex = newFontIndex;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* unlike the real records we return the same as "getString()" rather than debug info
|
|
* @see #getDebugInfo()
|
|
* @return String value of the record
|
|
*/
|
|
|
|
public String toString()
|
|
{
|
|
return getString();
|
|
}
|
|
|
|
/**
|
|
* return a character representation of the fields of this record
|
|
*
|
|
*
|
|
* @return String of output for biffviewer etc.
|
|
*
|
|
*/
|
|
|
|
public String getDebugInfo()
|
|
{
|
|
StringBuffer buffer = new StringBuffer();
|
|
|
|
buffer.append("[UNICODESTRING]\n");
|
|
buffer.append(" .charcount = ")
|
|
.append(Integer.toHexString(getCharCount())).append("\n");
|
|
buffer.append(" .optionflags = ")
|
|
.append(Integer.toHexString(getOptionFlags())).append("\n");
|
|
buffer.append(" .string = ").append(getString()).append("\n");
|
|
if (field_4_format_runs != null) {
|
|
for (int i = 0; i < field_4_format_runs.size();i++) {
|
|
FormatRun r = (FormatRun)field_4_format_runs.get(i);
|
|
buffer.append(" .format_run"+i+" = ").append(r.toString()).append("\n");
|
|
}
|
|
}
|
|
if (field_5_ext_rst != null) {
|
|
buffer.append(" .field_5_ext_rst = ").append("\n").append(HexDump.toHex(field_5_ext_rst)).append("\n");
|
|
}
|
|
buffer.append("[/UNICODESTRING]\n");
|
|
return buffer.toString();
|
|
}
|
|
|
|
public void serialize(ContinuableRecordOutput out) {
|
|
int numberOfRichTextRuns = 0;
|
|
int extendedDataSize = 0;
|
|
if (isRichText() && field_4_format_runs != null) {
|
|
numberOfRichTextRuns = field_4_format_runs.size();
|
|
}
|
|
if (isExtendedText() && field_5_ext_rst != null) {
|
|
extendedDataSize = field_5_ext_rst.length;
|
|
}
|
|
|
|
out.writeString(field_3_string, numberOfRichTextRuns, extendedDataSize);
|
|
|
|
if (numberOfRichTextRuns > 0) {
|
|
|
|
//This will ensure that a run does not split a continue
|
|
for (int i=0;i<numberOfRichTextRuns;i++) {
|
|
if (out.getAvailableSpace() < 4) {
|
|
out.writeContinue();
|
|
}
|
|
FormatRun r = (FormatRun)field_4_format_runs.get(i);
|
|
r.serialize(out);
|
|
}
|
|
}
|
|
|
|
if (extendedDataSize > 0) {
|
|
// OK ExtRst is actually not documented, so i am going to hope
|
|
// that we can actually continue on byte boundaries
|
|
|
|
int extPos = 0;
|
|
while (true) {
|
|
int nBytesToWrite = Math.min(extendedDataSize - extPos, out.getAvailableSpace());
|
|
out.write(field_5_ext_rst, extPos, nBytesToWrite);
|
|
extPos += nBytesToWrite;
|
|
if (extPos >= extendedDataSize) {
|
|
break;
|
|
}
|
|
out.writeContinue();
|
|
}
|
|
}
|
|
}
|
|
|
|
public int compareTo(Object obj)
|
|
{
|
|
UnicodeString str = ( UnicodeString ) obj;
|
|
|
|
int result = getString().compareTo(str.getString());
|
|
|
|
//As per the equals method lets do this in stages
|
|
if (result != 0)
|
|
return result;
|
|
|
|
//OK string appears to be equal but now lets compare formatting runs
|
|
if ((field_4_format_runs == null) && (str.field_4_format_runs == null))
|
|
//Strings are equal, and there are no formatting runs.
|
|
return 0;
|
|
|
|
if ((field_4_format_runs == null) && (str.field_4_format_runs != null))
|
|
//Strings are equal, but one or the other has formatting runs
|
|
return 1;
|
|
if ((field_4_format_runs != null) && (str.field_4_format_runs == null))
|
|
//Strings are equal, but one or the other has formatting runs
|
|
return -1;
|
|
|
|
//Strings are equal, so now compare formatting runs.
|
|
int size = field_4_format_runs.size();
|
|
if (size != str.field_4_format_runs.size())
|
|
return size - str.field_4_format_runs.size();
|
|
|
|
for (int i=0;i<size;i++) {
|
|
FormatRun run1 = (FormatRun)field_4_format_runs.get(i);
|
|
FormatRun run2 = (FormatRun)str.field_4_format_runs.get(i);
|
|
|
|
result = run1.compareTo(run2);
|
|
if (result != 0)
|
|
return result;
|
|
}
|
|
|
|
//Well the format runs are equal as well!, better check the ExtRst data
|
|
//Which by the way we don't know how to decode!
|
|
if ((field_5_ext_rst == null) && (str.field_5_ext_rst == null))
|
|
return 0;
|
|
if ((field_5_ext_rst == null) && (str.field_5_ext_rst != null))
|
|
return 1;
|
|
if ((field_5_ext_rst != null) && (str.field_5_ext_rst == null))
|
|
return -1;
|
|
|
|
size = field_5_ext_rst.length;
|
|
if (size != field_5_ext_rst.length)
|
|
return size - field_5_ext_rst.length;
|
|
|
|
//Check individual bytes!
|
|
for (int i=0;i<size;i++) {
|
|
if (field_5_ext_rst[i] != str.field_5_ext_rst[i])
|
|
return field_5_ext_rst[i] - str.field_5_ext_rst[i];
|
|
}
|
|
//Phew!! After all of that we have finally worked out that the strings
|
|
//are identical.
|
|
return 0;
|
|
}
|
|
|
|
private boolean isRichText()
|
|
{
|
|
return richText.isSet(getOptionFlags());
|
|
}
|
|
|
|
private boolean isExtendedText()
|
|
{
|
|
return extBit.isSet(getOptionFlags());
|
|
}
|
|
|
|
public Object clone() {
|
|
UnicodeString str = new UnicodeString();
|
|
str.field_1_charCount = field_1_charCount;
|
|
str.field_2_optionflags = field_2_optionflags;
|
|
str.field_3_string = field_3_string;
|
|
if (field_4_format_runs != null) {
|
|
str.field_4_format_runs = new ArrayList();
|
|
int size = field_4_format_runs.size();
|
|
for (int i = 0; i < size; i++) {
|
|
FormatRun r = (FormatRun) field_4_format_runs.get(i);
|
|
str.field_4_format_runs.add(new FormatRun(r.character, r.fontIndex));
|
|
}
|
|
}
|
|
if (field_5_ext_rst != null) {
|
|
str.field_5_ext_rst = new byte[field_5_ext_rst.length];
|
|
System.arraycopy(field_5_ext_rst, 0, str.field_5_ext_rst, 0,
|
|
field_5_ext_rst.length);
|
|
}
|
|
|
|
return str;
|
|
}
|
|
}
|