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

#include "tops/value/Value.hpp"

#include <string>

#include <boost/shared_ptr.hpp>

namespace tops {

	/**
	 * 変数です。
	 *
	 * @author トゥイー
	 */
	class Variable : public Value {
	private:
		/**
		 * 変数名です。
		 */
		std::string m_name;

	public:
		/**
		 * 変数を構築します。
		 *
		 * @param name 変数名を指定します。
		 */
		Variable(const std::string& name);

	public:
		/**
		 * 変数値が空かどうかを判断します。
		 *
		 * @return 空の場合はtrueを、空じゃない場合はfalseを返します。
		 */
		bool empty(const Variables& variables) const {
			return !getValue(variables);
		}

		/**
		 * 変数名を取得します。
		 */
		const std::string& getName() const {
			return m_name;
		}

		/**
		 * 変数値を取得します。
		 */
		const Constant* getValue(const Variables& variables) const;

	public:
		/**
		 * 指定された定数と単一化を行います。
		 *
		 * @param value 単一化対象となる定数を指定します。
		 * @param variables 単一化に使用する変数表を指定します。
		 * @return 単一化に成功したらtrueを、失敗したらfalseを返します。
		 */
		bool unificate(const Constant& value, Variables& variables) const;

		/**
		 * 値を具体化します。
		 *
		 * @param variables 具体化に使用する変数表を指定します。
		 */
		ConstantPtr instantiate(const Variables& variables) const;

	public:
		// ConditionVariableに由来する比較演算子群です。

		bool operator==(const ConstantAndVariables& a) const;
		bool operator!=(const ConstantAndVariables& a) const;
		bool operator< (const ConstantAndVariables& a) const;
		bool operator> (const ConstantAndVariables& a) const;
		bool operator<=(const ConstantAndVariables& a) const;
		bool operator>=(const ConstantAndVariables& a) const;

		// ここでは片方（value）が定数であることがわかったので、
		// 演算子の順番を「ひっくり返し」ます。

		bool operator==(const ValueAndVariables& a) const;
		bool operator!=(const ValueAndVariables& a) const;
		bool operator< (const ValueAndVariables& a) const;
		bool operator> (const ValueAndVariables& a) const;
		bool operator<=(const ValueAndVariables& a) const;
		bool operator>=(const ValueAndVariables& a) const;

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

	typedef boost::shared_ptr<Variable> VariablePtr;

}  // namespace tops

#endif
