Sparse array iterators include index position.
[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 # ifdef __cplusplus
15 extern "C" {
16 # endif
17
18 # define SPARSE_ARRAY_OF(type) struct sparse_array_st_ ## type
19
20 # define DEFINE_SPARSE_ARRAY_OF(type) \
21     SPARSE_ARRAY_OF(type); \
22     static ossl_inline SPARSE_ARRAY_OF(type) * \
23         ossl_sa_##type##_new(void) \
24     { \
25         return (SPARSE_ARRAY_OF(type) *)OPENSSL_SA_new(); \
26     } \
27     static ossl_inline void ossl_sa_##type##_free(SPARSE_ARRAY_OF(type) *sa) \
28     { \
29         OPENSSL_SA_free((OPENSSL_SA *)sa); \
30     } \
31     static ossl_inline void ossl_sa_##type##_free_leaves(SPARSE_ARRAY_OF(type) *sa) \
32     { \
33         OPENSSL_SA_free_leaves((OPENSSL_SA *)sa); \
34     } \
35     static ossl_inline size_t ossl_sa_##type##_num(const SPARSE_ARRAY_OF(type) *sa) \
36     { \
37         return OPENSSL_SA_num((OPENSSL_SA *)sa); \
38     } \
39     static ossl_inline void ossl_sa_##type##_doall(const SPARSE_ARRAY_OF(type) *sa, \
40                                                    void (*leaf)(size_t, type *)) \
41     { \
42         OPENSSL_SA_doall((OPENSSL_SA *)sa, (void (*)(size_t, void *))leaf); \
43     } \
44     static ossl_inline void ossl_sa_##type##_doall_arg(const SPARSE_ARRAY_OF(type) *sa, \
45                                                        void (*leaf)(size_t, \
46                                                                     type *, \
47                                                                     void *),\
48                                                        void *arg) \
49     { \
50         OPENSSL_SA_doall_arg((OPENSSL_SA *)sa, (void (*)(size_t, void *, void *))leaf, \
51                              arg); \
52     } \
53     static ossl_inline type *ossl_sa_##type##_get(const SPARSE_ARRAY_OF(type) *sa, \
54                                                   size_t n) \
55     { \
56         return (type *)OPENSSL_SA_get((OPENSSL_SA *)sa, n); \
57     } \
58     static ossl_inline int ossl_sa_##type##_set(SPARSE_ARRAY_OF(type) *sa, \
59                                                 size_t n, type *val) \
60     { \
61         return OPENSSL_SA_set((OPENSSL_SA *)sa, n, (void *)val); \
62     } \
63     SPARSE_ARRAY_OF(type)
64
65 typedef struct sparse_array_st OPENSSL_SA;
66 OPENSSL_SA *OPENSSL_SA_new(void);
67 void OPENSSL_SA_free(OPENSSL_SA *sa);
68 void OPENSSL_SA_free_leaves(OPENSSL_SA *sa);
69 size_t OPENSSL_SA_num(const OPENSSL_SA *sa);
70 void OPENSSL_SA_doall(const OPENSSL_SA *sa, void (*leaf)(size_t, void *));
71 void OPENSSL_SA_doall_arg(const OPENSSL_SA *sa,
72                           void (*leaf)(size_t, void *, void *), void *);
73 void *OPENSSL_SA_get(const OPENSSL_SA *sa, size_t n);
74 int OPENSSL_SA_set(OPENSSL_SA *sa, size_t n, void *val);
75
76 # ifdef  __cplusplus
77 }
78 # endif
79 #endif