77 lines
2.6 KiB
C
77 lines
2.6 KiB
C
/*! \file picompress.h
|
||
* \brief
|
||
* \ingroup Compress
|
||
* \~\brief
|
||
* \~english Compress class zlib
|
||
* \~russian Сжатие с помощью zlib
|
||
*/
|
||
/*
|
||
PIP - Platform Independent Primitives
|
||
Compress class using zlib
|
||
Andrey Bychkov work.a.b@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/>.
|
||
*/
|
||
//! \defgroup Compress Compress
|
||
//! \~\brief
|
||
//! \~english Compression support
|
||
//! \~russian Поддержка сжатия
|
||
//!
|
||
//! \~\details
|
||
//! \~english \section cmake_module_Compress Building with CMake
|
||
//! \~russian \section cmake_module_Compress Сборка с использованием CMake
|
||
//!
|
||
//! \~\code
|
||
//! find_package(PIP REQUIRED)
|
||
//! target_link_libraries([target] PIP::Compress)
|
||
//! \endcode
|
||
//!
|
||
//! \~english \par Common
|
||
//! \~russian \par Общее
|
||
//!
|
||
//! \~english
|
||
//! These files provides simple compression and decompression support.
|
||
//!
|
||
//! \~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 PICOMPRESS_H
|
||
#define PICOMPRESS_H
|
||
|
||
#include "pibytearray.h"
|
||
#include "pip_compress_export.h"
|
||
|
||
//! \~english Compress "ba" with compression level "level", return empty %PIByteArray if no compression supports
|
||
//! \~russian Сжимает "ba" с уровнем сжатия "level", возвращает пустой %PIByteArray если нет поддержки
|
||
//! \~\ingroup Compress
|
||
//! \~\details
|
||
PIP_COMPRESS_EXPORT PIByteArray piCompress(const PIByteArray & ba, int level = 6);
|
||
|
||
//! \~english Decompress "zba", return empty %PIByteArray if no compression supports
|
||
//! \~russian Распаковывает "zba", возвращает пустой %PIByteArray если нет поддержки
|
||
//! \~\ingroup Compress
|
||
//! \~\details
|
||
PIP_COMPRESS_EXPORT PIByteArray piDecompress(const PIByteArray & zba);
|
||
|
||
#endif // PICOMPRESS_H
|