include/openssl/stack.h

0001 /*
0002  * Copyright 1995-2025 The OpenSSL Project Authors. All Rights Reserved.
0003  *
0004  * Licensed under the Apache License 2.0 (the "License").  You may not use
0005  * this file except in compliance with the License.  You can obtain a copy
0006  * in the file LICENSE in the source distribution or at
0007  * https://www.openssl.org/source/license.html
0008  */
0009
0010 #ifndef OPENSSL_STACK_H
0011 # define OPENSSL_STACK_H
0012 # pragma once
0013
0014 # include <openssl/macros.h>
0015 # ifndef OPENSSL_NO_DEPRECATED_3_0
0016 #  define HEADER_STACK_H
0017 # endif
0018
0019 #ifdef  __cplusplus
0020 extern "C" {
0021 #endif
0022
0023 typedef struct stack_st OPENSSL_STACK; /* Use STACK_OF(...) instead */
0024
0025 typedef int (*OPENSSL_sk_compfunc)(const void *, const void *);
0026 typedef void (*OPENSSL_sk_freefunc)(void *);
0027 typedef void (*OPENSSL_sk_freefunc_thunk)(OPENSSL_sk_freefunc, void *);
0028 typedef void *(*OPENSSL_sk_copyfunc)(const void *);
0029
0030 int OPENSSL_sk_num(const OPENSSL_STACK *);
0031 void *OPENSSL_sk_value(const OPENSSL_STACK *, int);
0032
0033 void *OPENSSL_sk_set(OPENSSL_STACK *st, int i, const void *data);
0034
0035 OPENSSL_STACK *OPENSSL_sk_new(OPENSSL_sk_compfunc cmp);
0036 OPENSSL_STACK *OPENSSL_sk_new_null(void);
0037 OPENSSL_STACK *OPENSSL_sk_new_reserve(OPENSSL_sk_compfunc c, int n);
0038 OPENSSL_STACK *OPENSSL_sk_set_thunks(OPENSSL_STACK *st, OPENSSL_sk_freefunc_thunk f_thunk);
0039 int OPENSSL_sk_reserve(OPENSSL_STACK *st, int n);
0040 void OPENSSL_sk_free(OPENSSL_STACK *);
0041 void OPENSSL_sk_pop_free(OPENSSL_STACK *st, OPENSSL_sk_freefunc func);
0042 OPENSSL_STACK *OPENSSL_sk_deep_copy(const OPENSSL_STACK *,
0043                                     OPENSSL_sk_copyfunc c,
0044                                     OPENSSL_sk_freefunc f);
0045 int OPENSSL_sk_insert(OPENSSL_STACK *sk, const void *data, int where);
0046 void *OPENSSL_sk_delete(OPENSSL_STACK *st, int loc);
0047 void *OPENSSL_sk_delete_ptr(OPENSSL_STACK *st, const void *p);
0048 int OPENSSL_sk_find(OPENSSL_STACK *st, const void *data);
0049 int OPENSSL_sk_find_ex(OPENSSL_STACK *st, const void *data);
0050 int OPENSSL_sk_find_all(OPENSSL_STACK *st, const void *data, int *pnum);
0051 int OPENSSL_sk_push(OPENSSL_STACK *st, const void *data);
0052 int OPENSSL_sk_unshift(OPENSSL_STACK *st, const void *data);
0053 void *OPENSSL_sk_shift(OPENSSL_STACK *st);
0054 void *OPENSSL_sk_pop(OPENSSL_STACK *st);
0055 void OPENSSL_sk_zero(OPENSSL_STACK *st);
0056 OPENSSL_sk_compfunc OPENSSL_sk_set_cmp_func(OPENSSL_STACK *sk,
0057                                             OPENSSL_sk_compfunc cmp);
0058 OPENSSL_STACK *OPENSSL_sk_dup(const OPENSSL_STACK *st);
0059 void OPENSSL_sk_sort(OPENSSL_STACK *st);
0060 int OPENSSL_sk_is_sorted(const OPENSSL_STACK *st);
0061
0062 # ifndef OPENSSL_NO_DEPRECATED_1_1_0
0063 #  define _STACK OPENSSL_STACK
0064 #  define sk_num OPENSSL_sk_num
0065 #  define sk_value OPENSSL_sk_value
0066 #  define sk_set OPENSSL_sk_set
0067 #  define sk_new OPENSSL_sk_new
0068 #  define sk_new_null OPENSSL_sk_new_null
0069 #  define sk_free OPENSSL_sk_free
0070 #  define sk_pop_free OPENSSL_sk_pop_free
0071 #  define sk_deep_copy OPENSSL_sk_deep_copy
0072 #  define sk_insert OPENSSL_sk_insert
0073 #  define sk_delete OPENSSL_sk_delete
0074 #  define sk_delete_ptr OPENSSL_sk_delete_ptr
0075 #  define sk_find OPENSSL_sk_find
0076 #  define sk_find_ex OPENSSL_sk_find_ex
0077 #  define sk_push OPENSSL_sk_push
0078 #  define sk_unshift OPENSSL_sk_unshift
0079 #  define sk_shift OPENSSL_sk_shift
0080 #  define sk_pop OPENSSL_sk_pop
0081 #  define sk_zero OPENSSL_sk_zero
0082 #  define sk_set_cmp_func OPENSSL_sk_set_cmp_func
0083 #  define sk_dup OPENSSL_sk_dup
0084 #  define sk_sort OPENSSL_sk_sort
0085 #  define sk_is_sorted OPENSSL_sk_is_sorted
0086 # endif
0087
0088 #ifdef  __cplusplus
0089 }
0090 #endif
0091
0092 #endif