libki/include/ki/dml/Record.h

#pragma once
#include "FieldBase.h"
#include "Field.h"

namespace ki
{
namespace dml
{
	/**
	 * An ordered collection of DML fields.
	 */
	class Record final : public util::Serializable
	{
	public:
		Record();
		Record(const Record &record);
		virtual ~Record();

		/**
		 * Returns true if a field of any type has the name
		 * specified.
		 */
		bool has_field(std::string name) const;

		/**
		 * Returns true if a field exists with the specified
		 * name and type.
		 */
		template <typename ValueT>
		bool has_field(std::string name) const
		{
			if (!has_field(name))
				return false;
			return m_field_map.at(name)->is_type<ValueT>();
		}

		FieldBase *get_field(std::string name);
		const FieldBase *get_field(std::string name) const;

		/**
		* Returns a previously added field with the specified name
		* and type.
		*
		* If the field was not previously added, then a nullptr is
		* returned.
		*/
		template <typename ValueT>
		Field<ValueT> *get_field(std::string name)
		{
			if (has_field<ValueT>(name))
				return dynamic_cast<Field<ValueT> *>(m_field_map.at(name));
			return nullptr;
		}

		/**
		 * Returns a previously added field with the specified name
		 * and type.
		 * 
		 * If the field was not previously added, then a nullptr is
		 * returned.
		 */
		template <typename ValueT>
		const Field<ValueT> *get_field(std::string name) const
		{
			if (has_field<ValueT>(name))
				return dynamic_cast<Field<ValueT> *>(m_field_map.at(name));
			return nullptr;
		}

		/**
		 * Adds a new field to the record with the specified name, type,
		 * and transferability, and returns the newly created field.
		 * 
		 * If a field already exists with the specified name and type,
		 * then the previously added field is returned.
		 * 
		 * If a field already exists with the specified name, but the type
		 * differs, then a nullptr is returned.
		 */
		template <typename ValueT>
		Field<ValueT> *add_field(std::string name, bool transferable = true)
		{
			// Does this field already exist?
			if (has_field(name))
			{
				// Return nullptr if the type is not the same
				auto *field = m_field_map.at(name);
				if (!field->is_type<ValueT>())
					return nullptr;
				return dynamic_cast<Field<ValueT> *>(field);
			}

			// Create the field
			auto *field = new Field<ValueT>(name);
			field->m_transferable = transferable;
			add_field(field);
			return field;
		}

		template <typename ValueT>
		Field<ValueT>* add_field(std::string name, size_t bit_count, bool transferable = true) {
			// Does this field already exist?
			if (has_field(name)) {
				// Return nullptr if the type is not the same
				auto* field = m_field_map.at(name);
				if (!field->is_type<ValueT>())
					return nullptr;
				return dynamic_cast<Field<ValueT>*>(field);
			}

			// Create the field
			auto* field = new Field<ValueT>(name);
			field->m_transferable = transferable;
			field->m_bit_count = bit_count;
			add_field(field);
			return field;
		}

		size_t get_field_count() const;

		FieldList::const_iterator fields_begin() const;
		FieldList::const_iterator fields_end() const;

		FieldList::iterator fields_begin();
		FieldList::iterator fields_end();

		void write_to(std::ostream &ostream) const override final;
		void read_from(std::istream &istream) override final;
		size_t get_size() const override final;

		/**
		* Creates an XML node from this record's data.
		*
		* The document is only used to allocate necessary resources, and
		* so the returned node has not been appended to the document.
		*/
		rapidxml::xml_node<> *as_xml(rapidxml::xml_document<> &doc) const;

		/**
		* Loads data from an XML Record node into this record.
		* 
		* If a Field already exists, and the type is the same,
		* then the new value is copied into the original Field.
		* If the type is not the same, then the original Field
		* is deleted, and replaced with the new one.
		*/
		void from_xml(rapidxml::xml_node<> *node);
	private:
		FieldList m_fields;
		FieldNameMap m_field_map;

		void add_field(FieldBase *field);
	};
}
}