/*
    PIP - Platform Independent Primitives
    Introspection module - interface for threads
    Ivan Pelipenko peri4ko@yandex.ru

    This program 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.

    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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

//! \addtogroup Introspection
//! \{
//! \file piintrospection_threads.h
//! \brief Thread introspection interface
//! \~english Interface for thread introspection and monitoring
//! \~russian Интерфейс для интроспекции и мониторинга потоков
//! \details
//! \~english Provides callbacks for thread lifecycle events such as creation, deletion, start, run, wait, stop and completion
//! \~russian Предоставляет обратные вызовы для событий жизненного цикла потоков: создание, удаление, запуск, выполнение, ожидание,
//! остановка и завершение
//! \}

#ifndef PIINTROSPECTION_THREADS_H
#  define PIINTROSPECTION_THREADS_H

#  if defined(PIP_INTROSPECTION) && !defined(PIP_FORCE_NO_PIINTROSPECTION)

#	include "piintrospection_base.h"

class PIIntrospectionThreads;

#	define PIINTROSPECTION_THREADS                (PIIntrospectionThreadsInterface::instance())

#	define PIINTROSPECTION_THREAD_NEW(t)          PIINTROSPECTION_THREADS->threadNew(t);
#	define PIINTROSPECTION_THREAD_DELETE(t)       PIINTROSPECTION_THREADS->threadDelete(t);
#	define PIINTROSPECTION_THREAD_START(t)        PIINTROSPECTION_THREADS->threadStart(t);
#	define PIINTROSPECTION_THREAD_RUN(t)          PIINTROSPECTION_THREADS->threadRun(t);
#	define PIINTROSPECTION_THREAD_WAIT(t)         PIINTROSPECTION_THREADS->threadWait(t);
#	define PIINTROSPECTION_THREAD_STOP(t)         PIINTROSPECTION_THREADS->threadStop(t);
#	define PIINTROSPECTION_THREAD_RUN_DONE(t, us) PIINTROSPECTION_THREADS->threadRunDone(t, us);

//! \~english Thread introspection interface class
//! \~russian Класс интерфейса интроспекции потоков
class PIP_EXPORT PIIntrospectionThreadsInterface {
	friend class PIIntrospection;

public:
	__PIINTROSPECTION_SINGLETON_H__(Threads)

	// clang-format off
	//! \~english Called when new thread is created
	//! \~russian Вызывается при создании нового потока
	void threadNew    (PIThread * t);
	//! \~english Called when thread is deleted
	//! \~russian Вызывается при удалении потока
	void threadDelete (PIThread * t);
	//! \~english Called when thread is starting
	//! \~russian Вызывается при запуске потока
	void threadStart  (PIThread * t);
	//! \~english Called when thread starts execution
	//! \~russian Вызывается при начале выполнения потока
	void threadRun    (PIThread * t);
	//! \~english Called when thread is waiting
	//! \~russian Вызывается при ожидании потока
	void threadWait   (PIThread * t);
	//! \~english Called when thread is stopped
	//! \~russian Вызывается при остановке потока
	void threadStop   (PIThread * t);
	//! \~english Called when thread execution is done
	//! \~russian Вызывается при завершении выполнения потока
	void threadRunDone(PIThread * t, ullong us);
	// clang-format on

private:
	PIIntrospectionThreadsInterface();
	~PIIntrospectionThreadsInterface();

	PIIntrospectionThreads * p;
};

#  else
#	define PIINTROSPECTION_THREAD_NEW(t)
#	define PIINTROSPECTION_THREAD_DELETE(t)
#	define PIINTROSPECTION_THREAD_START(t)
#	define PIINTROSPECTION_THREAD_RUN(t)
#	define PIINTROSPECTION_THREAD_WAIT(t)
#	define PIINTROSPECTION_THREAD_STOP(t)
#	define PIINTROSPECTION_THREAD_RUN_DONE(t, us)
#  endif

#endif // PIINTROSPECTION_THREADS_H
//! \}