/*! \file piresources.h
 * \ingroup Resources
 * \~\brief
 * \~english Resources subsystem
 * \~russian Подсистема ресурсов
 */
/*
    PIP - Platform Independent Primitives
    Resources subsystem
    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/>.
*/
//! \~english Resources subsystem
//! \~russian Подсистема ресурсов
//! \defgroup Resources Resources
//! \~\brief
//! \~english Resources subsystem
//! \~russian Подсистема ресурсов
//!
//! \~\details
//! \~
//! \~english \section cmake_module_Resources Building with CMake
//! \~russian \section cmake_module_Resources Сборка с использованием CMake
//!
//! \~\code
//! find_package(PIP REQUIRED)
//! target_link_libraries([target] PIP)
//! \endcode
//!
//! \~english \par Common
//! \~russian \par Общее
//!
//! \~english
//! These files provides support of compiled-in files
//!
//! \~russian
//! Эти файлы обеспечивают поддержку вкомпиленных файлов
//!
//! \~\authors
//! \~english
//! Ivan Pelipenko peri4ko@yandex.ru;
//! Andrey Bychkov work.a.b@yandex.ru;
//! \~russian
//! Иван Пелипенко peri4ko@yandex.ru;
//! Андрей Бычков work.a.b@yandex.ru;
//!

#ifndef PIRESOURCES_H
#define PIRESOURCES_H

#include "pistring.h"

//! \~english Macro for initializing compiled-in resources
//! \~russian Макрос для инициализации вкомпиленных ресурсов
#define INIT_RESOURCE(name)             \
  {                                     \
	extern void _pirc_##name##_init_(); \
	_pirc_##name##_init_();             \
  }

//! \~english Class for accessing compiled-in resources
//! \~russian Класс для доступа к вкомпиленным ресурсам
class PIP_EXPORT PIResources {
public:
	//! \~english Get resource by section and name
	//! \~russian Получить ресурс по секции и имени
	//! \details
	//! \~english Searches for resource in specified section
	//! \~russian Ищет ресурс в указанной секции
	static PIByteArray get(const PIString & section, const PIString & name);

	//! \~english Get resource by name (searches all sections)
	//! \~russian Получить ресурс по имени (ищет во всех секциях)
	static PIByteArray get(const PIString & name);

	//! \~english Dump all resources to console
	//! \~russian Вывести все ресурсы в консоль
	static void dump();

private:
	PIResources();
};

#endif // PIRESOURCES_H