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

#include "tops/common/Printable.hpp"
#include "tops/system/progressive/ProgressiveHistory.hpp"

#include "tops/utilities/CloseContainer.hpp"

#include <string>

#include <boost/shared_ptr.hpp>

namespace tops {

	class Condition;
	typedef boost::shared_ptr<Condition> ConditionPtr;
	class Instance;
	typedef boost::shared_ptr<Instance> InstancePtr;
	class ProductionRule;
	class ProgressiveProductionSystem;
	class UnificatedAttributes;
	class UnificationState;
	typedef boost::shared_ptr<UnificationState> UnificationStatePtr;
	typedef boost::shared_ptr<UnificatedAttributes> UnificatedAttributesPtr;
	class Variables;
	class WMElement;

	class ProgressiveRule;
	typedef boost::shared_ptr<ProgressiveRule> ProgressiveRulePtr;

	/**
	 * 進行性プロダクションルールです。
	 *
	 * @author トゥイー
	 */
	class ProgressiveRule : public Printable, public Utility::CloseContainerElement {
	private:
		ProgressiveProductionSystem& m_system;

		ProgressiveHistory m_history;

		ProductionRule& m_rule;
		unsigned int m_progression;
		bool m_misfire;
		bool m_fired;
		UnificationStatePtr m_state;

	public:
		/**
		 * 全く発火していない状態で進行性プロダクションルールを構築します。
		 */
		ProgressiveRule(ProgressiveProductionSystem& system, ProductionRule& rule);

		/**
		 * 発火状態を進行させた進行性プロダクションルールを構築します。
		 */
		ProgressiveRule(
				ProgressiveProductionSystem& system,
				ProgressiveRule& parent,
				const UnificatedElementPtr& lastElement,
				const Variables& variables);

	public:
		/**
		 * プロダクションルールを取得します。
		 */
		ProductionRule& getProductionRule() const;

		/**
		 * 発火状態の変数表を取得します。
		 */
		const Variables& getVariables() const;

		/**
		 * 発火進行待ちしている条件を取得します。
		 */
		const ConditionPtr& getCondition() const;

		/**
		 * 発火しているかどうかを判断します。
		 */
		bool isFire() const;

		/**
		 * 発火に失敗したかどうかを取得します。
		 */
		bool isMisfire() const;

	public:
		/**
		 * 指定された事実と単一化を行います。
		 *
		 * @param element 単一化対象となるワーキングメモリ要素を指定します。
		 * @param variables 単一化に使用する変数表を指定します。
		 *
		 * @return 単一化に成功した場合は単一化済み属性列を、失敗した場合はNULLを返します。
		 */
		UnificatedAttributesPtr unificate(WMElement& element, Variables& variables);

		/**
		 * インスタンスを生成します。
		 */
		InstancePtr instantiate() const;

		/**
		 * 発火させます。
		 */
		bool fire();

	public:
		/**
		 * ストリームに出力します。
		 */
		void print(std::ostream& stream) const;
	};

}  // namespace tops

#endif
