Theory.java

/*
 * tuProlog - Copyright (C) 2001-2007  aliCE team at deis.unibo.it
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package alice.tuprolog;

import java.io.IOException;
import java.io.InputStream;
import java.util.Iterator;

/**
 * This class represents prolog theory which can be provided
 * to a Prolog engine.
 *
 * Actually theory incapsulates only textual representation
 * of Prolog theories, without doing any check about validity.
 *
 * @see Prolog
 */
public class Theory {

	private String theory;
	private Struct clauseList;

	/**
	 * Creates a theory getting its source text from an input stream.
	 *
	 * @param is the input stream acting as source
	 */
	public Theory(InputStream is) throws IOException {
		byte[] info = new byte[is.available()];
		is.read(info);
		theory = new String(info);
	}

	/**
	 * Creates a theory from its source text.
	 *
	 * @param theory the source text
	 * @throws s InvalidTheoryException if theory is null
	 */
	public Theory(String theory) throws InvalidTheoryException {
		if (theory == null) {
			throw new InvalidTheoryException();
		}
		this.theory = theory;
	}
	
	Theory() {
		this.theory = "";
	}

	/**
	 * Creates a theory from a clause list.
	 *
	 * @param clauseList the source text
	 * @throws s InvalidTheoryException if clauseList is null or is not a prolog list
	 */
	public Theory(Struct clauseList) throws InvalidTheoryException {
		if (clauseList == null || !clauseList.isList())
			throw new InvalidTheoryException();
		this.clauseList = clauseList;
	}
	
	public Iterator<Term> iterator(Prolog engine) {
		if (isTextual())
			return new Parser(engine.getOperatorManager(), theory).iterator();
		else
			return clauseList.iterator();
	}

	/**
	 * Adds (appends) a theory to this.
	 *
	 * @param th is the theory to be appended
	 * @throws s InvalidTheoryException if the theory object are not compatibles (they are
	 *  compatibles when both have been built from texts or both from clause lists)
	 */
	public void append(Theory th) throws InvalidTheoryException {
		if (th.isTextual() && isTextual()) {
			theory += th.theory;
		} else if (!th.isTextual() && !isTextual()) {
			Struct otherClauseList = th.getClauseListRepresentation();
			if (clauseList.isEmptyList())
				clauseList = otherClauseList;
			else {
				Struct p = clauseList, q;
				while (!(q = (Struct) p.getArg(1)).isEmptyList())
					p = q;
				p.setArg(1, otherClauseList);
			}
		} else if (!isTextual() && th.isTextual()) {
			theory = theory.toString() + "\n" + th;
			clauseList = null;
		} else if (isTextual() && !th.isTextual()) {
			theory += th.toString();
		}
		else {
			throw new InvalidTheoryException();
		}
	}

	/**
	 * Checks if the theory has been built from a text or a clause list.
	 */
	boolean isTextual() {
		return theory != null;
	}

	Struct getClauseListRepresentation() {
		return clauseList;
	}

	@Override
	public String toString() {
		return theory != null ? theory : clauseList.toString();
	}

}