zlib.hpp

Go to the documentation of this file.

//
// Copyright (c) 2016-2017 Vinnie Falco (vinnie dot falco at gmail dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//
// Official repository: https://github.com/boostorg/beast
//

#ifndef BOOST_BEAST_ZLIB_ZLIB_HPP
#define BOOST_BEAST_ZLIB_ZLIB_HPP

#include <boost/beast/config.hpp>
#include <cstdint>
#include <cstdlib>

// This is a derivative work based on Zlib, copyright below:
/*
    Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler

    This software is provided 'as-is', without any express or implied
    warranty.  In no event will the authors be held liable for any damages
    arising from the use of this software.

    Permission is granted to anyone to use this software for any purpose,
    including commercial applications, and to alter it and redistribute it
    freely, subject to the following restrictions:

    1. The origin of this software must not be misrepresented; you must not
       claim that you wrote the original software. If you use this software
       in a product, an acknowledgment in the product documentation would be
       appreciated but is not required.
    2. Altered source versions must be plainly marked as such, and must not be
       misrepresented as being the original software.
    3. This notice may not be removed or altered from any source distribution.

    Jean-loup Gailly        Mark Adler
    jloup@gzip.org          madler@alumni.caltech.edu

    The data format used by the zlib library is described by RFCs (Request for
    Comments) 1950 to 1952 in the files http://tools.ietf.org/html/rfc1950
    (zlib format), rfc1951 (deflate format) and rfc1952 (gzip format).
*/

namespace boost {
namespace beast {
namespace zlib {

#if !defined(__MACTYPES__)
typedef unsigned char  Byte;  /* 8 bits */
#endif
typedef unsigned int   uInt;  /* 16 bits or more */

/* Possible values of the data_type field (though see inflate()) */
enum z_Type
{
    Z_BINARY    = 0,
    Z_TEXT      = 1,
    Z_UNKNOWN   = 2
};

struct z_params
{
    void const* next_in;

    std::size_t avail_in;

    std::size_t total_in = 0;

    void* next_out;

    std::size_t avail_out;

    std::size_t total_out = 0;

    int data_type = Z_UNKNOWN;  // best guess about the data type: binary or text
};

enum class Flush
{
    // order matters

    none,
    block,
    partial,
    sync,
    full,
    finish,
    trees
};

/* compression levels */
enum z_Compression
{
    Z_NO_COMPRESSION        =  0,
    Z_BEST_SPEED            =  1,
    Z_BEST_COMPRESSION      =  9,
    Z_DEFAULT_COMPRESSION   = -1
};

enum class Strategy
{
    normal,

    filtered,

    huffman,

    rle,

    fixed
};

} // zlib
} // beast
} // boost

#endif