Jupiter-Bot/RenX.Core/RenX_Core.h

/**
 * Copyright (C) 2014 Justin James.
 *
 * This license must be preserved.
 * Any applications, libraries, or code which make any use of any
 * component of this program must not be commercial, unless explicit
 * permission is granted from the original author. The use of this
 * program for non-profit purposes is permitted.
 *
 * 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.
 *
 * In the event that this license restricts you from making desired use of this program, contact the original author.
 * Written by Justin James <justin.aj@hotmail.com>
 */

#if !defined _RENX_CORE_H_HEADER
#define _RENX_CORE_H_HEADER

/**
 * @file RenX_Core.h
 * @brief Provides Renegade-X RCON interaction.
 */

#include "Jupiter/Plugin.h"
#include "Jupiter/INIFile.h"
#include "RenX.h"

/** DLL Linkage Nagging */
#if defined _MSC_VER
#pragma warning(push)
#pragma warning(disable: 4251)
#endif

namespace RenX
{
	/** Forward delcarations */
	struct PlayerInfo;
	class Server;
	class Plugin;
	class GameCommand;

	/**
	* @brief Provides an interface for the Renegade-X RCON protocol.
	* The core manages the servers its connected to. Otherwise, it's
	* the same as any other Jupiter plugin.
	*/
	class RENX_API Core : public Jupiter::Plugin
	{
	public:

		/**
		* @brief Loops through the Renegade-X servers.
		* This should only be called by main().
		*
		* @return Result of Jupiter::Plugin::Think().
		*/
		virtual int think();

		/**
		* @brief Returns the name of the plugin.
		* @see Jupiter::Plugin::getName().
		*
		* @return Name of the plugin in a string.
		*/
		const Jupiter::ReadableString &getName() override { return name; }

		/**
		* @brief Sends a command to a specific server.
		*
		* @param server Server to send the command to.
		* @param data Command to send.
		* @return Number of bytes sent on success, less than or equal to 0 otherwise.
		*/
		int send(Server *server, const Jupiter::ReadableString &data);

		/**
		* @brief Sends a command to all servers of a specific type.
		*
		* @param type Server type to send the command to.
		* @param data Command to send.
		* @return Number of servers sent to on success, less than or equal to 0 otherwise.
		*/
		unsigned int send(int type, const Jupiter::ReadableString &data);

		/**
		* @brief Adds a server to the server list.
		*
		* @param server Server to add to the list.
		*/
		void addServer(RenX::Server *server);

		/**
		* @brief Fetches a server's index.
		*
		* @return Index of the server if it exists, -1 otherwise.
		*/
		int getServerIndex(RenX::Server *server);

		/**
		* @brief Fetches a server based on its index.
		*
		* @param index Index of the server
		* @return Server located at the specified index.
		*/
		RenX::Server *getServer(unsigned int index);

		/**
		* @brief Constructs a list of servers based on their type.
		*
		* @param type Type of servers to fetch.
		* @return ArrayList of servers with the same type.
		*/
		Jupiter::ArrayList<RenX::Server> getServers(int type);

		/**
		* @brief Removes a server based on its index.
		*
		* @param index Index of the server
		*/
		void removeServer(unsigned int index);

		/**
		* @brief Removes a server based on its data.
		*
		* @param server Server to be removed.
		* @return Index of the server removed.
		*/
		int removeServer(RenX::Server *server);

		/**
		* @brief Fetches the number of servers.
		*
		* @return Number of servers.
		*/
		unsigned int getServerCount();

		/**
		* @brief Fetches the Renegade-X plugins currently loaded.
		*
		* @return ArrayList containing pointers to the plugins.
		*/
		Jupiter::ArrayList<RenX::Plugin> *getPlugins();

		/**
		* @brief Fetches the translations override file.
		*
		* @return INIFile containing translations overrides.
		*/
		Jupiter::INIFile &getTranslationsFile();

		/**
		* @brief Copys a command, and passes it to each server.
		*
		* @param command Command to copy.
		* @return Number of commands added.
		*/
		int addCommand(GameCommand *command);

		/**
		* @brief Default constructor for the Core class.
		*/
		Core();

		/**
		* Destructor for the Core class.
		*/
		~Core();

	private:
		/** Inaccessible private members */
		STRING_LITERAL_AS_NAMED_REFERENCE(name, "RenX.Core");
		Jupiter::ArrayList<RenX::Server> servers;
		Jupiter::ArrayList<RenX::Plugin> plugins;
		Jupiter::INIFile translationsFile;
	};

	RENX_API Core *getCore();

}

/** Re-enable warnings */
#if defined _MSC_VER
#pragma warning(pop)
#endif

#endif // _RENX_CORE_H_HEADER