poi/src/scratchpad/src/org/apache/poi/hslf/model/textproperties/TextPropCollection.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.hslf.model.textproperties;

import java.io.IOException;
import java.io.OutputStream;
import java.util.LinkedList;

import org.apache.poi.hslf.record.StyleTextPropAtom;
import org.apache.poi.util.LittleEndian;

/**
 * For a given run of characters, holds the properties (which could
 *  be paragraph properties or character properties).
 * Used to hold the number of characters affected, the list of active
 *  properties, and the random reserved field if required.
 */
public class TextPropCollection {
	private int charactersCovered;
	private short reservedField;
	private LinkedList textPropList;

	/** Fetch the number of characters this styling applies to */
	public int getCharactersCovered() { return charactersCovered; }
	/** Fetch the TextProps that define this styling */
	public LinkedList getTextPropList() { return textPropList; }
	
	/** Fetch the TextProp with this name, or null if it isn't present */
	public TextProp findByName(String textPropName) {
		for(int i=0; i<textPropList.size(); i++) {
			TextProp prop = (TextProp)textPropList.get(i);
			if(prop.getName().equals(textPropName)) {
				return prop;
			}
		}
		return null;
	}
	
	/** Add the TextProp with this name to the list */
	public TextProp addWithName(String name) {
		// Find the base TextProp to base on
		TextProp base = null;
		for(int i=0; i < StyleTextPropAtom.characterTextPropTypes.length; i++) {
			if(StyleTextPropAtom.characterTextPropTypes[i].getName().equals(name)) {
				base = StyleTextPropAtom.characterTextPropTypes[i];
			}
		}
		for(int i=0; i < StyleTextPropAtom.paragraphTextPropTypes.length; i++) {
			if(StyleTextPropAtom.paragraphTextPropTypes[i].getName().equals(name)) {
				base = StyleTextPropAtom.paragraphTextPropTypes[i];
			}
		}
		if(base == null) {
			throw new IllegalArgumentException("No TextProp with name " + name + " is defined to add from");
		}
		
		// Add a copy of this property, in the right place to the list
		TextProp textProp = (TextProp)base.clone();
		int pos = 0;
		for(int i=0; i<textPropList.size(); i++) {
			TextProp curProp = (TextProp)textPropList.get(i);
			if(textProp.getMask() > curProp.getMask()) {
				pos++;
			}
		}
		textPropList.add(pos, textProp);
		return textProp;
	}

	/**
	 * For an existing set of text properties, build the list of 
	 *  properties coded for in a given run of properties.
	 * @return the number of bytes that were used encoding the properties list
	 */
	public int buildTextPropList(int containsField, TextProp[] potentialProperties, byte[] data, int dataOffset) {
		int bytesPassed = 0;

		// For each possible entry, see if we match the mask
		// If we do, decode that, save it, and shuffle on
		for(int i=0; i<potentialProperties.length; i++) {
			// Check there's still data left to read
			if(dataOffset+bytesPassed >= data.length) {
				// Out of data, can't be any more properties to go
				return bytesPassed;
			}
			
			// Check if this property is found in the mask
			if((containsField & potentialProperties[i].getMask()) != 0) {
				// Bingo, data contains this property
				TextProp prop = (TextProp)potentialProperties[i].clone();
				int val = 0;
				if(prop.getSize() == 2) {
					val = LittleEndian.getShort(data,dataOffset+bytesPassed);
				} else {
					val = LittleEndian.getInt(data,dataOffset+bytesPassed);
				}
				prop.setValue(val);
				bytesPassed += prop.getSize();
				textPropList.add(prop);
			}
		}

		// Return how many bytes were used
		return bytesPassed;
	}

	/**
	 * Create a new collection of text properties (be they paragraph
	 *  or character) which will be groked via a subsequent call to
	 *  buildTextPropList().
	 */
	public TextPropCollection(int charactersCovered, short reservedField) {
		this.charactersCovered = charactersCovered;
		this.reservedField = reservedField;
		textPropList = new LinkedList();
	}

	/**
	 * Create a new collection of text properties (be they paragraph
	 *  or character) for a run of text without any
	 */
	public TextPropCollection(int textSize) {
		charactersCovered = textSize;
		reservedField = -1;
		textPropList = new LinkedList();
	}
	
	/**
	 * Update the size of the text that this set of properties
	 *  applies to 
	 */
	public void updateTextSize(int textSize) {
		charactersCovered = textSize;
	}

	/**
	 * Writes out to disk the header, and then all the properties
	 */
	public void writeOut(OutputStream o) throws IOException {
		// First goes the number of characters we affect
		StyleTextPropAtom.writeLittleEndian(charactersCovered,o);

		// Then we have the reserved field if required
		if(reservedField > -1) {
			StyleTextPropAtom.writeLittleEndian(reservedField,o);
		}

		// The the mask field
		int mask = 0;
		for(int i=0; i<textPropList.size(); i++) {
			TextProp textProp = (TextProp)textPropList.get(i);
			mask += textProp.getWriteMask();
		}
		StyleTextPropAtom.writeLittleEndian(mask,o);

		// Then the contents of all the properties
		for(int i=0; i<textPropList.size(); i++) {
			TextProp textProp = (TextProp)textPropList.get(i);
			int val = textProp.getValue();
			if(textProp.getSize() == 2) {
				StyleTextPropAtom.writeLittleEndian((short)val,o);
			} else {
				StyleTextPropAtom.writeLittleEndian(val,o);
			}
		}
	}

    public short getReservedField(){
        return reservedField;
    }

    public void setReservedField(short val){
        reservedField = val;
    }
}