This commit is contained in:
Andrey
2022-03-14 12:46:13 +03:00
parent 2fd139b1e3
commit 99061f6e24

View File

@@ -1,15 +1,15 @@
/*! @file pibase.h /*! @file pibase.h
* \brief * \brief
* \~english Base types and functions * \~english Base types and functions
* \~russian Áàçîâûå òèïû è ìåòîäû * \~russian Базовые типы и методы
* *
* \details * \details
* \~english * \~english
* This file implements first layer above the system and * This file implements first layer above the system and
* declares some basic useful functions * declares some basic useful functions
* \~russian * \~russian
* Ýòîò ôàéë ðåàëèçóåò ïåðâûé ñëîé ïîñëå ñèñòåìû è îáúÿâëÿåò * Этот файл реализует первый слой после системы и объявляет
* íåñêîëüêî áàçîâûõ ïîëåçíûõ ìåòîäîâ * несколько базовых полезных методов
*/ */
/* /*
PIP - Platform Independent Primitives PIP - Platform Independent Primitives
@@ -43,9 +43,9 @@
//! Parsing by \a pip_cmg and can be accessed by \a PICodeInfo. //! Parsing by \a pip_cmg and can be accessed by \a PICodeInfo.
//! Contains sequence of key=value pairs, e.g. //! Contains sequence of key=value pairs, e.g.
//! \~russian //! \~russian
//! Ñåêöèÿ ìåòàèíôîðìàöèè äëÿ ëþáîé ñóùíîñòè. //! Секция метаинформации для любой сущности.
//! Ïàðñèòñÿ \a pip_cmg è äîñòóïíà ñ ïîìîùüþ \a PICodeInfo. //! Парсится \a pip_cmg и доступна с помощью \a PICodeInfo.
//! Ñîäåðæèò íàáîð ïàð êëþ÷=çíà÷åíèå, íàïðèìåð //! Содержит набор пар ключ=значение, например
//! \~ //! \~
//! PIMETA(id=12345,tag="my string") //! PIMETA(id=12345,tag="my string")
#define PIMETA(...) #define PIMETA(...)
@@ -54,127 +54,127 @@
//! \brief //! \brief
//! \~english Major value of PIP version //! \~english Major value of PIP version
//! \~russian Ìàæîðíàÿ âåðñèÿ PIP //! \~russian Мажорная версия PIP
# define PIP_VERSION_MAJOR # define PIP_VERSION_MAJOR
//! \brief //! \brief
//! \~english Minor value of PIP version //! \~english Minor value of PIP version
//! \~russian Ìèíîðíàÿ âåðñèÿ PIP //! \~russian Минорная версия PIP
# define PIP_VERSION_MINOR # define PIP_VERSION_MINOR
//! \brief //! \brief
//! \~english Revision value of PIP version //! \~english Revision value of PIP version
//! \~russian Ðåâèçèÿ âåðñèè PIP //! \~russian Ревизия версии PIP
# define PIP_VERSION_REVISION # define PIP_VERSION_REVISION
//! \brief //! \brief
//! \~english Suffix of PIP version //! \~english Suffix of PIP version
//! \~russian Ñóôôèêñ âåðñèè PIP //! \~russian Суффикс версии PIP
# define PIP_VERSION_SUFFIX # define PIP_VERSION_SUFFIX
//! \brief //! \brief
//! \~english Version of PIP in hex - 0x##(Major)##(Minor)##(Revision) //! \~english Version of PIP in hex - 0x##(Major)##(Minor)##(Revision)
//! \~russian Âåðñèÿ PIP â hex - 0x##(Major)##(Minor)##(Revision) //! \~russian Версия PIP в hex - 0x##(Major)##(Minor)##(Revision)
# define PIP_VERSION # define PIP_VERSION
//! \brief //! \brief
//! \~english Macro is defined when compile-time debug is enabled //! \~english Macro is defined when compile-time debug is enabled
//! \~russian Ìàêðîñ îáúÿâëåí êîãäà âêëþ÷åíà compile-time îòëàäêà //! \~russian Макрос объявлен когда включена compile-time отладка
# define PIP_DEBUG # define PIP_DEBUG
//! \brief //! \brief
//! \~english Macro is defined when host is any Windows //! \~english Macro is defined when host is any Windows
//! \~russian Ìàêðîñ îáúÿâëåí êîãäà ñèñòåìà Windows //! \~russian Макрос объявлен когда система Windows
# define WINDOWS # define WINDOWS
//! \brief //! \brief
//! \~english Macro is defined when host is QNX or Blackberry //! \~english Macro is defined when host is QNX or Blackberry
//! \~russian Ìàêðîñ îáúÿâëåí êîãäà ñèñòåìà QNX èëè Blackberry //! \~russian Макрос объявлен когда система QNX или Blackberry
# define QNX # define QNX
//! \brief //! \brief
//! \~english Macro is defined when host is Blackberry //! \~english Macro is defined when host is Blackberry
//! \~russian Ìàêðîñ îáúÿâëåí êîãäà ñèñòåìà Blackberry //! \~russian Макрос объявлен когда система Blackberry
# define BLACKBERRY # define BLACKBERRY
//! \brief //! \brief
//! \~english Macro is defined when host is FreeBSD //! \~english Macro is defined when host is FreeBSD
//! \~russian Ìàêðîñ îáúÿâëåí êîãäà ñèñòåìà FreeBSD //! \~russian Макрос объявлен когда система FreeBSD
# define FREE_BSD # define FREE_BSD
//! \brief //! \brief
//! \~english Macro is defined when host is Mac OS //! \~english Macro is defined when host is Mac OS
//! \~russian Ìàêðîñ îáúÿâëåí êîãäà ñèñòåìà Mac OS //! \~russian Макрос объявлен когда система Mac OS
# define MAC_OS # define MAC_OS
//! \brief //! \brief
//! \~english Macro is defined when host is Android //! \~english Macro is defined when host is Android
//! \~russian Ìàêðîñ îáúÿâëåí êîãäà ñèñòåìà Android //! \~russian Макрос объявлен когда система Android
# define ANDROID # define ANDROID
//! \brief //! \brief
//! \~english Macro is defined when host is any Linux //! \~english Macro is defined when host is any Linux
//! \~russian Ìàêðîñ îáúÿâëåí êîãäà ñèñòåìà Linux //! \~russian Макрос объявлен когда система Linux
# define LINUX # define LINUX
//! \brief //! \brief
//! \~english Macro is defined when compiler is GCC or MinGW //! \~english Macro is defined when compiler is GCC or MinGW
//! \~russian Ìàêðîñ îáúÿâëåí êîãäà êîìïèëÿòîð GCC èëè MinGW //! \~russian Макрос объявлен когда компилятор GCC или MinGW
# define CC_GCC # define CC_GCC
//! \brief //! \brief
//! \~english Macro is defined when PIP is decided that host is support language //! \~english Macro is defined when PIP is decided that host is support language
//! \~russian Ìàêðîñ îáúÿâëåí êîãäà PIP ðåøèë ÷òî ñèñòåìà ïîääåðæèâàåò ëîêàëèçàöèþ //! \~russian Макрос объявлен когда PIP решил что система поддерживает локализацию
# define HAS_LOCALE # define HAS_LOCALE
//! \brief //! \brief
//! \~english Macro is defined when compiler is Visual Studio //! \~english Macro is defined when compiler is Visual Studio
//! \~russian Ìàêðîñ îáúÿâëåí êîãäà êîìïèëÿòîð Visual Studio //! \~russian Макрос объявлен когда компилятор Visual Studio
# define CC_VC # define CC_VC
//! \brief //! \brief
//! \~english Macro is defined when compiler is unknown //! \~english Macro is defined when compiler is unknown
//! \~russian Ìàêðîñ îáúÿâëåí êîãäà êîìïèëÿòîð íåèçâåñòåí //! \~russian Макрос объявлен когда компилятор неизвестен
# define CC_OTHER # define CC_OTHER
//! \brief //! \brief
//! \~english Macro is defined when PIP can use "rt" library for "PITimer::ThreadRT" timers implementation //! \~english Macro is defined when PIP can use "rt" library for "PITimer::ThreadRT" timers implementation
//! \~russian Ìàêðîñ îáúÿâëåí êîãäà PIP ìîæåò èñïîëüçîâàòü áèáëèîòåêó "rt" äëÿ "PITimer::ThreadRT" ðåàëèçàöèè òàéìåðà //! \~russian Макрос объявлен когда PIP может использовать библиотеку "rt" для "PITimer::ThreadRT" реализации таймера
# define PIP_TIMER_RT # define PIP_TIMER_RT
//! \brief //! \brief
//! \~english Macro to declare private section, "export" is optional //! \~english Macro to declare private section, "export" is optional
//! \~russian Ìàêðîñ äëÿ îáúÿâëåíèÿ ÷àñòíîé ñåêöèè, "export" íåîáÿçàòåëåí //! \~russian Макрос для объявления частной секции, "export" необязателен
# define PRIVATE_DECLARATION(export) # define PRIVATE_DECLARATION(export)
//! \brief //! \brief
//! \~english Macro to start definition of private section //! \~english Macro to start definition of private section
//! \~russian Ìàêðîñ äëÿ íà÷àëà ðåàëèçàöèè ÷àñòíîé ñåêöèè //! \~russian Макрос для начала реализации частной секции
# define PRIVATE_DEFINITION_START(Class) # define PRIVATE_DEFINITION_START(Class)
//! \brief //! \brief
//! \~english Macro to end definition of private section //! \~english Macro to end definition of private section
//! \~russian Ìàêðîñ äëÿ îêîí÷àíèÿ ðåàëèçàöèè ÷àñòíîé ñåêöèè //! \~russian Макрос для окончания реализации частной секции
# define PRIVATE_DEFINITION_END(Class) # define PRIVATE_DEFINITION_END(Class)
//! \brief //! \brief
//! \~english Macro to access private section by pointer //! \~english Macro to access private section by pointer
//! \~russian Ìàêðîñ äëÿ äîñòóïà ê ÷àñòíîé ñåêöèè //! \~russian Макрос для доступа к частной секции
# define PRIVATE # define PRIVATE
//! \brief //! \brief
//! \~english Macro to access private section by pointer without brakes () //! \~english Macro to access private section by pointer without brakes ()
//! \~russian Ìàêðîñ äëÿ äîñòóïà ê ÷àñòíîé ñåêöèè áåç îáðàìëÿþùèõ ñêîáîê () //! \~russian Макрос для доступа к частной секции без обрамляющих скобок ()
# define PRIVATEWB # define PRIVATEWB
//! \brief //! \brief
//! \~english Macro to start static initializer //! \~english Macro to start static initializer
//! \~russian Ìàêðîñ äëÿ íà÷àëà ñòàòè÷åñêîé èíèöèàëèçàöèè //! \~russian Макрос для начала статической инициализации
# define STATIC_INITIALIZER_BEGIN # define STATIC_INITIALIZER_BEGIN
//! \brief //! \brief
//! \~english Macro to end static initializer //! \~english Macro to end static initializer
//! \~russian Ìàêðîñ äëÿ îêîí÷àíèÿ ñòàòè÷åñêîé èíèöèàëèçàöèè //! \~russian Макрос для окончания статической инициализации
# define STATIC_INITIALIZER_END # define STATIC_INITIALIZER_END
@@ -352,30 +352,30 @@
//! \brief //! \brief
//! \~english Macro used for infinite loop //! \~english Macro used for infinite loop
//! \~russian Ìàêðîñ äëÿ áåñêîíå÷íîãî öèêëà //! \~russian Макрос для бесконечного цикла
#define FOREVER for (;;) #define FOREVER for (;;)
//! \brief //! \brief
//! \~english Macro used for infinite wait //! \~english Macro used for infinite wait
//! \~russian Ìàêðîñ äëÿ áåñêîíå÷íîãî îæèäàíèÿ //! \~russian Макрос для бесконечного ожидания
#define FOREVER_WAIT FOREVER piMinSleep; #define FOREVER_WAIT FOREVER piMinSleep;
//! \brief //! \brief
//! \~english Macro used for infinite wait //! \~english Macro used for infinite wait
//! \~russian Ìàêðîñ äëÿ áåñêîíå÷íîãî îæèäàíèÿ //! \~russian Макрос для бесконечного ожидания
#define WAIT_FOREVER FOREVER piMinSleep; #define WAIT_FOREVER FOREVER piMinSleep;
//! \brief //! \brief
//! \~english Global variable enabling output to piCout, default is true //! \~english Global variable enabling output to piCout, default is true
//! \~russian Ãëîáàëüíàÿ ïåðåìåííàÿ, âêëþ÷àþùàÿ âûâîä â piCout, ïðè ñòàðòå true //! \~russian Глобальная переменная, включающая вывод в piCout, при старте true
extern PIP_EXPORT bool piDebug; extern PIP_EXPORT bool piDebug;
//! \brief //! \brief
//! \~english Global variable that set minimum real update interval //! \~english Global variable that set minimum real update interval
//! for function PIInit::mountInfo(), default is 10000 ms //! for function PIInit::mountInfo(), default is 10000 ms
//! \~russian Ãëîáàëüíàÿ ïåðåìåííàÿ ìèíèìàëüíîãî îæèäàíèÿ ìåæäó ðåàëüíûì îáíîâëåíèåì //! \~russian Глобальная переменная минимального ожидания между реальным обновлением
//! â ìåòîäå PIInit::mountInfo(), ïî óìîë÷àíèþ 10000 ìñ //! в методе PIInit::mountInfo(), по умолчанию 10000 мс
extern PIP_EXPORT double piMountInfoRefreshIntervalMs; extern PIP_EXPORT double piMountInfoRefreshIntervalMs;
typedef unsigned char uchar; typedef unsigned char uchar;
@@ -388,18 +388,18 @@ typedef long double ldouble;
//! \brief //! \brief
//! \~english Templated function for swap two values //! \~english Templated function for swap two values
//! \~russian Øàáëîííûé ìåòîä äëÿ ïåðåñòàíîâêè äâóõ çíà÷åíèé //! \~russian Шаблонный метод для перестановки двух значений
//! \details //! \details
//! \~english Example:\n \snippet piincludes.cpp swap //! \~english Example:\n \snippet piincludes.cpp swap
//! \~russian Ïðèìåð:\n \snippet piincludes.cpp swap //! \~russian Пример:\n \snippet piincludes.cpp swap
template<typename T> inline void piSwap(T & f, T & s) {T t(std::move(f)); f = std::move(s); s = std::move(t);} template<typename T> inline void piSwap(T & f, T & s) {T t(std::move(f)); f = std::move(s); s = std::move(t);}
//! \brief //! \brief
//! \~english Templated function for swap two values without "=" //! \~english Templated function for swap two values without "="
//! \~russian Øàáëîííûé ìåòîä äëÿ ïåðåñòàíîâêè äâóõ çíà÷åíèé áåç èñïîëüçîâàíèÿ "=" //! \~russian Шаблонный метод для перестановки двух значений без использования "="
//! \details //! \details
//! \~english Example:\n \snippet piincludes.cpp swapBinary //! \~english Example:\n \snippet piincludes.cpp swapBinary
//! \~russian Ïðèìåð:\n \snippet piincludes.cpp swapBinary //! \~russian Пример:\n \snippet piincludes.cpp swapBinary
template<typename T> inline void piSwapBinary(T & f, T & s) { template<typename T> inline void piSwapBinary(T & f, T & s) {
if ((size_t*)&f == (size_t*)&s) return; if ((size_t*)&f == (size_t*)&s) return;
size_t j = (sizeof(T) / sizeof(size_t)), bs = j * sizeof(size_t), bf = sizeof(T); size_t j = (sizeof(T) / sizeof(size_t)), bs = j * sizeof(size_t), bf = sizeof(T);
@@ -436,10 +436,10 @@ template<> inline void piSwapBinary(const void *& f, const void *& s) {
//! \brief //! \brief
//! \~english Function for compare two values without "==" by raw content //! \~english Function for compare two values without "==" by raw content
//! \~russian Ìåòîä äëÿ ñðàâíåíèÿ äâóõ çíà÷åíèé áåç èñïîëüçîâàíèÿ "==" (ïî ñûðîìó ñîäåðæèìîìó) //! \~russian Метод для сравнения двух значений без использования "==" (по сырому содержимому)
//! \details //! \details
//! \~english Example:\n \snippet piincludes.cpp compareBinary //! \~english Example:\n \snippet piincludes.cpp compareBinary
//! \~russian Ïðèìåð:\n \snippet piincludes.cpp compareBinary //! \~russian Пример:\n \snippet piincludes.cpp compareBinary
inline bool piCompareBinary(const void * f, const void * s, size_t size) { inline bool piCompareBinary(const void * f, const void * s, size_t size) {
for (size_t i = 0; i < size; ++i) for (size_t i = 0; i < size; ++i)
if (((const uchar*)f)[i] != ((const uchar*)s)[i]) if (((const uchar*)f)[i] != ((const uchar*)s)[i])
@@ -449,7 +449,7 @@ inline bool piCompareBinary(const void * f, const void * s, size_t size) {
//! \brief //! \brief
//! \~english Templated function return round of float falue //! \~english Templated function return round of float falue
//! \~russian Øàáëîííûé ìåòîä, âîçâðàùàþùèé îêðóãëåííîå çíà÷åíèå //! \~russian Шаблонный метод, возвращающий округленное значение
//! \details //! \details
//! \~english //! \~english
//! Round is the nearest integer value \n //! Round is the nearest integer value \n
@@ -460,18 +460,18 @@ inline bool piCompareBinary(const void * f, const void * s, size_t size) {
//! Example: //! Example:
//! \snippet piincludes.cpp round //! \snippet piincludes.cpp round
//! \~russian //! \~russian
//! Îêðóãëåííîå çíà÷åíèå - ýòî áëèæàéøåå öåëîå ÷èñëî\n //! Округленное значение - это ближайшее целое число\n
//! Åñòü íåñêîëüêî ìàêðîñîâ: //! Есть несколько макросов:
//! - \c piRoundf äëÿ "float" //! - \c piRoundf для "float"
//! - \c piRoundd äëÿ "double" //! - \c piRoundd для "double"
//! //!
//! Ïðèìåð: //! Пример:
//! \snippet piincludes.cpp round //! \snippet piincludes.cpp round
template<typename T> inline constexpr int piRound(const T & v) {return int(v >= T(0.) ? v + T(0.5) : v - T(0.5));} template<typename T> inline constexpr int piRound(const T & v) {return int(v >= T(0.) ? v + T(0.5) : v - T(0.5));}
//! \brief //! \brief
//! \~english Templated function return floor of float falue //! \~english Templated function return floor of float falue
//! \~russian Øàáëîííûé ìåòîä, âîçâðàùàþùèé floor çíà÷åíèå //! \~russian Шаблонный метод, возвращающий floor значение
//! \details //! \details
//! \~english //! \~english
//! Floor is the largest integer that is not greater than "v" \n //! Floor is the largest integer that is not greater than "v" \n
@@ -482,18 +482,18 @@ template<typename T> inline constexpr int piRound(const T & v) {return int(v >=
//! Example: //! Example:
//! \snippet piincludes.cpp floor //! \snippet piincludes.cpp floor
//! \~russian //! \~russian
//! Floor çíà÷åíèå - ýòî íàèáîëüøåå öåëîå, íå áîëüøåå ÷åì "v"\n //! Floor значение - это наибольшее целое, не большее чем "v"\n
//! Åñòü íåñêîëüêî ìàêðîñîâ: //! Есть несколько макросов:
//! - \c piFloorf äëÿ "float" //! - \c piFloorf для "float"
//! - \c piFloord äëÿ "double" //! - \c piFloord для "double"
//! //!
//! Ïðèìåð: //! Пример:
//! \snippet piincludes.cpp floor //! \snippet piincludes.cpp floor
template<typename T> inline constexpr int piFloor(const T & v) {return v < T(0) ? int(v) - 1 : int(v);} template<typename T> inline constexpr int piFloor(const T & v) {return v < T(0) ? int(v) - 1 : int(v);}
//! \brief //! \brief
//! \~english Templated function return ceil of float falue //! \~english Templated function return ceil of float falue
//! \~russian Øàáëîííûé ìåòîä, âîçâðàùàþùèé ceil çíà÷åíèå //! \~russian Шаблонный метод, возвращающий ceil значение
//! \details //! \details
//! \~english //! \~english
//! Ceil is the smallest integer that is not less than "v" \n //! Ceil is the smallest integer that is not less than "v" \n
@@ -504,18 +504,18 @@ template<typename T> inline constexpr int piFloor(const T & v) {return v < T(0)
//! Example: //! Example:
//! \snippet piincludes.cpp ceil //! \snippet piincludes.cpp ceil
//! \~russian //! \~russian
//! Ceil çíà÷åíèå - ýòî íàèìåíüøåå öåëîå, íå ìåíüøåå ÷åì "v" \n //! Ceil значение - это наименьшее целое, не меньшее чем "v" \n
//! Åñòü íåñêîëüêî ìàêðîñîâ: //! Есть несколько макросов:
//! - \c piCeilf äëÿ "float" //! - \c piCeilf для "float"
//! - \c piCeild äëÿ "double" //! - \c piCeild для "double"
//! //!
//! Ïðèìåð: //! Пример:
//! \snippet piincludes.cpp ceil //! \snippet piincludes.cpp ceil
template<typename T> inline constexpr int piCeil(const T & v) {return v < T(0) ? int(v) : int(v) + 1;} template<typename T> inline constexpr int piCeil(const T & v) {return v < T(0) ? int(v) : int(v) + 1;}
//! \brief //! \brief
//! \~english Templated function return absolute of numeric falue //! \~english Templated function return absolute of numeric falue
//! \~russian Øàáëîííûé ìåòîä, âîçâðàùàþùèé ìîäóëü ÷èñëîâîãî çíà÷åíèÿ //! \~russian Шаблонный метод, возвращающий модуль числового значения
//! \details //! \details
//! \~english //! \~english
//! Absolute is the positive or equal 0 value \n //! Absolute is the positive or equal 0 value \n
@@ -530,22 +530,22 @@ template<typename T> inline constexpr int piCeil(const T & v) {return v < T(0) ?
//! Example: //! Example:
//! \snippet piincludes.cpp abs //! \snippet piincludes.cpp abs
//! \~russian //! \~russian
//! Ìîäóëü ÷èñëîâîãî çíà÷åíèÿ âñåãäà >= 0 \n //! Модуль числового значения всегда >= 0 \n
//! Åñòü íåñêîëüêî ìàêðîñîâ: //! Есть несколько макросов:
//! - \c piAbss äëÿ "short" //! - \c piAbss для "short"
//! - \c piAbsi äëÿ "int" //! - \c piAbsi для "int"
//! - \c piAbsl äëÿ "long" //! - \c piAbsl для "long"
//! - \c piAbsll äëÿ "llong" //! - \c piAbsll для "llong"
//! - \c piAbsf äëÿ "float" //! - \c piAbsf для "float"
//! - \c piAbsd äëÿ "double" //! - \c piAbsd для "double"
//! //!
//! Ïðèìåð: //! Пример:
//! \snippet piincludes.cpp abs //! \snippet piincludes.cpp abs
template<typename T> inline constexpr T piAbs(const T & v) {return (v >= T(0) ? v : -v);} template<typename T> inline constexpr T piAbs(const T & v) {return (v >= T(0) ? v : -v);}
//! \brief //! \brief
//! \~english Templated function return minimum of two values //! \~english Templated function return minimum of two values
//! \~russian Øàáëîííûé ìåòîä, âîçâðàùàþùèé ìèíèìóì èç äâóõ çíà÷åíèé //! \~russian Шаблонный метод, возвращающий минимум из двух значений
//! \details //! \details
//! \~english //! \~english
//! There are some macros: //! There are some macros:
@@ -559,21 +559,21 @@ template<typename T> inline constexpr T piAbs(const T & v) {return (v >= T(0) ?
//! Example: //! Example:
//! \snippet piincludes.cpp min2 //! \snippet piincludes.cpp min2
//! \~russian //! \~russian
//! Åñòü íåñêîëüêî ìàêðîñîâ: //! Есть несколько макросов:
//! - \c piMins äëÿ "short" //! - \c piMins для "short"
//! - \c piMini äëÿ "int" //! - \c piMini для "int"
//! - \c piMinl äëÿ "long" //! - \c piMinl для "long"
//! - \c piMinll äëÿ "llong" //! - \c piMinll для "llong"
//! - \c piMinf äëÿ "float" //! - \c piMinf для "float"
//! - \c piMind äëÿ "double" //! - \c piMind для "double"
//! //!
//! Ïðèìåð: //! Пример:
//! \snippet piincludes.cpp min2 //! \snippet piincludes.cpp min2
template<typename T> inline constexpr T piMin(const T & f, const T & s) {return ((f > s) ? s : f);} template<typename T> inline constexpr T piMin(const T & f, const T & s) {return ((f > s) ? s : f);}
//! \brief //! \brief
//! \~english Templated function return minimum of tree values //! \~english Templated function return minimum of tree values
//! \~russian Øàáëîííûé ìåòîä, âîçâðàùàþùèé ìèíèìóì èç òðåõ çíà÷åíèé //! \~russian Шаблонный метод, возвращающий минимум из трех значений
//! \details //! \details
//! \~english //! \~english
//! There are some macros: //! There are some macros:
@@ -587,21 +587,21 @@ template<typename T> inline constexpr T piMin(const T & f, const T & s) {return
//! Example: //! Example:
//! \snippet piincludes.cpp min3 //! \snippet piincludes.cpp min3
//! \~russian //! \~russian
//! Åñòü íåñêîëüêî ìàêðîñîâ: //! Есть несколько макросов:
//! - \c piMins äëÿ "short" //! - \c piMins для "short"
//! - \c piMini äëÿ "int" //! - \c piMini для "int"
//! - \c piMinl äëÿ "long" //! - \c piMinl для "long"
//! - \c piMinll äëÿ "llong" //! - \c piMinll для "llong"
//! - \c piMinf äëÿ "float" //! - \c piMinf для "float"
//! - \c piMind äëÿ "double" //! - \c piMind для "double"
//! //!
//! Ïðèìåð: //! Пример:
//! \snippet piincludes.cpp min3 //! \snippet piincludes.cpp min3
template<typename T> inline constexpr T piMin(const T & f, const T & s, const T & t) {return ((f < s && f < t) ? f : ((s < t) ? s : t));} template<typename T> inline constexpr T piMin(const T & f, const T & s, const T & t) {return ((f < s && f < t) ? f : ((s < t) ? s : t));}
//! \brief //! \brief
//! \~english Templated function return maximum of two values //! \~english Templated function return maximum of two values
//! \~russian Øàáëîííûé ìåòîä, âîçâðàùàþùèé ìàêñèìóì èç äâóõ çíà÷åíèé //! \~russian Шаблонный метод, возвращающий максимум из двух значений
//! \details //! \details
//! \~english //! \~english
//! There are some macros: //! There are some macros:
@@ -615,21 +615,21 @@ template<typename T> inline constexpr T piMin(const T & f, const T & s, const T
//! Example: //! Example:
//! \snippet piincludes.cpp max2 //! \snippet piincludes.cpp max2
//! \~russian //! \~russian
//! Åñòü íåñêîëüêî ìàêðîñîâ: //! Есть несколько макросов:
//! - \c piMaxs äëÿ "short" //! - \c piMaxs для "short"
//! - \c piMaxi äëÿ "int" //! - \c piMaxi для "int"
//! - \c piMaxl äëÿ "long" //! - \c piMaxl для "long"
//! - \c piMaxll äëÿ "llong" //! - \c piMaxll для "llong"
//! - \c piMaxf äëÿ "float" //! - \c piMaxf для "float"
//! - \c piMaxd äëÿ "double" //! - \c piMaxd для "double"
//! //!
//! Ïðèìåð: //! Пример:
//! \snippet piincludes.cpp max2 //! \snippet piincludes.cpp max2
template<typename T> inline constexpr T piMax(const T & f, const T & s) {return ((f < s) ? s : f);} template<typename T> inline constexpr T piMax(const T & f, const T & s) {return ((f < s) ? s : f);}
//! \brief //! \brief
//! \~english Templated function return maximum of tree values //! \~english Templated function return maximum of tree values
//! \~russian Øàáëîííûé ìåòîä, âîçâðàùàþùèé ìàêñèìóì èç òðåõ çíà÷åíèé //! \~russian Шаблонный метод, возвращающий максимум из трех значений
//! \details //! \details
//! \~english //! \~english
//! There are some macros: //! There are some macros:
@@ -643,21 +643,21 @@ template<typename T> inline constexpr T piMax(const T & f, const T & s) {return
//! Example: //! Example:
//! \snippet piincludes.cpp max3 //! \snippet piincludes.cpp max3
//! \~russian //! \~russian
//! Åñòü íåñêîëüêî ìàêðîñîâ: //! Есть несколько макросов:
//! - \c piMaxs äëÿ "short" //! - \c piMaxs для "short"
//! - \c piMaxi äëÿ "int" //! - \c piMaxi для "int"
//! - \c piMaxl äëÿ "long" //! - \c piMaxl для "long"
//! - \c piMaxll äëÿ "llong" //! - \c piMaxll для "llong"
//! - \c piMaxf äëÿ "float" //! - \c piMaxf для "float"
//! - \c piMaxd äëÿ "double" //! - \c piMaxd для "double"
//! //!
//! Ïðèìåð: //! Пример:
//! \snippet piincludes.cpp max3 //! \snippet piincludes.cpp max3
template<typename T> inline constexpr T piMax(const T & f, const T & s, const T & t) {return ((f > s && f > t) ? f : ((s > t) ? s : t));} template<typename T> inline constexpr T piMax(const T & f, const T & s, const T & t) {return ((f > s && f > t) ? f : ((s > t) ? s : t));}
//! \brief //! \brief
//! \~english Templated function return clamped value //! \~english Templated function return clamped value
//! \~russian Øàáëîííûé ìåòîä, âîçâðàùàþùèé îãðàíè÷åííîå çíà÷åíèå //! \~russian Шаблонный метод, возвращающий ограниченное значение
//! \details //! \details
//! \~english //! \~english
//! Clamped is the not greater than "max" and not lesser than "min" value \n //! Clamped is the not greater than "max" and not lesser than "min" value \n
@@ -672,22 +672,22 @@ template<typename T> inline constexpr T piMax(const T & f, const T & s, const T
//! Example: //! Example:
//! \snippet piincludes.cpp clamp //! \snippet piincludes.cpp clamp
//! \~russian //! \~russian
//! Îãðàíè÷åííîå çíà÷åíèå - íå áîëüøå ÷åì "max" è íå ìåíüøå ÷åì "min" //! Ограниченное значение - не больше чем "max" и не меньше чем "min"
//! Åñòü íåñêîëüêî ìàêðîñîâ: //! Есть несколько макросов:
//! - \c piClamps äëÿ "short" //! - \c piClamps для "short"
//! - \c piClampi äëÿ "int" //! - \c piClampi для "int"
//! - \c piClampl äëÿ "long" //! - \c piClampl для "long"
//! - \c piClampll äëÿ "llong" //! - \c piClampll для "llong"
//! - \c piClampf äëÿ "float" //! - \c piClampf для "float"
//! - \c piClampd äëÿ "double" //! - \c piClampd для "double"
//! //!
//! Ïðèìåð: //! Пример:
//! \snippet piincludes.cpp clamp //! \snippet piincludes.cpp clamp
template<typename T> inline constexpr T piClamp(const T & v, const T & min, const T & max) {return (v > max ? max : (v < min ? min : v));} template<typename T> inline constexpr T piClamp(const T & v, const T & min, const T & max) {return (v > max ? max : (v < min ? min : v));}
//! \brief //! \brief
//! \~english Function inverse byte order in memory block ([1..N] -> [N..1]) //! \~english Function inverse byte order in memory block ([1..N] -> [N..1])
//! \~russian Ìåòîä äëÿ ñìåíû ïîðÿäêà áàéò â áëîêå ïàìÿòè ([1..N] -> [N..1]) //! \~russian Метод для смены порядка байт в блоке памяти ([1..N] -> [N..1])
inline void piLetobe(void * data, int size) { inline void piLetobe(void * data, int size) {
for (int i = 0; i < size / 2; i++) for (int i = 0; i < size / 2; i++)
piSwap<uchar>(((uchar*)data)[size - i - 1], ((uchar*)data)[i]); piSwap<uchar>(((uchar*)data)[size - i - 1], ((uchar*)data)[i]);
@@ -695,7 +695,7 @@ inline void piLetobe(void * data, int size) {
//! \brief //! \brief
//! \~english Function for compare two numeric values with epsilon //! \~english Function for compare two numeric values with epsilon
//! \~russian Ìåòîä äëÿ ñðàâíåíèÿ äâóõ ÷èñåë ñ ïîðîãîì //! \~russian Метод для сравнения двух чисел с порогом
//! \details //! \details
//! \~english //! \~english
//! There are some macros: //! There are some macros:
@@ -705,11 +705,11 @@ inline void piLetobe(void * data, int size) {
//! Example: //! Example:
//! \snippet piincludes.cpp compare //! \snippet piincludes.cpp compare
//! \~russian //! \~russian
//! Åñòü íåñêîëüêî ìàêðîñîâ: //! Есть несколько макросов:
//! - \c piComparef äëÿ "float" //! - \c piComparef для "float"
//! - \c piCompared äëÿ "double" //! - \c piCompared для "double"
//! //!
//! Ïðèìåð: //! Пример:
//! \snippet piincludes.cpp compare //! \snippet piincludes.cpp compare
template<typename T> template<typename T>
inline bool piCompare(const T & a, const T & b, const T & epsilon = std::numeric_limits<T>::epsilon()) { inline bool piCompare(const T & a, const T & b, const T & epsilon = std::numeric_limits<T>::epsilon()) {
@@ -718,12 +718,12 @@ inline bool piCompare(const T & a, const T & b, const T & epsilon = std::numeric
//! \brief //! \brief
//! \~english Templated function that inverse byte order of value "v" //! \~english Templated function that inverse byte order of value "v"
//! \~russian Øàáëîííûé ìåòîä, ìåíÿþùèé ïîðÿäîê áàéò â ïåðåìåííîé "v" //! \~russian Шаблонный метод, меняющий порядок байт в переменной "v"
template<typename T> inline void piLetobe(T * v) {piLetobe(v, sizeof(T));} template<typename T> inline void piLetobe(T * v) {piLetobe(v, sizeof(T));}
//! \brief //! \brief
//! \~english Templated function that returns "v" with inversed byte order //! \~english Templated function that returns "v" with inversed byte order
//! \~russian Øàáëîííûé ìåòîä, âîçâðàùàþùèé ïåðåìåííóþ "v" ñ èçìåíåííûì ïîðÿäêîì áàéò //! \~russian Шаблонный метод, возвращающий переменную "v" с измененным порядком байт
//! \details //! \details
//! \~english //! \~english
//! This function used to convert values between little and big endian \n //! This function used to convert values between little and big endian \n
@@ -736,14 +736,14 @@ template<typename T> inline void piLetobe(T * v) {piLetobe(v, sizeof(T));}
//! Example: //! Example:
//! \snippet piincludes.cpp letobe //! \snippet piincludes.cpp letobe
//! \~russian //! \~russian
//! Ýòîò ìåòîä èñïîëüçóåòñÿ äëÿ èçìåíåíèÿ ïîðÿäêà áàéò ìåæäó little è big endian //! Этот метод используется для изменения порядка байт между little и big endian
//! Åñòü íåñêîëüêî ìàêðîñîâ: //! Есть несколько макросов:
//! - \c piLetobes äëÿ "ushort" //! - \c piLetobes для "ushort"
//! - \c piLetobei äëÿ "uint" //! - \c piLetobei для "uint"
//! - \c piLetobel äëÿ "ulong" //! - \c piLetobel для "ulong"
//! - \c piLetobell äëÿ "ullong" //! - \c piLetobell для "ullong"
//! //!
//! Ïðèìåð: //! Пример:
//! \snippet piincludes.cpp letobe //! \snippet piincludes.cpp letobe
template<typename T> inline T piLetobe(const T & v) {T tv(v); piLetobe(&tv, sizeof(T)); return tv;} template<typename T> inline T piLetobe(const T & v) {T tv(v); piLetobe(&tv, sizeof(T)); return tv;}
@@ -763,7 +763,7 @@ template<> inline float piLetobe(const float & v) {
//! \brief //! \brief
//! \~english Generic hash function, implements murmur3/32 algorithm //! \~english Generic hash function, implements murmur3/32 algorithm
//! \~russian Õýø-ôóíêöèÿ îáùåãî íàçíà÷åíèÿ, ïî àëãîðèòìó murmur3/32 //! \~russian Хэш-функция общего назначения, по алгоритму murmur3/32
inline uint piHashData(const uchar * data, uint len, uint seed = 0) { inline uint piHashData(const uchar * data, uint len, uint seed = 0) {
if (!data || len <= 0) return 0u; if (!data || len <= 0) return 0u;
uint h = seed; uint h = seed;