1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2005 Ivan Voras <ivoras@gmail.com>
5 * All rights reserved.
6 *
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.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS 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 AUTHORS 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.
27 *
28 * $FreeBSD$
29 */
30
31// $Id: binstream.h,v 1.1 2006/07/05 10:47:54 ivoras Exp $
32
33#ifndef _BIN_STREAM_
34#define _BIN_STREAM_
35
36#ifndef uint8_t
37#define uint8_t unsigned char
38#endif
39
40typedef struct {
41	unsigned char  *data;
42	int		pos;
43}	bin_stream_t;
44
45/* "Open" a binary stream for reading */
46void		bs_open   (bin_stream_t * bs, void *data);
47
48/* "Reset" position in binary stream to zero */
49void		bs_reset  (bin_stream_t * bs);
50
51/* Write a zero-terminated string; return next position */
52unsigned	bs_write_str(bin_stream_t * bs, char *data);
53
54/* Write an arbitrary buffer; return next position */
55unsigned	bs_write_buf(bin_stream_t * bs, char *data, unsigned data_size);
56
57/* Write a 8bit uint; return next position. */
58unsigned	bs_write_u8(bin_stream_t * bs, uint8_t data);
59
60/* Write a 16bit uint; return next position. */
61unsigned	bs_write_u16(bin_stream_t * bs, uint16_t data);
62
63/* Write a 32bit uint; return next position. */
64unsigned	bs_write_u32(bin_stream_t * bs, uint32_t data);
65
66/* Write a 64bit uint; return next position. */
67unsigned	bs_write_u64(bin_stream_t * bs, uint64_t data);
68
69/*
70 * Read a null-terminated string from stream into a buffer; buf_size is size
71 * of the buffer, including the final \0. Returns buf pointer or NULL if
72 * garbage input.
73 */
74char           *bs_read_str(bin_stream_t * bs, char *buf, unsigned buf_size);
75
76/* Read an arbitrary buffer. */
77void		bs_read_buf(bin_stream_t * bs, char *buf, unsigned buf_size);
78
79/* Read a 8bit uint * return it */
80uint8_t		bs_read_u8(bin_stream_t * bs);
81
82/* Read a 16bit uint * return it */
83uint16_t	bs_read_u16(bin_stream_t * bs);
84
85/* Read a 8bit uint * return it */
86uint32_t	bs_read_u32(bin_stream_t * bs);
87
88/* Read a 8bit uint * return it */
89uint64_t	bs_read_u64(bin_stream_t * bs);
90
91#endif
92