ArrayFields.java

//
// Copyright (C) 2006 United States Government as represented by the
// Administrator of the National Aeronautics and Space Administration
// (NASA).  All Rights Reserved.
//
// This software is distributed under the NASA Open Source Agreement
// (NOSA), version 1.3.  The NOSA has been approved by the Open Source
// Initiative.  See the file NOSA-1.3-JPF at the top of the distribution
// directory tree for the complete NOSA document.
//
// THE SUBJECT SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY OF ANY
// KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT
// LIMITED TO, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL CONFORM TO
// SPECIFICATIONS, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR
// A PARTICULAR PURPOSE, OR FREEDOM FROM INFRINGEMENT, ANY WARRANTY THAT
// THE SUBJECT SOFTWARE WILL BE ERROR FREE, OR ANY WARRANTY THAT
// DOCUMENTATION, IF PROVIDED, WILL CONFORM TO THE SUBJECT SOFTWARE.
//
package gov.nasa.jpf.vm;

import java.io.PrintStream;

import cmu.conditional.Conditional;
import de.fosd.typechef.featureexpr.FeatureExpr;
import gov.nasa.jpf.JPFException;

/**
 * a Field (data value) store for array objects
 */
public abstract class ArrayFields extends Fields {

	int getNumberOfFieldsOrElements() {
		return arrayLength().getValue(); // we have no fields
	}

	public abstract Conditional<Integer> arrayLength();

	public abstract int getHeapSize();

	public boolean isReferenceArray() {
		return false;
	}

	public int getNumberOfFields() {
		// has none
		return 0;
	}

	public void printElements(PrintStream ps, int max) {
		int len = arrayLength().getValue();
		if (max < 0)
			max = len;
		int i;
		for (i = 0; i < max; i++) {
			if (i > 0) {
				ps.print(',');
			}
			printValue(ps, i);
		}
		if (i < len) {
			ps.print("...");
		}
	}

	protected abstract void printValue(PrintStream ps, int idx);

	public abstract Conditional<?> getValues();// TODO ???

	@Override
	public Conditional<Boolean> getBooleanValue(int pos) {
		// overridden by subclass
		throw new JPFException("not a boolean[]");
	}

	@Override
	public Conditional<Byte> getByteValue(int pos) {
		// overridden by subclass
		throw new JPFException("not a byte[]");
	}

	@Override
	public Conditional<Character> getCharValue(int pos) {
		// overridden by subclass
		throw new JPFException("not a char[]");
	}

	@Override
	public Conditional<Short> getShortValue(int pos) {
		// overridden by subclass
		throw new JPFException("not a short[]");
	}

	@Override
	public Conditional<Integer> getIntValue(int pos) {
		// overridden by subclass
		throw new JPFException(getClass().getName() + " is not an int[]");
	}

	@Override
	public Conditional<Long> getLongValue(int pos) {
		// overridden by subclass
		throw new JPFException("not a long[]");
	}

	@Override
	public Conditional<Float> getFloatValue(int pos) {
		// overridden by subclass
		throw new JPFException("not a float[]");
	}

	@Override
	public Conditional<Double> getDoubleValue(int pos) {
		// overridden by subclass
		throw new JPFException("not a double[]");
	}

	@Override
	public Conditional<Integer> getReferenceValue(int pos) {
		// overridden by subclass
		throw new JPFException(getClass() + "not a reference array");
	}

	@Override
	public void setBooleanValue(FeatureExpr ctx, int pos, Conditional<Boolean> newValue) {
		// overridden by subclass
		throw new JPFException("not a boolean[]");
	}

	@Override
	public void setByteValue(FeatureExpr ctx, int pos, Conditional<Byte> newValue) {
		// overridden by subclass
		throw new JPFException("not a byte[]");
	}

	@Override
	public void setCharValue(FeatureExpr ctx, int pos, Conditional<Character> newValue) {
		// overridden by subclass
		throw new JPFException("not a char[]");
	}

	@Override
	public void setShortValue(FeatureExpr ctx, int pos, Conditional<Short> newValue) {
		// overridden by subclass
		throw new JPFException("not a short[]");
	}

	@Override
	public void setIntValue(FeatureExpr ctx, int index, Conditional<Integer> newValue) {
		// overridden by subclass
		throw new JPFException(getClass() + " not an int[]");
	}

	@Override
	public void setFloatValue(FeatureExpr ctx, int pos, Conditional<Float> newValue) {
		// overridden by subclass
		throw new JPFException("not a float[]");
	}

	@Override
	public void setLongValue(FeatureExpr ctx, int pos, Conditional<Long> newValue) {
		// overridden by subclass
		throw new JPFException(getClass() + " not a long[]");
	}

	@Override
	public void setDoubleValue(FeatureExpr ctx, int pos, Conditional<Double> newValue) {
		// overridden by subclass
		throw new JPFException("not a double[]");
	}

	@Override
	public void setReferenceValue(FeatureExpr ctx, int pos, Conditional<Integer> newValue) {
		// overridden by subclass
		throw new JPFException(getClass() + "not a reference array");
	}

	public Conditional<Boolean>[] asBooleanArray() {
		// overridden by subclass
		throw new JPFException("not a boolean[]");
	}

	// cpwTODO
	public Byte[] asByteArrayConcrete(FeatureExpr ctx) {
		// overridden by subclass
		throw new JPFException("not a byte[]");
	}

	public Conditional<Byte>[] asByteArray() {
		// overridden by subclass
		throw new JPFException("not a byte[]");
	}

	public Conditional<char[]> asCharArray() {
		// overridden by subclass
		throw new JPFException("not a char[]");
	}

	public Conditional<Short>[] asShortArray() {
		// overridden by subclass
		throw new JPFException("not a short[]");
	}

	public Integer[] asIntArrayConcrete() {
		// overridden by subclass
		throw new JPFException("not a int[]");
	}

	public Conditional<Integer>[] asIntArray() {
		// overridden by subclass
		throw new JPFException("not a int[]");
	}

	public Conditional<Integer>[] asReferenceArray() {
		// overridden by subclass
		throw new JPFException("not a reference array");
	}

	public Conditional<Long>[] asLongArray() {
		// overridden by subclass
		throw new JPFException("not a long[]");
	}

	public Conditional<Float>[] asFloatArray() {
		// overridden by subclass
		throw new JPFException("not a float[]");
	}

	public Conditional<Double>[] asDoubleArray() {
		// overridden by subclass
		throw new JPFException("not a double[]");
	}

	public int[] asFieldSlots() {// TODO
		throw new JPFException("array has no field slots");
	}

	public void fill(FeatureExpr ctx, Conditional<?> value) {
		throw new JPFException("fill not implemented for " + getClass().getName());
	}

	public void fill(FeatureExpr ctx, int from, int to, Conditional<?> value) {
		throw new JPFException("range-fill not implemented for " + getClass().getName());
	}

}