.. index:: pair: class; EE::System::Log
.. _doxid-class_e_e_1_1_system_1_1_log:

class EE::System::Log
=====================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Global log file. The engine will log everything in this file. :ref:`More...<details-class_e_e_1_1_system_1_1_log>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <log.hpp>
	
	class Log: protected :ref:`EE::System::Mutex<doxid-class_e_e_1_1_system_1_1_mutex>` {
	public:
		// construction
	
		virtual :target:`~Log<doxid-class_e_e_1_1_system_1_1_log_1a3dabee29b646eb70638e0f12813e9399>`();

		// methods
	
		static std::unordered_map<std::string, :ref:`LogLevel<doxid-namespace_e_e_1_1_system_1a5412847f4eaf8012c1a3e4be27268e86>`> :target:`getMapFlag<doxid-class_e_e_1_1_system_1_1_log_1acee26b3bfd8d286c996fb5df4d3a52b5>`();
		static constexpr :ref:`LogLevel<doxid-namespace_e_e_1_1_system_1a5412847f4eaf8012c1a3e4be27268e86>` :target:`getDefaultLogLevel<doxid-class_e_e_1_1_system_1_1_log_1a93f917562afdc00125a74d9f60d0e5a4>`();
		static Log* :target:`create<doxid-class_e_e_1_1_system_1_1_log_1aefacc0d78a574f3d64c6e28a6ba970db>`(const std::string& logPath, const :ref:`LogLevel<doxid-namespace_e_e_1_1_system_1a5412847f4eaf8012c1a3e4be27268e86>`& level, bool stdOutLog, bool liveWrite);
		static Log* :target:`create<doxid-class_e_e_1_1_system_1_1_log_1a479f140df83a4d0ed68ae52b5106a5b5>`(const :ref:`LogLevel<doxid-namespace_e_e_1_1_system_1a5412847f4eaf8012c1a3e4be27268e86>`& level, bool stdOutLog, bool liveWrite);
		static void :target:`debug<doxid-class_e_e_1_1_system_1_1_log_1a4e8a621d96777535261bf2f3f08a4bd4>`(const std::string_view& text);
		static void :target:`info<doxid-class_e_e_1_1_system_1_1_log_1a0306cc0da1d90d9a371b3e021a8c9b8f>`(const std::string_view& text);
		static void :target:`notice<doxid-class_e_e_1_1_system_1_1_log_1a298ad1bb2f427de47fc23ed3c97ce03a>`(const std::string_view& text);
		static void :target:`warning<doxid-class_e_e_1_1_system_1_1_log_1ae60e155a7e799b01525fc9b421078ab3>`(const std::string_view& text);
		static void :target:`error<doxid-class_e_e_1_1_system_1_1_log_1a7a60b2bad0d7e1b4d6d4543119635c2f>`(const std::string_view& text);
		static void :target:`critical<doxid-class_e_e_1_1_system_1_1_log_1afe0bd28b35ef20ddc7695a855b402cfb>`(const std::string_view& text);
		static void :target:`assertLog<doxid-class_e_e_1_1_system_1_1_log_1a551e484010833b16ec16ab5178d0cea9>`(const std::string_view& text);
	
		template <class... Args>
		static void :target:`debug<doxid-class_e_e_1_1_system_1_1_log_1aa5387a6a6690ab17e7e694cae6d4cfad>`(const char* format, Args&&... args);
	
		template <class... Args>
		static void :target:`info<doxid-class_e_e_1_1_system_1_1_log_1aac006336f3c275c21ded8f0e957709a4>`(const char* format, Args&&... args);
	
		template <class... Args>
		static void :target:`notice<doxid-class_e_e_1_1_system_1_1_log_1a3ede84f53192b16edb2a000333a01bdc>`(const char* format, Args&&... args);
	
		template <class... Args>
		static void :target:`warning<doxid-class_e_e_1_1_system_1_1_log_1a1ad6807c931bd85b158875b0909c0bbd>`(const char* format, Args&&... args);
	
		template <class... Args>
		static void :target:`error<doxid-class_e_e_1_1_system_1_1_log_1a650d0685f24b22af8054edb8b959d87c>`(const char* format, Args&&... args);
	
		template <class... Args>
		static void :target:`critical<doxid-class_e_e_1_1_system_1_1_log_1a48370bec18e578fb19593e2dcf2502de>`(const char* format, Args&&... args);
	
		template <class... Args>
		static void :target:`assertLog<doxid-class_e_e_1_1_system_1_1_log_1ae194e9648b9e60437cf7ee4ca942b0e1>`(const char* format, Args&&... args);
	
		void :ref:`save<doxid-class_e_e_1_1_system_1_1_log_1a4d6e833b9c562dfab35891d01ebccf35>`(const std::string& filepath = "");
		void :ref:`write<doxid-class_e_e_1_1_system_1_1_log_1ab7fe1b8096a4b31512a2e4af4572d7d8>`(const std::string_view& text);
		void :ref:`write<doxid-class_e_e_1_1_system_1_1_log_1a82c8f4f083579b6f7bc055babc2ce899>`(const :ref:`LogLevel<doxid-namespace_e_e_1_1_system_1a5412847f4eaf8012c1a3e4be27268e86>`& level, const std::string_view& text);
		void :ref:`writel<doxid-class_e_e_1_1_system_1_1_log_1ad4cb64a3aa3aeb016ac175c0b1975e42>`(const std::string_view& text);
		void :ref:`writel<doxid-class_e_e_1_1_system_1_1_log_1ac8f465ee07a74f73546819b16e629d59>`(const :ref:`LogLevel<doxid-namespace_e_e_1_1_system_1a5412847f4eaf8012c1a3e4be27268e86>`& level, const std::string_view& text);
	
		template <typename... Args>
		void :ref:`writef<doxid-class_e_e_1_1_system_1_1_log_1a2ef2fba3bf9ee00d82f0963f19790012>`(const :ref:`LogLevel<doxid-namespace_e_e_1_1_system_1a5412847f4eaf8012c1a3e4be27268e86>`& level, std::string_view format, Args&&... args);
	
		template <typename... Args>
		void :ref:`writef<doxid-class_e_e_1_1_system_1_1_log_1a7f6f28b80fe4b6c82e5d79282c410096>`(std::string_view format, Args&&... args);
	
		const std::string& :ref:`getBuffer<doxid-class_e_e_1_1_system_1_1_log_1a5c3b9783f79f762a7023eb60178ed17f>`() const;
		const bool& :ref:`isLoggingToStdOut<doxid-class_e_e_1_1_system_1_1_log_1a0d39e3cae40f3aae1a227293b265daf3>`() const;
		void :ref:`setLogToStdOut<doxid-class_e_e_1_1_system_1_1_log_1a3d25b2006c42ef48bebf7fb4eb4bd75e>`(const bool& output);
		const bool& :ref:`isLiveWrite<doxid-class_e_e_1_1_system_1_1_log_1aa6026d5131dd6661305a00d75cac094d>`() const;
		void :ref:`setLiveWrite<doxid-class_e_e_1_1_system_1_1_log_1a2c4f6ccd91e0b3213137a5050473344c>`(const bool& lw);
		void :ref:`addLogReader<doxid-class_e_e_1_1_system_1_1_log_1a5f5a5fcbdcd89e27c416529140e0cf46>`(:ref:`LogReaderInterface<doxid-class_e_e_1_1_system_1_1_log_reader_interface>`* reader);
		void :ref:`removeLogReader<doxid-class_e_e_1_1_system_1_1_log_1ae9bd6bf2e2a4ba42eb5c7bc6430bafe6>`(:ref:`LogReaderInterface<doxid-class_e_e_1_1_system_1_1_log_reader_interface>`* reader);
		const :ref:`LogLevel<doxid-namespace_e_e_1_1_system_1a5412847f4eaf8012c1a3e4be27268e86>`& :ref:`getLogLevelThreshold<doxid-class_e_e_1_1_system_1_1_log_1a92280f1a5dc6c0f1bbee6c624e4bdb5a>`() const;
		void :ref:`setLogLevelThreshold<doxid-class_e_e_1_1_system_1_1_log_1a89f034faa8f3413e0f3732fab9af6c7a>`(const :ref:`LogLevel<doxid-namespace_e_e_1_1_system_1a5412847f4eaf8012c1a3e4be27268e86>`& logLevelThreshold);
		const std::string& :ref:`getFilePath<doxid-class_e_e_1_1_system_1_1_log_1a1438816a6292e55134e98ba93d6e3f6d>`() const;
		void :ref:`setFilePath<doxid-class_e_e_1_1_system_1_1_log_1a02637245824797c4d2bba74c12b1c15c>`(const std::string& filePath);
		bool :ref:`getKeepLog<doxid-class_e_e_1_1_system_1_1_log_1ab388be3bdfd0ffab50f83a95ad58a008>`() const;
		void :ref:`setKeepLog<doxid-class_e_e_1_1_system_1_1_log_1a9bb9126fe109f56e15cc5eaec4c6b194>`(bool keepLog);
	};

Inherited Members
-----------------

.. ref-code-block:: cpp
	:class: doxyrest-overview-inherited-code-block

	public:
		// methods
	
		void :ref:`lock<doxid-class_e_e_1_1_system_1_1_mutex_1a6f72cee2e7ed17e38d21ca8b230ee5e3>`();
		void :ref:`unlock<doxid-class_e_e_1_1_system_1_1_mutex_1acbd7dc7fc94d5db6a7c5a4ecfd9d123c>`();
		bool :ref:`tryLock<doxid-class_e_e_1_1_system_1_1_mutex_1a3d9e371eeb72a34025994422a5a08169>`();

.. _details-class_e_e_1_1_system_1_1_log:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Global log file. The engine will log everything in this file.

Methods
-------

.. index:: pair: function; save
.. _doxid-class_e_e_1_1_system_1_1_log_1a4d6e833b9c562dfab35891d01ebccf35:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void save(const std::string& filepath = "")

Indicates that the log must be writed to a file when the :ref:`Log <doxid-class_e_e_1_1_system_1_1_log>` instance is closed.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- filepath

		- The path to the file to write the log.

.. index:: pair: function; write
.. _doxid-class_e_e_1_1_system_1_1_log_1ab7fe1b8096a4b31512a2e4af4572d7d8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void write(const std::string_view& text)

Writes the text to the log.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- text

		- The text to write

.. index:: pair: function; write
.. _doxid-class_e_e_1_1_system_1_1_log_1a82c8f4f083579b6f7bc055babc2ce899:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void write(const :ref:`LogLevel<doxid-namespace_e_e_1_1_system_1a5412847f4eaf8012c1a3e4be27268e86>`& level, const std::string_view& text)

Writes the text to the log with a log level.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- level

		- The log level that will try to write.

	*
		- text

		- The text to write

.. index:: pair: function; writel
.. _doxid-class_e_e_1_1_system_1_1_log_1ad4cb64a3aa3aeb016ac175c0b1975e42:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void writel(const std::string_view& text)

Writes the text to the log and appends a new line character at the end.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- text

		- The text to write

.. index:: pair: function; writel
.. _doxid-class_e_e_1_1_system_1_1_log_1ac8f465ee07a74f73546819b16e629d59:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void writel(const :ref:`LogLevel<doxid-namespace_e_e_1_1_system_1a5412847f4eaf8012c1a3e4be27268e86>`& level, const std::string_view& text)

Writes the text to the log and appends a new line character at the end with a log level.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- levelThe

		- log level that will try to write.

	*
		- text

		- The text to write

.. index:: pair: function; writef
.. _doxid-class_e_e_1_1_system_1_1_log_1a2ef2fba3bf9ee00d82f0963f19790012:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	template <typename... Args>
	void writef(const :ref:`LogLevel<doxid-namespace_e_e_1_1_system_1a5412847f4eaf8012c1a3e4be27268e86>`& level, std::string_view format, Args&&... args)

Writes a formated string to the log with a log level.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- level

		- The log level that will try to write.

	*
		- format

		- The Text format.

.. index:: pair: function; writef
.. _doxid-class_e_e_1_1_system_1_1_log_1a7f6f28b80fe4b6c82e5d79282c410096:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	template <typename... Args>
	void writef(std::string_view format, Args&&... args)

Writes a formated string to the log.

.. index:: pair: function; getBuffer
.. _doxid-class_e_e_1_1_system_1_1_log_1a5c3b9783f79f762a7023eb60178ed17f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const std::string& getBuffer() const



.. rubric:: Returns:

A reference of the current writed log.

.. index:: pair: function; isLoggingToStdOut
.. _doxid-class_e_e_1_1_system_1_1_log_1a0d39e3cae40f3aae1a227293b265daf3:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const bool& isLoggingToStdOut() const



.. rubric:: Returns:

If the log Writes are outputed to stdout.

.. index:: pair: function; setLogToStdOut
.. _doxid-class_e_e_1_1_system_1_1_log_1a3d25b2006c42ef48bebf7fb4eb4bd75e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setLogToStdOut(const bool& output)

Enabled or disables to output the Writes to stdout.

.. index:: pair: function; isLiveWrite
.. _doxid-class_e_e_1_1_system_1_1_log_1aa6026d5131dd6661305a00d75cac094d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const bool& isLiveWrite() const



.. rubric:: Returns:

If the file is forced to flush the data on every Write call.

.. index:: pair: function; setLiveWrite
.. _doxid-class_e_e_1_1_system_1_1_log_1a2c4f6ccd91e0b3213137a5050473344c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setLiveWrite(const bool& lw)

Activate or deactivate to flush the writed data to the log on every Write call.

.. index:: pair: function; addLogReader
.. _doxid-class_e_e_1_1_system_1_1_log_1a5f5a5fcbdcd89e27c416529140e0cf46:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void addLogReader(:ref:`LogReaderInterface<doxid-class_e_e_1_1_system_1_1_log_reader_interface>`* reader)

Adds a reader interface. The reader interface is used to the informed for every writed text to the log.

.. index:: pair: function; removeLogReader
.. _doxid-class_e_e_1_1_system_1_1_log_1ae9bd6bf2e2a4ba42eb5c7bc6430bafe6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void removeLogReader(:ref:`LogReaderInterface<doxid-class_e_e_1_1_system_1_1_log_reader_interface>`* reader)

Removes the reader interface.

.. index:: pair: function; getLogLevelThreshold
.. _doxid-class_e_e_1_1_system_1_1_log_1a92280f1a5dc6c0f1bbee6c624e4bdb5a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`LogLevel<doxid-namespace_e_e_1_1_system_1a5412847f4eaf8012c1a3e4be27268e86>`& getLogLevelThreshold() const



.. rubric:: Returns:

The log level threshold.

.. index:: pair: function; setLogLevelThreshold
.. _doxid-class_e_e_1_1_system_1_1_log_1a89f034faa8f3413e0f3732fab9af6c7a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setLogLevelThreshold(const :ref:`LogLevel<doxid-namespace_e_e_1_1_system_1a5412847f4eaf8012c1a3e4be27268e86>`& logLevelThreshold)

Sets the log level threshold. This is the minimum level that message will actually be logged.

.. index:: pair: function; getFilePath
.. _doxid-class_e_e_1_1_system_1_1_log_1a1438816a6292e55134e98ba93d6e3f6d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const std::string& getFilePath() const



.. rubric:: Returns:

The file path of the log file (if any).

.. index:: pair: function; setFilePath
.. _doxid-class_e_e_1_1_system_1_1_log_1a02637245824797c4d2bba74c12b1c15c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setFilePath(const std::string& filePath)

Sets the file path of the log file.

.. index:: pair: function; getKeepLog
.. _doxid-class_e_e_1_1_system_1_1_log_1ab388be3bdfd0ffab50f83a95ad58a008:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool getKeepLog() const



.. rubric:: Returns:

True if the logs are being buffered in memory

.. index:: pair: function; setKeepLog
.. _doxid-class_e_e_1_1_system_1_1_log_1a9bb9126fe109f56e15cc5eaec4c6b194:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setKeepLog(bool keepLog)

Enable/Disable to keep a copy of the logs into memory (disabled by default)