/*
 * Copyright (C) 2002-2025 by the Widelands Development Team
 *
 * 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; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <https://www.gnu.org/licenses/>.
 *
 */

#ifndef WL_LOGIC_MESSAGE_H
#define WL_LOGIC_MESSAGE_H

#include "base/times.h"
#include "graphic/image_cache.h"
#include "logic/widelands.h"
#include "logic/widelands_geometry.h"

namespace Widelands {

struct Message {
	enum class Status : uint8_t { kNew, kRead, kArchived };
	enum class Type : uint8_t {
		kNoMessages,
		kAllMessages,

		kGameLogic,

		kGeologists,

		kScenario,

		kSeafaring,
		kEconomy,              // economy
		kEconomySiteOccupied,  // economy
		kWarfare,              // warfare messages
		kWarfareSiteDefeated,
		kWarfareSiteLost,
		kWarfareUnderAttack,
		kWarfareEnd = kWarfareUnderAttack,  // end of warfare messages

		kDiplomacyBegin,
		kDiplomacy = kDiplomacyBegin,
		kTrading,
		kDiplomacyEnd = kTrading,

		kEconomyLoadGame = 255,  // Only this type is allowed in game loading code,
		                         // must not be used elsewhere.
	};

	/**
	 * A new message to be displayed to the player
	 * \param msgtype    The type of message (economy, geologists, etc.)
	 * \param sent_time  The (game) time at which the message is sent
	 * \param init_title The intial message title
	 * \param init_body  The initial message body
	 * \param c          The message coords. The player will be able to position its view there.
	 *                   Defaults to Coords::null()
	 * \param ser        A MapObject serial. If non null, the message will be deleted once
	 *                   the object is removed from the game. Defaults to 0
	 * \param s          The message status. Defaults to Status::New
	 * \param subt       The extended message type, used for comparisons in
	 *                   Player::add_message_with_timeout(). Defaults to ""
	 */
	Message(Message::Type msgtype,
	        const Time& sent_time,
	        const std::string& init_title,
	        const std::string& init_icon_filename,
	        const std::string& init_heading,
	        const std::string& init_body,
	        const Widelands::Coords& c = Coords::null(),
	        Widelands::Serial ser = 0,
	        const std::string& subt = "",
	        Status s = Status::kNew)
	   : type_(msgtype),
	     sub_type_(subt),
	     title_(init_title),
	     icon_filename_(init_icon_filename),
	     icon_(g_image_cache->get(init_icon_filename)),
	     heading_(init_heading),
	     body_(init_body),
	     sent_(sent_time),
	     position_(c),
	     serial_(ser),
	     status_(s) {
	}

	[[nodiscard]] Message::Type type() const {
		return type_;
	}
	[[nodiscard]] const std::string& sub_type() const {
		return sub_type_;
	}
	[[nodiscard]] const Time& sent() const {
		return sent_;
	}
	[[nodiscard]] const std::string& title() const {
		return title_;
	}
	[[nodiscard]] const std::string& icon_filename() const {
		return icon_filename_;
	}
	[[nodiscard]] const Image* icon() const {
		return icon_;
	}
	[[nodiscard]] const std::string& heading() const {
		return heading_;
	}
	[[nodiscard]] const std::string& body() const {
		return body_;
	}
	[[nodiscard]] const Widelands::Coords& position() const {
		return position_;
	}
	[[nodiscard]] Widelands::Serial serial() const {
		return serial_;
	}
	[[nodiscard]] Status status() const {
		return status_;
	}
	Status set_status(Status const s) {
		return status_ = s;
	}

	/**
	 * Returns the main type for the message's sub type
	 */
	[[nodiscard]] Message::Type message_type_category() const {
		if (type_ >= Widelands::Message::Type::kWarfare &&
		    type_ <= Widelands::Message::Type::kWarfareEnd) {
			return Widelands::Message::Type::kWarfare;
		}
		if (type_ >= Widelands::Message::Type::kDiplomacyBegin &&
		    type_ <= Widelands::Message::Type::kDiplomacyEnd) {
			return Widelands::Message::Type::kDiplomacy;
		}
		if (type_ == Widelands::Message::Type::kEconomy ||
		    type_ == Widelands::Message::Type::kEconomySiteOccupied ||
		    type_ == Widelands::Message::Type::kEconomyLoadGame) {
			return Widelands::Message::Type::kEconomy;
		}
		return type_;
	}

	[[nodiscard]] bool allowed_during_game_loading() const {
		return type_ == Widelands::Message::Type::kEconomyLoadGame;
	}

private:
	Message::Type type_;
	const std::string sub_type_;
	const std::string title_;
	const std::string icon_filename_;
	const Image* icon_;  // Pointer to icon into picture stack
	const std::string heading_;
	const std::string body_;
	Time sent_;
	Widelands::Coords position_;
	Widelands::Serial serial_;  // serial to map object
	Status status_;
};

}  // namespace Widelands

#endif  // end of include guard: WL_LOGIC_MESSAGE_H