Make BN_num_bits_word constant-time.
[openssl.git] / crypto / stack / stack.h
1 /* crypto/stack/stack.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 #ifndef HEADER_STACK_H
60 # define HEADER_STACK_H
61
62 #ifdef  __cplusplus
63 extern "C" {
64 #endif
65
66 typedef struct stack_st {
67     int num;
68     char **data;
69     int sorted;
70     int num_alloc;
71     int (*comp) (const void *, const void *);
72 } _STACK;                       /* Use STACK_OF(...) instead */
73
74 # define M_sk_num(sk)            ((sk) ? (sk)->num:-1)
75 # define M_sk_value(sk,n)        ((sk) ? (sk)->data[n] : NULL)
76
77 int sk_num(const _STACK *);
78 void *sk_value(const _STACK *, int);
79
80 void *sk_set(_STACK *, int, void *);
81
82 _STACK *sk_new(int (*cmp) (const void *, const void *));
83 _STACK *sk_new_null(void);
84 void sk_free(_STACK *);
85 void sk_pop_free(_STACK *st, void (*func) (void *));
86 _STACK *sk_deep_copy(_STACK *, void *(*)(void *), void (*)(void *));
87 int sk_insert(_STACK *sk, void *data, int where);
88 void *sk_delete(_STACK *st, int loc);
89 void *sk_delete_ptr(_STACK *st, void *p);
90 int sk_find(_STACK *st, void *data);
91 int sk_find_ex(_STACK *st, void *data);
92 int sk_push(_STACK *st, void *data);
93 int sk_unshift(_STACK *st, void *data);
94 void *sk_shift(_STACK *st);
95 void *sk_pop(_STACK *st);
96 void sk_zero(_STACK *st);
97 int (*sk_set_cmp_func(_STACK *sk, int (*c) (const void *, const void *)))
98  (const void *, const void *);
99 _STACK *sk_dup(_STACK *st);
100 void sk_sort(_STACK *st);
101 int sk_is_sorted(const _STACK *st);
102
103 #ifdef  __cplusplus
104 }
105 #endif
106
107 #endif