/* Copyright 2016-2023 Dimitrij Mijoski
 *
 * This file is part of Nuspell.
 *
 * Nuspell is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Nuspell is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Nuspell.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef NUSPELL_AFF_DATA_HXX
#define NUSPELL_AFF_DATA_HXX

#include "nuspell_export.h"
#include "structures.hxx"

#include <iosfwd>
#include <unicode/locid.h>

namespace nuspell {
NUSPELL_BEGIN_INLINE_NAMESPACE

class Encoding {
	std::string name;

	NUSPELL_EXPORT auto normalize_name() -> void;

      public:
	enum Enc_Type { SINGLEBYTE = false, UTF8 = true };

	Encoding() = default;
	explicit Encoding(const std::string& e) : name(e) { normalize_name(); }
	explicit Encoding(std::string&& e) : name(move(e)) { normalize_name(); }
	explicit Encoding(const char* e) : name(e) { normalize_name(); }
	auto& operator=(const std::string& e)
	{
		name = e;
		normalize_name();
		return *this;
	}
	auto& operator=(std::string&& e)
	{
		name = move(e);
		normalize_name();
		return *this;
	}
	auto& operator=(const char* e)
	{
		name = e;
		normalize_name();
		return *this;
	}
	auto empty() const { return name.empty(); }
	auto& value() const { return name; }
	auto is_utf8() const { return name == "UTF-8"; }
	auto value_or_default() const -> std::string
	{
		if (name.empty())
			return "ISO8859-1";
		else
			return name;
	}
	operator Enc_Type() const { return is_utf8() ? UTF8 : SINGLEBYTE; }
};

enum class Flag_Type { SINGLE_CHAR, DOUBLE_CHAR, NUMBER, UTF8 };

/**
 * @internal
 * @brief Map between words and word_flags.
 *
 * Flags are stored as part of the container. Maybe for the future flags should
 * be stored elsewhere (flag aliases) and this should store pointers.
 *
 * Does not store morphological data as is low priority feature and is out of
 * scope.
 */
using Word_List = Hash_Multimap<std::string, Flag_Set>;

struct Aff_Data {
	static constexpr auto HIDDEN_HOMONYM_FLAG = char16_t(-1);
	static constexpr auto MAX_SUGGESTIONS = size_t(16);

	// spell checking options
	Word_List words;
	Prefix_Table prefixes;
	Suffix_Table suffixes;

	bool complex_prefixes;
	bool fullstrip;
	bool checksharps;
	bool forbid_warn;
	char16_t compound_onlyin_flag;
	char16_t circumfix_flag;
	char16_t forbiddenword_flag;
	char16_t keepcase_flag;
	char16_t need_affix_flag;
	char16_t warn_flag;

	// compounding options
	char16_t compound_flag;
	char16_t compound_begin_flag;
	char16_t compound_last_flag;
	char16_t compound_middle_flag;
	Compound_Rule_Table compound_rules;

	// spell checking options
	Break_Table break_table;
	Substr_Replacer input_substr_replacer;
	std::string ignored_chars;
	icu::Locale icu_locale;
	Substr_Replacer output_substr_replacer;

	// suggestion options
	Replacement_Table replacements;
	std::vector<Similarity_Group> similarities;
	std::string keyboard_closeness;
	std::string try_chars;
	// Phonetic_Table phonetic_table;

	char16_t nosuggest_flag;
	char16_t substandard_flag;
	unsigned short max_compound_suggestions;
	unsigned short max_ngram_suggestions;
	unsigned short max_diff_factor;
	bool only_max_diff;
	bool no_split_suggestions;
	bool suggest_with_dots;

	// compounding options
	unsigned short compound_min_length;
	unsigned short compound_max_word_count;
	char16_t compound_permit_flag;
	char16_t compound_forbid_flag;
	char16_t compound_root_flag;
	char16_t compound_force_uppercase;
	bool compound_more_suffixes;
	bool compound_check_duplicate;
	bool compound_check_rep;
	bool compound_check_case;
	bool compound_check_triple;
	bool compound_simplified_triple;
	bool compound_syllable_num;
	unsigned short compound_syllable_max;
	std::string compound_syllable_vowels;
	std::vector<Compound_Pattern> compound_patterns;

	// data members used only while parsing
	Flag_Type flag_type;
	Encoding encoding;
	std::vector<Flag_Set> flag_aliases;
	std::string wordchars; // deprecated?

	auto parse_aff(std::istream& in, std::ostream& err_msg) -> bool;
	auto parse_dic(std::istream& in, std::ostream& err_msg) -> bool;
	auto parse_aff_dic(std::istream& aff, std::istream& dic,
	                   std::ostream& err_msg)
	{
		if (parse_aff(aff, err_msg))
			return parse_dic(dic, err_msg);
		return false;
	}
};
NUSPELL_END_INLINE_NAMESPACE
} // namespace nuspell
#endif // NUSPELL_AFF_DATA_HXX
