Mark generated functions unused (applies to safestack, lhash, sparse_array)
[openssl.git] / crypto / include / internal / sparse_array.h
1 /*
2  * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
3  * Copyright (c) 2019, Oracle and/or its affiliates.  All rights reserved.
4  *
5  * Licensed under the Apache License 2.0 (the "License").  You may not use
6  * this file except in compliance with the License.  You can obtain a copy
7  * in the file LICENSE in the source distribution or at
8  * https://www.openssl.org/source/license.html
9  */
10
11 #ifndef HEADER_SPARSE_ARRAY_H
12 # define HEADER_SPARSE_ARRAY_H
13
14 # include <openssl/e_os2.h>
15
16 # ifdef __cplusplus
17 extern "C" {
18 # endif
19
20 # define SPARSE_ARRAY_OF(type) struct sparse_array_st_ ## type
21
22 # define DEFINE_SPARSE_ARRAY_OF(type) \
23     SPARSE_ARRAY_OF(type); \
24     static ossl_unused ossl_inline SPARSE_ARRAY_OF(type) * \
25         ossl_sa_##type##_new(void) \
26     { \
27         return (SPARSE_ARRAY_OF(type) *)OPENSSL_SA_new(); \
28     } \
29     static ossl_unused ossl_inline void ossl_sa_##type##_free(SPARSE_ARRAY_OF(type) *sa) \
30     { \
31         OPENSSL_SA_free((OPENSSL_SA *)sa); \
32     } \
33     static ossl_unused ossl_inline void ossl_sa_##type##_free_leaves(SPARSE_ARRAY_OF(type) *sa) \
34     { \
35         OPENSSL_SA_free_leaves((OPENSSL_SA *)sa); \
36     } \
37     static ossl_unused ossl_inline size_t ossl_sa_##type##_num(const SPARSE_ARRAY_OF(type) *sa) \
38     { \
39         return OPENSSL_SA_num((OPENSSL_SA *)sa); \
40     } \
41     static ossl_unused ossl_inline void ossl_sa_##type##_doall(const SPARSE_ARRAY_OF(type) *sa, \
42                                                    void (*leaf)(size_t, type *)) \
43     { \
44         OPENSSL_SA_doall((OPENSSL_SA *)sa, (void (*)(size_t, void *))leaf); \
45     } \
46     static ossl_unused ossl_inline \
47     void ossl_sa_##type##_doall_arg(const SPARSE_ARRAY_OF(type) *sa, \
48                                     void (*leaf)(size_t, type *, void *), \
49                                     void *arg) \
50     { \
51         OPENSSL_SA_doall_arg((OPENSSL_SA *)sa, (void (*)(size_t, void *, void *))leaf, \
52                              arg); \
53     } \
54     static ossl_unused ossl_inline type *ossl_sa_##type##_get(const SPARSE_ARRAY_OF(type) *sa, \
55                                                   size_t n) \
56     { \
57         return (type *)OPENSSL_SA_get((OPENSSL_SA *)sa, n); \
58     } \
59     static ossl_unused ossl_inline int ossl_sa_##type##_set(SPARSE_ARRAY_OF(type) *sa, \
60                                                 size_t n, type *val) \
61     { \
62         return OPENSSL_SA_set((OPENSSL_SA *)sa, n, (void *)val); \
63     } \
64     SPARSE_ARRAY_OF(type)
65
66 typedef struct sparse_array_st OPENSSL_SA;
67 OPENSSL_SA *OPENSSL_SA_new(void);
68 void OPENSSL_SA_free(OPENSSL_SA *sa);
69 void OPENSSL_SA_free_leaves(OPENSSL_SA *sa);
70 size_t OPENSSL_SA_num(const OPENSSL_SA *sa);
71 void OPENSSL_SA_doall(const OPENSSL_SA *sa, void (*leaf)(size_t, void *));
72 void OPENSSL_SA_doall_arg(const OPENSSL_SA *sa,
73                           void (*leaf)(size_t, void *, void *), void *);
74 void *OPENSSL_SA_get(const OPENSSL_SA *sa, size_t n);
75 int OPENSSL_SA_set(OPENSSL_SA *sa, size_t n, void *val);
76
77 # ifdef  __cplusplus
78 }
79 # endif
80 #endif