Sync usage with man page.
[netbsd-mini2440.git] / lib / libc / citrus / citrus_region.h
blob02af251b2752747d4fc8dba86be5b2b657ccae1a
1 /* $NetBSD: citrus_region.h,v 1.6 2005/05/14 17:55:42 tshiozak Exp $ */
3 /*-
4 * Copyright (c)2003 Citrus Project,
5 * All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
30 #ifndef _CITRUS_REGION_H_
31 #define _CITRUS_REGION_H_
33 #if HAVE_NBTOOL_CONFIG_H
34 #include "nbtool_config.h"
35 #endif
37 struct _citrus_region {
38 /* private: */
39 void *r_head;
40 size_t r_size;
43 static __inline void
44 _citrus_region_init(struct _citrus_region *r, void *h, size_t sz)
46 _DIAGASSERT(r);
47 r->r_head = h;
48 r->r_size = sz;
51 static __inline void *
52 _citrus_region_head(const struct _citrus_region *r)
54 return r->r_head;
57 static __inline size_t
58 _citrus_region_size(const struct _citrus_region *r)
60 return r->r_size;
63 static __inline int
64 _citrus_region_check(const struct _citrus_region *r, size_t ofs, size_t sz)
66 return r->r_size >= ofs + sz ? 0 : -1;
69 static __inline void *
70 _citrus_region_offset(const struct _citrus_region *r, size_t pos)
72 return (void *)((uint8_t *)r->r_head + pos);
75 static __inline uint8_t
76 _citrus_region_peek8(const struct _citrus_region *r, size_t pos)
78 return *(uint8_t *)_citrus_region_offset(r, pos);
81 static __inline uint16_t
82 _citrus_region_peek16(const struct _citrus_region *r, size_t pos)
84 uint16_t val;
85 memcpy(&val, _citrus_region_offset(r, pos), (size_t)2);
86 return val;
89 static __inline uint32_t
90 _citrus_region_peek32(const struct _citrus_region *r, size_t pos)
92 uint32_t val;
93 memcpy(&val, _citrus_region_offset(r, pos), (size_t)4);
94 return val;
97 static __inline int
98 _citrus_region_get_subregion(struct _citrus_region *subr,
99 const struct _citrus_region *r,
100 size_t ofs, size_t sz)
102 if (_citrus_region_check(r, ofs, sz))
103 return -1;
104 _citrus_region_init(subr, _citrus_region_offset(r, ofs), sz);
105 return 0;
108 #endif