/*
 * {- join("\n * ", @autowarntext) -}
 *
 * Copyright 1999-2025 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

/* clang-format off */
{-
use OpenSSL::stackhash qw(generate_stack_string_macros
                          generate_stack_const_string_macros
                          generate_stack_block_macros);
-}
/* clang-format on */

#ifndef OPENSSL_SAFESTACK_H
#define OPENSSL_SAFESTACK_H
#pragma once

#include <openssl/macros.h>
#ifndef OPENSSL_NO_DEPRECATED_3_0
#define HEADER_SAFESTACK_H
#endif

#include <openssl/stack.h>
#include <openssl/e_os2.h>

#ifdef __cplusplus
extern "C" {
#endif

#define STACK_OF(type) struct stack_st_##type

/* Helper macro for internal use */
#define SKM_DEFINE_STACK_OF_INTERNAL(t1, t2, t3)                                                                \
    STACK_OF(t1);                                                                                               \
    typedef int (*sk_##t1##_compfunc)(const t3 *const *a, const t3 *const *b);                                  \
    typedef void (*sk_##t1##_freefunc)(t3 * a);                                                                 \
    typedef t3 *(*sk_##t1##_copyfunc)(const t3 *a);                                                             \
    static ossl_inline void sk_##t1##_freefunc_thunk(OPENSSL_sk_freefunc freefunc_arg, void *ptr)               \
    {                                                                                                           \
        sk_##t1##_freefunc freefunc = (sk_##t1##_freefunc)freefunc_arg;                                         \
        freefunc((t3 *)ptr);                                                                                    \
    }                                                                                                           \
    static ossl_unused ossl_inline t2 *ossl_check_##t1##_type(t2 *ptr)                                          \
    {                                                                                                           \
        return ptr;                                                                                             \
    }                                                                                                           \
    static ossl_unused ossl_inline const OPENSSL_STACK *ossl_check_const_##t1##_sk_type(const STACK_OF(t1) *sk) \
    {                                                                                                           \
        return (const OPENSSL_STACK *)sk;                                                                       \
    }                                                                                                           \
    static ossl_unused ossl_inline OPENSSL_STACK *ossl_check_##t1##_sk_type(STACK_OF(t1) *sk)                   \
    {                                                                                                           \
        return (OPENSSL_STACK *)sk;                                                                             \
    }                                                                                                           \
    static ossl_unused ossl_inline OPENSSL_sk_compfunc ossl_check_##t1##_compfunc_type(sk_##t1##_compfunc cmp)  \
    {                                                                                                           \
        return (OPENSSL_sk_compfunc)cmp;                                                                        \
    }                                                                                                           \
    static ossl_unused ossl_inline OPENSSL_sk_copyfunc ossl_check_##t1##_copyfunc_type(sk_##t1##_copyfunc cpy)  \
    {                                                                                                           \
        return (OPENSSL_sk_copyfunc)cpy;                                                                        \
    }                                                                                                           \
    static ossl_unused ossl_inline OPENSSL_sk_freefunc ossl_check_##t1##_freefunc_type(sk_##t1##_freefunc fr)   \
    {                                                                                                           \
        return (OPENSSL_sk_freefunc)fr;                                                                         \
    }

#define SKM_DEFINE_STACK_OF(t1, t2, t3)                                                                                    \
    STACK_OF(t1);                                                                                                          \
    typedef int (*sk_##t1##_compfunc)(const t3 *const *a, const t3 *const *b);                                             \
    typedef void (*sk_##t1##_freefunc)(t3 * a);                                                                            \
    typedef t3 *(*sk_##t1##_copyfunc)(const t3 *a);                                                                        \
    static ossl_inline void sk_##t1##_freefunc_thunk(OPENSSL_sk_freefunc freefunc_arg, void *ptr)                          \
    {                                                                                                                      \
        sk_##t1##_freefunc freefunc = (sk_##t1##_freefunc)freefunc_arg;                                                    \
        freefunc((t3 *)ptr);                                                                                               \
    }                                                                                                                      \
    static ossl_unused ossl_inline int sk_##t1##_num(const STACK_OF(t1) *sk)                                               \
    {                                                                                                                      \
        return OPENSSL_sk_num((const OPENSSL_STACK *)sk);                                                                  \
    }                                                                                                                      \
    static ossl_unused ossl_inline t2 *sk_##t1##_value(const STACK_OF(t1) *sk, int idx)                                    \
    {                                                                                                                      \
        return (t2 *)OPENSSL_sk_value((const OPENSSL_STACK *)sk, idx);                                                     \
    }                                                                                                                      \
    static ossl_unused ossl_inline STACK_OF(t1) *sk_##t1##_new(sk_##t1##_compfunc compare)                                 \
    {                                                                                                                      \
        OPENSSL_STACK *ret = OPENSSL_sk_new((OPENSSL_sk_compfunc)compare);                                                 \
        OPENSSL_sk_freefunc_thunk f_thunk;                                                                                 \
                                                                                                                           \
        f_thunk = (OPENSSL_sk_freefunc_thunk)sk_##t1##_freefunc_thunk;                                                     \
        return (STACK_OF(t1) *)OPENSSL_sk_set_thunks(ret, f_thunk);                                                        \
    }                                                                                                                      \
    static ossl_unused ossl_inline STACK_OF(t1) *sk_##t1##_new_null(void)                                                  \
    {                                                                                                                      \
        return (STACK_OF(t1) *)OPENSSL_sk_new_null();                                                                      \
    }                                                                                                                      \
    static ossl_unused ossl_inline STACK_OF(t1) *sk_##t1##_new_reserve(sk_##t1##_compfunc compare, int n)                  \
    {                                                                                                                      \
        OPENSSL_STACK *ret = OPENSSL_sk_new_reserve((OPENSSL_sk_compfunc)compare, n);                                      \
        OPENSSL_sk_freefunc_thunk f_thunk;                                                                                 \
                                                                                                                           \
        f_thunk = (OPENSSL_sk_freefunc_thunk)sk_##t1##_freefunc_thunk;                                                     \
        return (STACK_OF(t1) *)OPENSSL_sk_set_thunks(ret, f_thunk);                                                        \
    }                                                                                                                      \
    static ossl_unused ossl_inline int sk_##t1##_reserve(STACK_OF(t1) *sk, int n)                                          \
    {                                                                                                                      \
        return OPENSSL_sk_reserve((OPENSSL_STACK *)sk, n);                                                                 \
    }                                                                                                                      \
    static ossl_unused ossl_inline void sk_##t1##_free(STACK_OF(t1) *sk)                                                   \
    {                                                                                                                      \
        OPENSSL_sk_free((OPENSSL_STACK *)sk);                                                                              \
    }                                                                                                                      \
    static ossl_unused ossl_inline void sk_##t1##_zero(STACK_OF(t1) *sk)                                                   \
    {                                                                                                                      \
        OPENSSL_sk_zero((OPENSSL_STACK *)sk);                                                                              \
    }                                                                                                                      \
    static ossl_unused ossl_inline t2 *sk_##t1##_delete(STACK_OF(t1) *sk, int i)                                           \
    {                                                                                                                      \
        return (t2 *)OPENSSL_sk_delete((OPENSSL_STACK *)sk, i);                                                            \
    }                                                                                                                      \
    static ossl_unused ossl_inline t2 *sk_##t1##_delete_ptr(STACK_OF(t1) *sk, t2 *ptr)                                     \
    {                                                                                                                      \
        return (t2 *)OPENSSL_sk_delete_ptr((OPENSSL_STACK *)sk,                                                            \
            (const void *)ptr);                                                                                            \
    }                                                                                                                      \
    static ossl_unused ossl_inline int sk_##t1##_push(STACK_OF(t1) *sk, t2 *ptr)                                           \
    {                                                                                                                      \
        return OPENSSL_sk_push((OPENSSL_STACK *)sk, (const void *)ptr);                                                    \
    }                                                                                                                      \
    static ossl_unused ossl_inline int sk_##t1##_unshift(STACK_OF(t1) *sk, t2 *ptr)                                        \
    {                                                                                                                      \
        return OPENSSL_sk_unshift((OPENSSL_STACK *)sk, (const void *)ptr);                                                 \
    }                                                                                                                      \
    static ossl_unused ossl_inline t2 *sk_##t1##_pop(STACK_OF(t1) *sk)                                                     \
    {                                                                                                                      \
        return (t2 *)OPENSSL_sk_pop((OPENSSL_STACK *)sk);                                                                  \
    }                                                                                                                      \
    static ossl_unused ossl_inline t2 *sk_##t1##_shift(STACK_OF(t1) *sk)                                                   \
    {                                                                                                                      \
        return (t2 *)OPENSSL_sk_shift((OPENSSL_STACK *)sk);                                                                \
    }                                                                                                                      \
    static ossl_unused ossl_inline void sk_##t1##_pop_free(STACK_OF(t1) *sk, sk_##t1##_freefunc freefunc)                  \
    {                                                                                                                      \
        OPENSSL_sk_freefunc_thunk f_thunk;                                                                                 \
                                                                                                                           \
        f_thunk = (OPENSSL_sk_freefunc_thunk)sk_##t1##_freefunc_thunk;                                                     \
        sk = (STACK_OF(t1) *)OPENSSL_sk_set_thunks((OPENSSL_STACK *)sk, f_thunk);                                          \
                                                                                                                           \
        OPENSSL_sk_pop_free((OPENSSL_STACK *)sk, (OPENSSL_sk_freefunc)freefunc);                                           \
    }                                                                                                                      \
    static ossl_unused ossl_inline int sk_##t1##_insert(STACK_OF(t1) *sk, t2 *ptr, int idx)                                \
    {                                                                                                                      \
        return OPENSSL_sk_insert((OPENSSL_STACK *)sk, (const void *)ptr, idx);                                             \
    }                                                                                                                      \
    static ossl_unused ossl_inline t2 *sk_##t1##_set(STACK_OF(t1) *sk, int idx, t2 *ptr)                                   \
    {                                                                                                                      \
        return (t2 *)OPENSSL_sk_set((OPENSSL_STACK *)sk, idx, (const void *)ptr);                                          \
    }                                                                                                                      \
    static ossl_unused ossl_inline int sk_##t1##_find(const STACK_OF(t1) *sk, t2 *ptr)                                     \
    {                                                                                                                      \
        return OPENSSL_sk_find((const OPENSSL_STACK *)sk, (const void *)ptr);                                              \
    }                                                                                                                      \
    static ossl_unused ossl_inline int sk_##t1##_find_ex(const STACK_OF(t1) *sk, t2 *ptr)                                  \
    {                                                                                                                      \
        return OPENSSL_sk_find_ex((const OPENSSL_STACK *)sk, (const void *)ptr);                                           \
    }                                                                                                                      \
    static ossl_unused ossl_inline int sk_##t1##_find_all(const STACK_OF(t1) *sk, t2 *ptr,                                 \
        int *pnum)                                                                                                         \
    {                                                                                                                      \
        return OPENSSL_sk_find_all((const OPENSSL_STACK *)sk, (const void *)ptr, pnum);                                    \
    }                                                                                                                      \
    static ossl_unused ossl_inline void sk_##t1##_sort(STACK_OF(t1) *sk)                                                   \
    {                                                                                                                      \
        OPENSSL_sk_sort((OPENSSL_STACK *)sk);                                                                              \
    }                                                                                                                      \
    static ossl_unused ossl_inline int sk_##t1##_is_sorted(const STACK_OF(t1) *sk)                                         \
    {                                                                                                                      \
        return OPENSSL_sk_is_sorted((const OPENSSL_STACK *)sk);                                                            \
    }                                                                                                                      \
    static ossl_unused ossl_inline STACK_OF(t1) *sk_##t1##_dup(const STACK_OF(t1) *sk)                                     \
    {                                                                                                                      \
        return (STACK_OF(t1) *)OPENSSL_sk_dup((const OPENSSL_STACK *)sk);                                                  \
    }                                                                                                                      \
    static ossl_unused ossl_inline STACK_OF(t1) *sk_##t1##_deep_copy(const STACK_OF(t1) *sk,                               \
        sk_##t1##_copyfunc copyfunc,                                                                                       \
        sk_##t1##_freefunc freefunc)                                                                                       \
    {                                                                                                                      \
        return (STACK_OF(t1) *)OPENSSL_sk_deep_copy((const OPENSSL_STACK *)sk,                                             \
            (OPENSSL_sk_copyfunc)copyfunc,                                                                                 \
            (OPENSSL_sk_freefunc)freefunc);                                                                                \
    }                                                                                                                      \
    static ossl_unused ossl_inline sk_##t1##_compfunc sk_##t1##_set_cmp_func(STACK_OF(t1) *sk, sk_##t1##_compfunc compare) \
    {                                                                                                                      \
        return (sk_##t1##_compfunc)OPENSSL_sk_set_cmp_func((OPENSSL_STACK *)sk, (OPENSSL_sk_compfunc)compare);             \
    }

#define DEFINE_STACK_OF(t) SKM_DEFINE_STACK_OF(t, t, t)
#define DEFINE_STACK_OF_CONST(t) SKM_DEFINE_STACK_OF(t, const t, t)
#define DEFINE_SPECIAL_STACK_OF(t1, t2) SKM_DEFINE_STACK_OF(t1, t2, t2)
#define DEFINE_SPECIAL_STACK_OF_CONST(t1, t2) \
    SKM_DEFINE_STACK_OF(t1, const t2, t2)

/*-
 * Strings are special: normally an lhash entry will point to a single
 * (somewhat) mutable object. In the case of strings:
 *
 * a) Instead of a single char, there is an array of chars, NUL-terminated.
 * b) The string may have be immutable.
 *
 * So, they need their own declarations. Especially important for
 * type-checking tools, such as Deputy.
 *
 * In practice, however, it appears to be hard to have a const
 * string. For now, I'm settling for dealing with the fact it is a
 * string at all.
 */
typedef char *OPENSSL_STRING;
typedef const char *OPENSSL_CSTRING;

/*-
 * Confusingly, LHASH_OF(STRING) deals with char ** throughout, but
 * STACK_OF(STRING) is really more like STACK_OF(char), only, as mentioned
 * above, instead of a single char each entry is a NUL-terminated array of
 * chars. So, we have to implement STRING specially for STACK_OF. This is
 * dealt with in the autogenerated macros below.
 */
/* clang-format off */
{-
    generate_stack_string_macros()
    .generate_stack_const_string_macros();
-}
/* clang-format on */

#if !defined(OPENSSL_NO_DEPRECATED_3_0)
/*
 * This is not used by OpenSSL.  A block of bytes,  NOT nul-terminated.
 * These should also be distinguished from "normal" stacks.
 */
typedef void *OPENSSL_BLOCK;
/* clang-format off */
{-
    generate_stack_block_macros();
-}
/* clang-format on */
#endif

#ifdef __cplusplus
}
#endif
#endif
