/*
 * \brief  Domain registry
 * \author Norman Feske
 * \date   2014-06-12
 */

/*
 * Copyright (C) 2014 Genode Labs GmbH
 *
 * This file is part of the Genode OS framework, which is distributed
 * under the terms of the GNU General Public License version 2.
 */

#ifndef _DOMAIN_REGISTRY_
#define _DOMAIN_REGISTRY_

#include <util/xml_node.h>
#include <util/color.h>

class Domain_registry
{
	public:

		class Entry : public Genode::List<Entry>::Element
		{
			public:

				typedef Genode::String<64> Name;
				typedef Genode::Color      Color;

				/**
				 * Behaviour of the views of the domain when X-ray is activated
				 */
				enum Xray {
					XRAY_NO,     /* views are not subjected to X-ray mode */
					XRAY_FRAME,  /* views are tinted and framed */
					XRAY_OPAQUE, /* views are replaced by opaque domain color */
				};

				/**
				 * Origin of the domain's coordiate system
				 */
				enum Origin { ORIGIN_POINTER, ORIGIN_SCREEN };

			private:

				Name     _name;
				Color    _color;
				Xray     _xray;
				Origin   _origin;
				unsigned _layer;

				friend class Domain_registry;

				Entry(Name const &name, Color color, Xray xray, Origin origin,
				      unsigned layer)
				:
					_name(name), _color(color), _xray(xray), _origin(origin),
					_layer(layer)
				{ }

			public:

				bool has_name(Name const &name) const { return name == _name; }

				Color color() const { return _color; }

				unsigned layer() const { return _layer; }

				bool xray_opaque()    const { return _xray == XRAY_OPAQUE; }
				bool xray_no()        const { return _xray == XRAY_NO; }
				bool origin_pointer() const { return _origin == ORIGIN_POINTER; }
		};

		static Entry::Xray _xray(Genode::Xml_node domain)
		{
			char const * const attr_name = "xray";

			Entry::Xray const default_xray = Entry::XRAY_FRAME;

			if (!domain.has_attribute(attr_name))
				return default_xray;

			Genode::Xml_node::Attribute const attr = domain.attribute(attr_name);

			if (attr.has_value("no"))     return Entry::XRAY_NO;
			if (attr.has_value("frame"))  return Entry::XRAY_FRAME;
			if (attr.has_value("opaque")) return Entry::XRAY_OPAQUE;

			PWRN("invalid value of xray attribute");
			return default_xray;
		}

		Entry::Origin _origin(Genode::Xml_node domain)
		{
			char const * const attr_name = "origin";

			Entry::Origin const default_origin = Entry::ORIGIN_SCREEN;

			if (!domain.has_attribute(attr_name))
				return default_origin;

			Genode::Xml_node::Attribute const attr = domain.attribute(attr_name);

			if (attr.has_value("screen"))  return Entry::ORIGIN_SCREEN;
			if (attr.has_value("pointer")) return Entry::ORIGIN_POINTER;

			PWRN("invalid value of origin attribute");
			return default_origin;
		}

		void _insert(Genode::Xml_node domain)
		{
			char buf[sizeof(Entry::Name)];
			buf[0] = 0;
			bool name_defined = false;
			try {
				domain.attribute("name").value(buf, sizeof(buf));
				name_defined = true;
			} catch (...) { }

			if (!name_defined) {
				PERR("no valid domain name specified");
				return;
			}

			Entry::Name const name(buf);

			if (lookup(name)) {
				PERR("domain name \"%s\" is not unique", name.string());
				return;
			}

			if (!domain.has_attribute("layer")) {
				PERR("no layer specified for domain \"%s\"", name.string());
				return;
			}

			unsigned const layer = domain.attribute_value("layer", ~0UL);

			Entry::Color const color = domain.attribute_value("color", WHITE);

			_entries.insert(new (_alloc) Entry(name, color, _xray(domain),
			                                   _origin(domain), layer));
		}

	private:

		Genode::List<Entry> _entries;
		Genode::Allocator  &_alloc;

	public:

		Domain_registry(Genode::Allocator &alloc, Genode::Xml_node config)
		:
			_alloc(alloc)
		{
			char const *type = "domain";

			if (!config.has_sub_node(type))
				return;

			Genode::Xml_node domain = config.sub_node(type);

			for (;; domain = domain.next(type)) {

				_insert(domain);

				if (domain.is_last(type))
					break;
			}
		}

		~Domain_registry()
		{
			while (Entry *e = _entries.first())
				Genode::destroy(_alloc, e);
		}

		Entry const *lookup(Entry::Name const &name) const
		{
			for (Entry const *e = _entries.first(); e; e = e->next())
				if (e->has_name(name))
					return e;
			return 0;
		}
};

#endif /* _DOMAIN_REGISTRY_ */