/**
 * 最初の著者:: トゥイー
 * リポジトリ情報:: $Id: Unificator.hpp 11 2011-05-14 02:11:18Z yutaka_at_home $
 * 著作権:: Copyright (C) Ownway.info, 2011. All rights reserved.
 * ライセンス:: CPL(Common Public Licence)
 */

#ifndef _TOPS_UNIFICATOR_HPP_
#define _TOPS_UNIFICATOR_HPP_

#include "tops/UnificatedElements.hpp"
#include "tops/value/Variables.hpp"

#include <stack>

#include <boost/shared_array.hpp>
#include <boost/shared_ptr.hpp>

namespace tops {

	class ConditionPart;
	class UnificationState;
	typedef boost::shared_ptr<UnificationState> UnificationStatePtr;
	class UnificatorSub;
	class WorkingMemory;

	class Unificator;
	typedef boost::shared_ptr<Unificator> UnificatorPtr;

	/**
	 * 反復的に単一化を行う単一化反復子です。
	 *
	 * @author トゥイー
	 */
	class Unificator {
	private:
		typedef boost::shared_ptr<UnificatorSub> UnificatorSubPtr;
		typedef boost::shared_array<UnificatorSubPtr> UnificatorSubArray;

	private:
		/**
		 * 単一化対象となるワーキングメモリです。
		 */
		const WorkingMemory& m_workingMemory;

		/**
		 * 単一化対象となる条件です。
		 */
		ConditionPart& m_lhs;

		/**
		 * 単一化済み要素列です。
		 */
		UnificatedElements m_sources;

		/**
		 * 単一化に使用する変数表です。
		 */
		Variables& m_variables;

		/**
		 * 単一化に使用する単一化反復子（サブ）群です。
		 */
		std::stack<UnificatorSubPtr> m_unificators;

	public:
		/**
		 * 単一化反復子を構築します。
		 *
		 * @param workingMemory 単一化対象となるワーキングメモリを指定します。
		 * @param lhs 単一化対象となる条件を指定します。
		 * @param variables 単一化に使用する票数表を指定します。
		 */
		Unificator(const WorkingMemory& workingMemory, ConditionPart& lhs, Variables& variables);

	public:
		/**
		 * 単一化を行います。
		 *
		 * @param result 単一化に成功した場合は単一化状態を、失敗した場合はNULLを返します。
		 */
		UnificationStatePtr unificate();
	};

}  // namespace tops

#endif
