// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: options.C,v 1.27.14.2 2007/05/17 00:02:42 amoll Exp $ 
//

#include <BALL/DATATYPE/options.h>

#include <cstdlib>
#include <cerrno>
#include <cstdio>
#include <cmath>

#include <fstream>
#include <list>
#include <algorithm>

using namespace std;
using std::ofstream;
using std::ios;

namespace BALL 
{

	const Size Options::MAX_ENTRY_LENGTH = 1024;

	Options::Options()
		:	StringHashMap<String>(),
			name_("")
	{
	}

	Options::Options(const Options& options)
		:	StringHashMap<String>(options),
			name_(options.name_)
	{
	}

	Options::~Options()
	{
		clear();
	}

	void Options::addParameterDescription(const String& key, String description, ParamFile::ParameterType type, list<String>* allowed_values)
	{
		ParamFile::ParameterDescription td;
		td.name = key;
		td.description = description;
		td.type = type;
		if (allowed_values) td.allowed_values = *allowed_values;
		descriptions_.insert(make_pair(key, td));
	}

	const ParamFile::ParameterDescription* Options::getParameterDescription(const String& key) const
	{
		StringHashMap<ParamFile::ParameterDescription>::ConstIterator it = descriptions_.find(key);

		if (it == descriptions_.end())
		{
			return NULL;
		}
		else
		{
			return &it->second;
		}
	}

	Options* Options::createSubcategory(String name)
	{
		StringHashMap<Options*>::Iterator it = subcategories_.find(name);
		if (it == subcategories_.end())
		{
			Options* child_options = new Options;
			child_options->name_ = name;
			it = subcategories_.insert(make_pair(name, child_options)).first;
		}
		return it->second;
	}

	Options* Options::getSubcategory(String name)
	{
		StringHashMap<Options*>::Iterator it = subcategories_.find(name);
		if (it != subcategories_.end())
		{
			return it->second;
		}
		return NULL;
	}

	StringHashMap<Options*>::Iterator Options::beginSubcategories()
	{
		return subcategories_.begin();
	}

	StringHashMap<Options*>::Iterator Options::endSubcategories()
	{
		return subcategories_.end();
	}

	bool Options::isReal(const String& key) const
	{
		// an empty string is no real number
		const String& value = get(key);
		return (!value.isEmpty() && value.isFloat());
	}

	bool Options::isVector(const String& key) const 
	{
		// if the key does not exist - then the nonexistent value	
		// cannot contain a vector
		if (!has(key))
		{
			return false;
		}

		// try to interpret the string as three double values
		double dummy;
		return sscanf(get(key).c_str(), "(%lf %lf %lf)", &dummy, &dummy, &dummy) == 3;
	}

	bool Options::isBool(const String& key) const
	{
		String s = get(key);
		if (s == "")
		{
			return false;
		}

		s.toLower();
		return (s.compare("true") == 0 || s.compare("false") == 0);
	}
	
	bool Options::isSet(const String& key) const
	{
		return (StringHashMap<String>::find(key) != StringHashMap<String>::end());
	}
	
	bool Options::isInteger(const String& key) const 
	{
		// if it cannot be read as a floating point number
		// it cannot be an integer
		if (!isReal(key))
		{
			return false;
		}			
		
		// check wheter it is an integer
		long long_value = ::atol(get(key).c_str());
		double double_value   = ::atof(get(key).c_str());

		// check if it is an integer (cutoff is 1e-7)
		return fabs(double_value - ((double)long_value)) <= 1e-7;
	}


	double Options::getReal(const String& key) const
	{
		if (!has(key))
		{
			return 0.0;
		}
		double value;
		errno = 0;
		value = ::atof((*find(key)).second.c_str());
		
		if (errno == 0)
		{
			return value;
		} 
		else 
		{
			return 0.0;
		}
	}

	Vector3	Options::getVector(const String& key) const 
	{
		Vector3	h(0,0,0);
		
		if (!has(key))
		{
			return h;
		}
		
		// use temporary variables of double precision
		// this avoids trouble if the definition of 
		// Vector3 is changed between TVector3<float> and TVector3<double>
		double x, y, z;
		
		// try to interpret the option as a vector
		sscanf(get(key).c_str(), "(%lf %lf %lf)", &x, &y, &z);
		h.x = x; 
		h.y = y;
		h.z = z;

		return h;
	}


	bool Options::getBool(const String& key) const
	{
		if (!has(key))
		{
			return false;
		}

		ConstIterator it = find(key);
		return (it != end()) && (it->second == "true" || it->second == "1");
	}

	long Options::getInteger(const String& key) const
	{
		if (!has(key))
		{
			return 0;
		}

		long value;
		errno = 0;
		ConstIterator it = find(key);
		if (it == end())
		{
			return 0;
		}
		value = atol((*it).second.c_str());
		
		if (errno == 0)
		{
			return value;
		} 
		else 
		{
			errno = 0;
			return 0;
		}
	}

	void Options::set(const String& key, const String& value)
	{
		(*this)[key] = value;
	}

	void Options::setInteger(const String& key, const long value)
	{
		static char buffer[MAX_ENTRY_LENGTH + 1];
		sprintf(buffer, "%ld", value);			
		set(key, &(buffer[0]));
	}

	void Options::setReal(const String& key, const double value)
	{
		char buffer[MAX_ENTRY_LENGTH + 1];
		sprintf(buffer, "%f", value);
		set(key, buffer);
	}

	void Options::setVector(const String& key, const Vector3& value)
	{
		char buffer[MAX_ENTRY_LENGTH + 1];
		sprintf(buffer, "(%f %f %f)", value.x, value.y, value.z);
		set(key, buffer);
	}

	void Options::setBool(const String& key, const bool value)
	{
		if (value)
		{
			set(key, "true");
		}
		else
		{
			set(key, "false");
		}
	}

	String Options::setDefault(const String& key, const String& value)

	{
		if (!has(key))
		{
			set(key, value);
			return value;
		} 
		else 
		{
			return get(key);
		}
	}
		
	double Options::setDefaultReal(const String& key, const double value)
	{
		if (!has(key) || !isReal(key))
		{
			setReal(key, value);
			return value;
		} 
		else 
		{
			return getReal(key);
		}
	}

	bool Options::setDefaultBool(const String& key, const bool value)
	{
		if (!has(key) || !isBool(key))
		{
			setBool(key, value);
			return value;
		} 
		else 
		{
			return getBool(key);
		}
	}

	long Options::setDefaultInteger(const String& key, const long value)
	{
		if (!has(key) || !isInteger(key))
		{
			setInteger(key, value);
			return value;
		}
		else
		{
			return getInteger(key);
		}
	}

	void Options::setName(const String& name)
	{
		name_ = name;
	}

	const String& Options::getName() const
	{
		return name_;
	}

	String Options::get(const String& key) const
	{
		if (!has(key))
		{
			return "";
		}
		ConstIterator it = find(key);

		if (it == end())
		{
			return "";
		}
		else
		{
			return (*it).second;
		}
	}

	bool Options::readOptionFile(const String& filename)
	{
		ifstream	infile;
		infile.open(filename.c_str(), ios::in);
		if (!infile)
		{
			return false;
		}

		char		buffer[MAX_ENTRY_LENGTH + 1];
		String	s, key;
		while (infile.getline(buffer, MAX_ENTRY_LENGTH))
		{
			if ((buffer[0] != '#') && (buffer[0] != '!') && (buffer[0] != ';')) 
			{
				s = buffer;
				size_t i = 0;
				for(; i < s.length(); ++i) {
					if(s[i] == ' ' || s[i] == '\t') {
						break;
					}
				}

				key = s.left(i);

				while(i < s.length() && (s[i] == ' ' || s[i] == '\t')) ++i;

				if(i < s.length()) {
					s = s.getSubstring(i);
				} else {
					s = "";
				}

				set(key, s);
			}
		}
					
		infile.close();
		return true;
	}
		
	bool Options::writeOptionFile(const String& filename) const
	{
		std::list<String>		entry_list;
		String							entry;

		std::ofstream stream(filename.c_str());//, File::OUT);
		if (!stream.is_open())
		{
			return false;
		}

		stream << "![OptionsTable: " << getName() << " (" << size() << " entries)]" << endl;

		StringHashMap<String>::ConstIterator	it(begin());
		for(; !(it == end()); ++it)
		{
			entry = (*it).first + ' ' + (*it).second;
			entry_list.push_back(entry);
		}

		entry_list.sort();

		std::list<String>::iterator	list_it = entry_list.begin();
		for (; list_it != entry_list.end(); ++list_it) 
		{
	  	stream << *list_it << endl;
		}

		stream << "!-----------------------------------" << endl;
		
		stream.close();
		entry_list.clear();
		return true;
	}

	void Options::write(PersistenceManager& pm) const
	{
		std::list<String>		entry_list;
		String							entry;

		pm.writePrimitive(name_, "name_");
		pm.writePrimitive(size(), "size");

		StringHashMap<String>::ConstIterator it(begin());
		for (; it != end(); ++it)
		{
			entry = it->first + ' ' + it->second;
			entry_list.push_back(entry);
		}

		entry_list.sort();
		std::list<String>::iterator	list_it = entry_list.begin();
		for (; list_it != entry_list.end(); ++list_it) 
		{
	  	pm.writePrimitive(*list_it, "key/value");
		}
	}
	
	bool Options::read(PersistenceManager& pm)
	{
		clear();
		bool success = pm.readPrimitive(name_, "name_");
		Size size;
		success &= pm.readPrimitive(size, "size");

		String line;
		for (Size i=0; (i<size) && success; i++)
		{
			success &= pm.readPrimitive(line, "key/value");
			set(line.getField(0, " "), line.after(" "));
		}	

		return success;
	}

	void Options::dump(ostream& stream, Size /* depth */) const
	{
		std::list<String>		entry_list;
		String							entry;

		stream << "[OptionsTable: " << getName() << " (" << size() << " entries)]" << endl;

		StringHashMap<String>::ConstIterator	it(begin());
		for(; !(it == end()); ++it)
		{
			entry = (*it).first + ' ' + (*it).second;
			entry_list.push_back(entry);
		}

		entry_list.sort();

		std::list<String>::iterator	list_it = entry_list.begin();
		for (; list_it != entry_list.end(); ++list_it) 
		{
	  	stream << *list_it << endl;
		}

		stream << "-----------------------------------" << endl;

		entry_list.clear();
	}

	const Options& Options::operator = (const Options& options)
	{
		StringHashMap<String>::operator = (options);
		name_ = options.name_;

		return *this;
	}

	bool Options::operator == (const Options& option) const 
	{
		if (this->name_ != option.name_)
		{
			return false;
		}
		
		return StringHashMap<String>::operator == (option);
	}

	bool Options::operator != (const Options& option) const 
	{
		return !(*this == option);
	}

	void Options::clear()
	{
		name_ = "";
		StringHashMap<String>::clear();
		descriptions_.clear();

		for(StringHashMap<Options*>::iterator it = subcategories_.begin(); it != subcategories_.end(); it++)
		{
			delete it->second;
		}
		subcategories_.clear();
	}


} // namespace BALL