src/serialization/tag.hpp

/*
   Copyright (C) 2011 - 2018 by Sytyi Nick <nsytyi@gmail.com>
   Part of the Battle for Wesnoth Project https://www.wesnoth.org/

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY.

   See the COPYING file for more details.
*/

/**
 * @file
 * This file contains objects "tag" and "key", which are used to store
 * information about tags and keys while annotation parsing.
 */

#pragma once

#include <algorithm>
#include <iostream>
#include <map>
#include <sstream>
#include <string>

class config;

namespace schema_validation
{
/**
 * class_key is used to save the information about one key.
 * Key has next info: name, type, default value or key is mandatory.
 */
class class_key
{
public:
	class_key()
		: name_("")
		, type_("")
		, default_("\"\"")
		, mandatory_(false)
	{
	}

	class_key(const std::string& name, const std::string& type, const std::string& def = "\"\"")
		: name_(name)
		, type_(type)
		, default_(def)
		, mandatory_(def.empty())
	{
	}

	class_key(const config&);

	const std::string& get_name() const
	{
		return name_;
	}

	const std::string& get_type() const
	{
		return type_;
	}

	const std::string& get_default() const
	{
		return default_;
	}

	bool is_mandatory() const
	{
		return mandatory_;
	}

	void set_name(const std::string& name)
	{
		name_ = name;
	}

	void set_type(const std::string& type)
	{
		type_ = type;
	}

	void set_default(const std::string& def)
	{
		default_ = def;
		if(def.empty()) {
			mandatory_ = true;
		}
	}

	void set_mandatory(bool mandatory)
	{
		mandatory_ = mandatory;
	}

	/** is used to print key info
	 * the format is next
	 *  [key]
	 *      name="name"
	 *      type="type"
	 *      default="default"
	 *      mandatory="true/false"
	 *  [/key]
	 */
	void print(std::ostream& os, int level) const;

	/** Compares keys by name. Used in std::sort, i.e. */
	bool operator<(const class_key& k) const
	{
		return (get_name() < k.get_name());
	}

private:
	/** Name of key. */
	std::string name_;

	/** Type of key. */
	std::string type_;

	/** Default value. */
	std::string default_;

	/** Shows, if key is a mandatory key. */
	bool mandatory_;
};

/**
 * Stores information about tag.
 * Each tags is an element of great tag tree. This tree is close to filesystem:
 * you can use links and special include directory global/
 * Normally root is not mentioned in path.
 * Each tag has name, minimum and maximum occasions number,
 * and lists of subtags, keys and links.
 */
class class_tag
{
public:
	using tag_map  = std::map<std::string, class_tag>;
	using key_map  = std::map<std::string, class_key>;
	using link_map = std::map<std::string, std::string>;

	class_tag()
		: name_("")
		, min_(0)
		, max_(0)
		, super_("")
		, tags_()
		, keys_()
		, links_()
	{
	}

	class_tag(const std::string& name, int min, int max, const std::string& super = "")
		: name_(name)
		, min_(min)
		, max_(max)
		, super_(super)
		, tags_()
		, keys_()
		, links_()
	{
	}

	class_tag(const config&);

	~class_tag()
	{
	}

	/** Prints information about tag to outputstream, recursively
	 * is used to print tag info
	 * the format is next
	 *  [tag]
	 *      subtags
	 *      keys
	 *      name="name"
	 *      min="min"
	 *      max="max"
	 *  [/tag]
	 */
	void print(std::ostream& os);

	const std::string& get_name() const
	{
		return name_;
	}

	int get_min() const
	{
		return min_;
	}

	int get_max() const
	{
		return max_;
	}

	const std::string& get_super() const
	{
		return super_;
	}

	bool is_extension() const
	{
		return !super_.empty();
	}

	void set_name(const std::string& name)
	{
		name_ = name;
	}

	void set_min(int o)
	{
		min_ = o;
	}

	void set_max(int o)
	{
		max_ = o;
	}

	void set_min(const std::string& s)
	{
		std::istringstream i(s);
		if(!(i >> min_)) {
			min_ = 0;
		}
	}

	void set_max(const std::string& s)
	{
		std::istringstream i(s);
		if(!(i >> max_)) {
			max_ = 0;
		}
	}

	void set_super(const std::string& s)
	{
		super_ = s;
	}

	void add_key(const class_key& new_key)
	{
		keys_.emplace(new_key.get_name(), new_key);
	}

	void add_tag(const class_tag& new_tag)
	{
		tags_.emplace(new_tag.name_, new_tag);
	}

	void add_link(const std::string& link);

	/**
	 * Tags are usually organized in tree.
	 * This function helps to add a tag to his exact place in tree
	 * @param path - path in subtree to exact place of tag
	 * @param tag  - tag to add
	 * @param root - root of schema tree - use to support of adding to link.
	 * Path is getting shotter and shoter with each call.
	 * Path should look like tag1/tag2/parent/ Slash at end is mandatory.
	 */
	void add_tag(const std::string& path, const class_tag& tag, class_tag& root);

	bool operator<(const class_tag& t) const
	{
		return name_ < t.name_;
	}

	bool operator==(const class_tag& other) const
	{
		return name_ == other.name_;
	}

	/** Returns pointer to child key. */
	const class_key* find_key(const std::string& name) const;

	/** Returns pointer to child link. */
	const std::string* find_link(const std::string& name) const;

	/**
	 * Returns pointer to tag using full path to it.
	 * Also work with links
	 */
	const class_tag* find_tag(const std::string& fullpath, const class_tag& root) const;

	/** Calls the expansion on each child. */
	void expand_all(class_tag& root);

	const tag_map& tags() const
	{
		return tags_;
	}

	const key_map& keys() const
	{
		return keys_;
	}

	const link_map& links() const
	{
		return links_;
	}

	void remove_key_by_name(const std::string& name)
	{
		keys_.erase(name);
	}

	/** Removes all keys with this type. Works recursively */
	void remove_keys_by_type(const std::string& type);

#ifdef _MSC_VER
	// MSVC throws an error if this method is private.
	// so, define it as public to prevent that. The error is:
	// error C2248: 'schema_validation::class_tag::find_tag' : cannot
	// access private member declared in class 'schema_validation::class_tag'

	class_tag* find_tag(const std::string& fullpath, class_tag& root);
#endif

	// class_tag & operator= (const class_tag&);

private:
	/** name of tag. */
	std::string name_;

	/** number of minimum occasions. */
	int min_;

	/** number of maximum occasions. */
	int max_;

	/**
	 * name of tag to extend "super-tag"
	 * Extension is smth like inheritance and is used in case
	 * when you need to use another tag with all his
	 * keys, children, etc. But you also want to allow extra subtags of that tags,
	 * so just linking that tag wouldn't help at all.
	 */
	std::string super_;

	/** children tags*/
	tag_map tags_;

	/** keys*/
	key_map keys_;

	/** links to possible children. */
	link_map links_;

	/**
	 * the same as class_tag::print(std::ostream&)
	 * but indents different levels with step space.
	 * @param os stream to print
	 * @param level  current level of indentation
	 * @param step   step to next indent
	 */
	void printl(std::ostream& os, int level, int step = 4);

#ifndef _MSC_VER
	// this is complementary with the above #ifdef for the MSVC error
	class_tag* find_tag(const std::string& fullpath, class_tag& root);
#endif

	void add_tags(const tag_map& list)
	{
		tags_.insert(list.begin(), list.end());
	}

	void add_keys(const key_map& list)
	{
		keys_.insert(list.begin(), list.end());
	}

	void add_links(const link_map& list)
	{
		links_.insert(list.begin(), list.end());
	}

	/** Copies tags, keys and links of tag to this. */
	void append_super(const class_tag& tag, const std::string& super);

	/** Expands all "super" copying their data to this. */
	void expand(class_tag& root);
};
}