Ensure that no-comp functions are flagged as such
[openssl.git] / include / openssl / comp.h
1 /* ====================================================================
2  * Copyright (c) 1999-2015 The OpenSSL Project.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in
13  *    the documentation and/or other materials provided with the
14  *    distribution.
15  *
16  * 3. All advertising materials mentioning features or use of this
17  *    software must display the following acknowledgment:
18  *    "This product includes software developed by the OpenSSL Project
19  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
20  *
21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22  *    endorse or promote products derived from this software without
23  *    prior written permission. For written permission, please contact
24  *    openssl-core@OpenSSL.org.
25  *
26  * 5. Products derived from this software may not be called "OpenSSL"
27  *    nor may "OpenSSL" appear in their names without prior written
28  *    permission of the OpenSSL Project.
29  *
30  * 6. Redistributions of any form whatsoever must retain the following
31  *    acknowledgment:
32  *    "This product includes software developed by the OpenSSL Project
33  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
34  *
35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46  * OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This product includes cryptographic software written by Eric Young
50  * (eay@cryptsoft.com).  This product includes software written by Tim
51  * Hudson (tjh@cryptsoft.com).
52  *
53  */
54
55
56 #ifndef HEADER_COMP_H
57 # define HEADER_COMP_H
58
59 # include <openssl/crypto.h>
60
61 # ifdef OPENSSL_NO_COMP
62 #  error COMP is disabled.
63 # endif
64
65 #ifdef  __cplusplus
66 extern "C" {
67 #endif
68
69
70 COMP_CTX *COMP_CTX_new(COMP_METHOD *meth);
71 const COMP_METHOD *COMP_CTX_get_method(const COMP_CTX *ctx);
72 int COMP_CTX_get_type(const COMP_CTX* comp);
73 int COMP_get_type(const COMP_METHOD *meth);
74 const char *COMP_get_name(const COMP_METHOD *meth);
75 void COMP_CTX_free(COMP_CTX *ctx);
76
77 int COMP_compress_block(COMP_CTX *ctx, unsigned char *out, int olen,
78                         unsigned char *in, int ilen);
79 int COMP_expand_block(COMP_CTX *ctx, unsigned char *out, int olen,
80                       unsigned char *in, int ilen);
81
82 COMP_METHOD *COMP_zlib(void);
83 void COMP_zlib_cleanup(void);
84
85 # ifdef HEADER_BIO_H
86 #  ifdef ZLIB
87 BIO_METHOD *BIO_f_zlib(void);
88 #  endif
89 # endif
90
91 /* BEGIN ERROR CODES */
92 /*
93  * The following lines are auto generated by the script mkerr.pl. Any changes
94  * made after this point may be overwritten when the script is next run.
95  */
96 void ERR_load_COMP_strings(void);
97
98 /* Error codes for the COMP functions. */
99
100 /* Function codes. */
101 # define COMP_F_BIO_ZLIB_FLUSH                            99
102 # define COMP_F_BIO_ZLIB_NEW                              100
103 # define COMP_F_BIO_ZLIB_READ                             101
104 # define COMP_F_BIO_ZLIB_WRITE                            102
105
106 /* Reason codes. */
107 # define COMP_R_ZLIB_DEFLATE_ERROR                        99
108 # define COMP_R_ZLIB_INFLATE_ERROR                        100
109 # define COMP_R_ZLIB_NOT_SUPPORTED                        101
110
111 #ifdef  __cplusplus
112 }
113 #endif
114 #endif