profiler.h

#ifndef INCLUDE_WATCHER_ITA_SIMULATION_SCHEDULER_PROFILER_PROFILER
#define INCLUDE_WATCHER_ITA_SIMULATION_SCHEDULER_PROFILER_PROFILER

// std includes
#include <memory>
#include <valarray>
#include <vector>

// API includes
#include <ITA/simulation_scheduler/definitions.h>

#include <ITA/simulation_scheduler/profiler/profiler_types.h>

namespace ITA
{
	namespace SimulationScheduler
	{
	#ifdef WITH_PROFILER
		///
		/// \brief Helper functions for the profiler.
		/// \{
		///
	#define PROFILER_STRINGIFY(a) #a
	#define PROFILER_STRINGIFICATION(a) PROFILER_STRINGIFY(a)
	#define PROFILER_TOKEN_JOIN(x, y) x ## y
	#define PROFILER_TOKEN_CONCATENATE(x, y) PROFILER_TOKEN_JOIN(x, y)
	#define PROFILER_UNIQUE_SECTION(x) PROFILER_TOKEN_CONCATENATE(unique_profiler_mark_name_, x)
		///
		/// \}
		///

		///
		/// \brief Issue an event with the name \p NAME.
		///
	#define PROFILER_EVENT_COUNT( NAME) Profiler::AddEventCount( NAME, __FUNCTION__, __FILE__ );

		///
		/// \brief Add the value \p VALUE to the profiler under the name \p NAME.
		///
	#define PROFILER_VALUE( NAME, VALUE) Profiler::AddValue( NAME, VALUE, __FUNCTION__, __FILE__ );

		///
		/// \brief Start a section with the name \p NAME.
		///
	#define PROFILER_SECTION( NAME ) Profiler::CSection PROFILER_UNIQUE_SECTION(__LINE__);\
		Profiler::StartSection(PROFILER_UNIQUE_SECTION(__LINE__), NAME, __FUNCTION__, __FILE__ );

		///
		/// \brief Start a section with the name "Full".
		///
	#define PROFILER_FUNCTION( ) PROFILER_SECTION( "Full" );

		///
		/// \brief End the last opened section in this thread.
		///
	#define PROFILER_END_SECTION() Profiler::EndSection();

		///
		/// \brief Name the current thread.
		///
		/// Only the first invocation of this has an effect.
		///
	#define PROFILER_NAME_THREAD( NAME ) Profiler::NameThread( NAME );

		///
		/// \brief Name the current thread "Main".
		///
		/// Only the first invocation of this has an effect.
		///
	#define PROFILER_NAME_THREAD_MAIN( ) Profiler::NameThread( "Main" );

		namespace Profiler
		{
			class ProfileSection;
			class CProfiler;

			///
			/// \brief Section object.
			///
			/// This class is used to time a section of code.
			/// It does not have to be ended manually, as the destruction of the object will register as the end of the section.
			/// However, the section can still be ended manually by calling ::EndSection().
			///
			class ITA_SIMULATION_SCHEDULER_API CSection
			{
				friend CProfiler;
				friend ProfileSection;

				///
				/// \brief Start the timing for the section.
				///
				void Start ( );

				///
				/// \brief End the timing for the section.
				///
				void End ( );

				///
				/// \brief Returns true if the section was ended.
				///
				bool Finished ( ) const;

				///
				/// \brief Start time of the section.
				///
				double m_dBegin = -1;

				///
				/// \brief End time of the section.
				///
				double m_dEnd = -1;

			public:
				CSection ( ) = default;

				///
				/// \brief Destructor for CSection
				///
				/// This ends the section.
				///
				~CSection ( );
			};

			///
			/// \brief Add the CSection \p oSection to the profiler and start the section.
			/// \param oSection the section object to add to the profiler.
			/// \param sName name of the section.
			/// \param sFunctionName name of the function that started the section.
			/// \param sFile name of the file in which the section was started.
			///
			void ITA_SIMULATION_SCHEDULER_API StartSection ( CSection& oSection, const std::string& sName, const std::string& sFunctionName, const std::string& sFile );

			///
			/// \brief End the last opened section in this thread.
			///
			void ITA_SIMULATION_SCHEDULER_API EndSection ( );

			///
			/// \brief End all currently open sections.
			///
			void ITA_SIMULATION_SCHEDULER_API EndAllSections ( );

			///
			/// \brief Add a EventCount to the profiler.
			/// \param sName name of the event.
			/// \param sFunctionName name of the function that issued the event.
			/// \param sFile name of the file in which the event was issued.
			///
			void ITA_SIMULATION_SCHEDULER_API AddEventCount ( const std::string& sName, const std::string& sFunctionName, const std::string& sFile );

			///
			/// \brief Add a value to the profiler.
			///
			/// The value must be of type: bool, char, int, float, double, string.
			/// \param sName name of the value.
			/// \param oValueData the untyped value data to be saved in the profiler.
			/// \param sFunctionName name of the function that issued the event.
			/// \param sFile name of the file in which the event was issued.
			///
			void ITA_SIMULATION_SCHEDULER_API StoreValue ( const std::string& sName, const ValueData& oValueData, const std::string& sFunctionName, const std::string& sFile );

			///
			/// \brief Add a value to the profiler.
			///
			/// The value must be of type: bool, char, int, float, double, string.
			/// \param sName name of the value.
			/// \param value the value to be saved in the profiler.
			/// \param sFunctionName name of the function that issued the event.
			/// \param sFile name of the file in which the event was issued.
			///
			template <class T>
			void ITA_SIMULATION_SCHEDULER_API AddValue ( const std::string& sName, const T& value, const std::string& sFunctionName, const std::string& sFile )
			{
				ValueData valueData;
				valueData.SetValue ( value );

				StoreValue ( sName, valueData, sFunctionName, sFile );
			}

			///
			/// \brief Name the current thread.
			///
			/// Only the first invocation of this has an effect.
			///
			void ITA_SIMULATION_SCHEDULER_API NameThread ( const std::string& sName );

			///
			/// \brief Parse the profiler data as a json file.
			///
			std::stringstream ITA_SIMULATION_SCHEDULER_API ProfilerToJson ( );
		} // namespace Profiler
	#else

	#define PROFILER_EVENT_COUNT( ... )
	#define PROFILER_VALUE( ... ) 
	#define PROFILER_SECTION( ... ) 
	#define PROFILER_SECTION( )
	#define PROFILER_END_SECTION()
	#define PROFILER_NAME_THREAD( ... )
	#define PROFILER_NAME_THREAD_MAIN( )

	#endif

		///
		/// \brief Store the profiler data as a json file.
		/// \param sProfilerFileName name for the json file.
		/// \note The file extension has to be defined by the user.
		/// 
		void ITA_SIMULATION_SCHEDULER_API StoreProfilerData ( const std::string& sProfilerFileName );
		
	} // namespace SimulationScheduler
} // namespace ITA

#endif // INCLUDE_WATCHER_ITA_SIMULATION_SCHEDULER_PROFILER_PROFILER