1/*
2 * Copyright 1995-2025 The OpenSSL Project Authors. All Rights Reserved.
3 *
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
8 */
9
10#ifndef OPENSSL_STACK_H
11# define OPENSSL_STACK_H
12# pragma once
13
14# include <openssl/macros.h>
15# ifndef OPENSSL_NO_DEPRECATED_3_0
16# define HEADER_STACK_H
17# endif
18
19#ifdef __cplusplus
20extern "C" {
21#endif
22
23typedef struct stack_st OPENSSL_STACK; /* Use STACK_OF(...) instead */
24
25typedef int (*OPENSSL_sk_compfunc)(const void *, const void *);
26typedef void (*OPENSSL_sk_freefunc)(void *);
27typedef void (*OPENSSL_sk_freefunc_thunk)(OPENSSL_sk_freefunc, void *);
28typedef void *(*OPENSSL_sk_copyfunc)(const void *);
29
30int OPENSSL_sk_num(const OPENSSL_STACK *);
31void *OPENSSL_sk_value(const OPENSSL_STACK *, int);
32
33void *OPENSSL_sk_set(OPENSSL_STACK *st, int i, const void *data);
34
35OPENSSL_STACK *OPENSSL_sk_new(OPENSSL_sk_compfunc cmp);
36OPENSSL_STACK *OPENSSL_sk_new_null(void);
37OPENSSL_STACK *OPENSSL_sk_new_reserve(OPENSSL_sk_compfunc c, int n);
38OPENSSL_STACK *OPENSSL_sk_set_thunks(OPENSSL_STACK *st, OPENSSL_sk_freefunc_thunk f_thunk);
39int OPENSSL_sk_reserve(OPENSSL_STACK *st, int n);
40void OPENSSL_sk_free(OPENSSL_STACK *);
41void OPENSSL_sk_pop_free(OPENSSL_STACK *st, OPENSSL_sk_freefunc func);
42OPENSSL_STACK *OPENSSL_sk_deep_copy(const OPENSSL_STACK *,
43 OPENSSL_sk_copyfunc c,
44 OPENSSL_sk_freefunc f);
45int OPENSSL_sk_insert(OPENSSL_STACK *sk, const void *data, int where);
46void *OPENSSL_sk_delete(OPENSSL_STACK *st, int loc);
47void *OPENSSL_sk_delete_ptr(OPENSSL_STACK *st, const void *p);
48int OPENSSL_sk_find(OPENSSL_STACK *st, const void *data);
49int OPENSSL_sk_find_ex(OPENSSL_STACK *st, const void *data);
50int OPENSSL_sk_find_all(OPENSSL_STACK *st, const void *data, int *pnum);
51int OPENSSL_sk_push(OPENSSL_STACK *st, const void *data);
52int OPENSSL_sk_unshift(OPENSSL_STACK *st, const void *data);
53void *OPENSSL_sk_shift(OPENSSL_STACK *st);
54void *OPENSSL_sk_pop(OPENSSL_STACK *st);
55void OPENSSL_sk_zero(OPENSSL_STACK *st);
56OPENSSL_sk_compfunc OPENSSL_sk_set_cmp_func(OPENSSL_STACK *sk,
57 OPENSSL_sk_compfunc cmp);
58OPENSSL_STACK *OPENSSL_sk_dup(const OPENSSL_STACK *st);
59void OPENSSL_sk_sort(OPENSSL_STACK *st);
60int OPENSSL_sk_is_sorted(const OPENSSL_STACK *st);
61
62# ifndef OPENSSL_NO_DEPRECATED_1_1_0
63# define _STACK OPENSSL_STACK
64# define sk_num OPENSSL_sk_num
65# define sk_value OPENSSL_sk_value
66# define sk_set OPENSSL_sk_set
67# define sk_new OPENSSL_sk_new
68# define sk_new_null OPENSSL_sk_new_null
69# define sk_free OPENSSL_sk_free
70# define sk_pop_free OPENSSL_sk_pop_free
71# define sk_deep_copy OPENSSL_sk_deep_copy
72# define sk_insert OPENSSL_sk_insert
73# define sk_delete OPENSSL_sk_delete
74# define sk_delete_ptr OPENSSL_sk_delete_ptr
75# define sk_find OPENSSL_sk_find
76# define sk_find_ex OPENSSL_sk_find_ex
77# define sk_push OPENSSL_sk_push
78# define sk_unshift OPENSSL_sk_unshift
79# define sk_shift OPENSSL_sk_shift
80# define sk_pop OPENSSL_sk_pop
81# define sk_zero OPENSSL_sk_zero
82# define sk_set_cmp_func OPENSSL_sk_set_cmp_func
83# define sk_dup OPENSSL_sk_dup
84# define sk_sort OPENSSL_sk_sort
85# define sk_is_sorted OPENSSL_sk_is_sorted
86# endif
87
88#ifdef __cplusplus
89}
90#endif
91
92#endif
93