/**
 * 最初の著者:: トゥイー
 * リポジトリ情報:: $Id: UnificatorToRuleBase.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_TO_RULE_BASE_HPP_
#define _TOPS_UNIFICATOR_TO_RULE_BASE_HPP_

#include "tops/system/progressive/ProgressiveRule.hpp"
#include "tops/system/progressive/ProgressiveRuleBase.hpp"

#include <map>
#include <string>

namespace tops {

	/**
	 * 反復的に単一化を行う単一化反復子です。
	 *
	 * @author トゥイー
	 */
	class UnificatorToRuleBase {
	private:
		typedef ProgressiveRuleBase::mapIterator iterator;
		typedef ProgressiveRuleBase::const_mapIterator const_iterator;

	private:
		const ProgressiveRuleBase& ruleBase_;

		/**
		 * 単一化対象となるワーキングメモリ要素です。
		 */
		WMElement& element_;

		/**
		 * 現在の反復子です。
		 */
		const_iterator iterator_, end_;

	public:
		/**
		 * 単一化反復子を構築します。
		 *
		 * @param ruleBase 単一化対象となる進行性ルールベースを指定します。
		 * @param element 単一化対象となるワーキングメモリ要素を指定します。
		 */
		UnificatorToRuleBase(const ProgressiveRuleBase& ruleBase, WMElement& element);

	public:
		/**
		 * 単一化を行います。
		 *
		 * @param progressiveRule 単一化に成功した場合は単一化したルールを返します。そうでない場合は不定です。
		 * @param variables 単一化に使用する変数表を指定します。
		 *
		 * @return 単一化に成功した場合は単一化したワーキングメモリ要素を、そうでない場合はNULLを返します。
		 */
		UnificatedElementPtr unificate(ProgressiveRulePtr& progressiveRule, Variables& variables);

	public:
		/**
		 * 単一化を行います。
		 *
		 * @return 単一化に成功した場合はtrueを、失敗した場合はfalseを返します。
		 */
		bool unificate();
	};

}  // namespace tops

#endif
