Allow inclusion of Citrus modules in statically linked binaries.
[dragonfly.git] / lib / libc / citrus / citrus_mapper_local.h
1 /*      $NetBSD: src/lib/libc/citrus/citrus_mapper_local.h,v 1.1 2003/06/25 09:51:36 tshiozak Exp $     */
2 /*      $DragonFly: src/lib/libc/citrus/citrus_mapper_local.h,v 1.2 2005/07/04 08:02:43 joerg Exp $ */
3
4 /*-
5  * Copyright (c)2003 Citrus Project,
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29
30 #ifndef _CITRUS_MAPPER_LOCAL_H_
31 #define _CITRUS_MAPPER_LOCAL_H_
32
33 #include "citrus_module.h"
34
35 #define _CITRUS_MAPPER_GETOPS_FUNC_BASE(_n_)                            \
36 int _n_(struct _citrus_mapper_ops *, size_t, u_int32_t)
37 #define _CITRUS_MAPPER_GETOPS_FUNC(_n_)                                 \
38 _CITRUS_MAPPER_GETOPS_FUNC_BASE(_citrus_##_n_##_mapper_getops)
39
40 #define _CITRUS_MAPPER_DECLS(_m_)                                       \
41 static int      _citrus_##_m_##_mapper_init                             \
42         (struct _citrus_mapper_area *__restrict,                        \
43          struct _citrus_mapper * __restrict, const char * __restrict,   \
44          const void * __restrict, size_t,                               \
45          struct _citrus_mapper_traits * __restrict, size_t);            \
46 static void     _citrus_##_m_##_mapper_uninit(struct _citrus_mapper *); \
47 static int      _citrus_##_m_##_mapper_convert                          \
48         (struct _citrus_mapper * __restrict,                            \
49          _citrus_index_t * __restrict, _citrus_index_t,                 \
50          void * __restrict);                                            \
51 static void     _citrus_##_m_##_mapper_init_state                       \
52         (struct _citrus_mapper * __restrict, void * __restrict);        \
53 CITRUS_MODULE(_m_, mapper, _citrus_##_m_##_mapper_getops)
54
55 #define _CITRUS_MAPPER_DEF_OPS(_m_)                                     \
56 struct _citrus_mapper_ops _citrus_##_m_##_mapper_ops = {                \
57         /* mo_abi_version */    _CITRUS_MAPPER_ABI_VERSION,             \
58         /* mo_init */           &_citrus_##_m_##_mapper_init,           \
59         /* mo_uninit */         &_citrus_##_m_##_mapper_uninit,         \
60         /* mo_convert */        &_citrus_##_m_##_mapper_convert,        \
61         /* mo_init_state */     &_citrus_##_m_##_mapper_init_state      \
62 }
63
64 typedef _CITRUS_MAPPER_GETOPS_FUNC_BASE((*_citrus_mapper_getops_t));
65 typedef int     (*_citrus_mapper_init_t)(
66         struct _citrus_mapper_area *__restrict,
67         struct _citrus_mapper *__restrict, const char *__restrict,
68         const void *__restrict, size_t,
69         struct _citrus_mapper_traits * __restrict, size_t);
70 typedef void    (*_citrus_mapper_uninit_t)(struct _citrus_mapper *);
71 typedef int     (*_citrus_mapper_convert_t)(struct _citrus_mapper * __restrict,
72                                             _citrus_index_t * __restrict,
73                                             _citrus_index_t,
74                                             void * __restrict);
75 typedef void    (*_citrus_mapper_init_state_t)(
76         struct _citrus_mapper * __restrict, void * __restrict);
77
78 /*
79  * ABI version change log
80  *   0x00000001
81  *     initial version
82  */
83 #define _CITRUS_MAPPER_ABI_VERSION      0x00000001
84 struct _citrus_mapper_ops {
85         uint32_t                        mo_abi_version;
86         /* version 0x00000001 */
87         _citrus_mapper_init_t           mo_init;
88         _citrus_mapper_uninit_t         mo_uninit;
89         _citrus_mapper_convert_t        mo_convert;
90         _citrus_mapper_init_state_t     mo_init_state;
91 };
92
93 struct _citrus_mapper_traits {
94         /* version 0x00000001 */
95         size_t                          mt_state_size;
96         size_t                          mt_src_max;
97         size_t                          mt_dst_max;
98 };
99
100 struct _citrus_mapper {
101         struct _citrus_mapper_ops               *cm_ops;
102         void                                    *cm_closure;
103         _citrus_module_t                        cm_module;
104         struct _citrus_mapper_traits            *cm_traits;
105         _CITRUS_HASH_ENTRY(_citrus_mapper)      cm_entry;
106         int                                     cm_refcount;
107         char                                    *cm_key;
108 };
109 #endif