annotate pack.h @ 153:a6a7cd08be72

pack.c: o added two new functions pack_fmtlen, pack_vfmtlen, compute the number of bytes needed for format. o added support for buffer, pack_swrite, pack_vswrite, pack_sread, pack_vsread. Buffer will be automatically allocated for _write functions.
author David Demelier <markand@malikania.fr>
date Sun, 15 Jul 2012 20:40:54 +0200
parents 07800b7af208
children c7ad101ed4a1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
56
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
98
b1a084c030c8 Happy new year
David Demelier <markand@malikania.fr>
parents: 57
diff changeset
2 * pack.h -- endian dependant binary file reader
b1a084c030c8 Happy new year
David Demelier <markand@malikania.fr>
parents: 57
diff changeset
3 *
b1a084c030c8 Happy new year
David Demelier <markand@malikania.fr>
parents: 57
diff changeset
4 * Copyright (c) 2011, 2012, David Demelier <markand@malikania.fr>
56
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef _PACK_H_
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define _PACK_H_
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #include <stdarg.h>
153
a6a7cd08be72 pack.c:
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
23 #include <stdint.h>
56
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
135
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 99
diff changeset
25 #ifdef __cplusplus
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 99
diff changeset
26 extern "C" {
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 99
diff changeset
27 #endif
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 99
diff changeset
28
56
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 /*
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 * Endian detection based on SDL_endian.h
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 */
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
32
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 #undef PACK_HOST_BYTEORDER
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
34
57
311eaa9d004c Renamed pack_* fonction for our guidelines
David Demelier <markand@malikania.fr>
parents: 56
diff changeset
35 #define PACK_LE 1234
311eaa9d004c Renamed pack_* fonction for our guidelines
David Demelier <markand@malikania.fr>
parents: 56
diff changeset
36 #define PACK_BE 4321
56
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
37
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 #if defined(__hppa__) || \
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 defined(__m68k__) || defined(mc68000) || defined(_M_M68K) || \
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 (defined(__MIPS__) && defined(__MISPEB__)) || \
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 defined(__ppc__) || defined(__POWERPC__) || defined(_M_PPC) || \
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 defined(__sparc__)
57
311eaa9d004c Renamed pack_* fonction for our guidelines
David Demelier <markand@malikania.fr>
parents: 56
diff changeset
43 # define PACK_HOST_BYTEORDER PACK_BE
56
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 #else
57
311eaa9d004c Renamed pack_* fonction for our guidelines
David Demelier <markand@malikania.fr>
parents: 56
diff changeset
45 # define PACK_HOST_BYTEORDER PACK_LE
56
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 #endif
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
47
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 #define pack_swap16(x) \
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 ((((x) >> 8) & 0x00FFL) | (((x) << 8) & 0xFF00L))
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
50
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 #define pack_swap32(x) ((((x) >> 24) & 0x000000FFL) \
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 | (((x) >> 8) & 0x0000FF00L) \
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 | (((x) << 8) & 0x00FF0000L) \
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 | (((x) << 24) & 0xFF000000L))
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
55
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 #define pack_swap64(x) (((uint64_t) \
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 ((uint32_t) pack_swap32((uint32_t) (((x) << 32) >> 32))) << 32) \
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 | (uint32_t) pack_swap32((uint32_t) ((x) >> 32)))
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
59
153
a6a7cd08be72 pack.c:
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
60 size_t pack_fmtlen(int, const char *, ...);
a6a7cd08be72 pack.c:
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
61 size_t pack_vfmtlen(int, const char *, va_list);
a6a7cd08be72 pack.c:
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
62
a6a7cd08be72 pack.c:
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
63 int pack_swrite(int, uint8_t **, size_t *, const char *, ...);
a6a7cd08be72 pack.c:
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
64 int pack_vswrite(int, uint8_t **, size_t *, const char *, va_list);
57
311eaa9d004c Renamed pack_* fonction for our guidelines
David Demelier <markand@malikania.fr>
parents: 56
diff changeset
65 int pack_write(int, const char *, const char *, ...);
311eaa9d004c Renamed pack_* fonction for our guidelines
David Demelier <markand@malikania.fr>
parents: 56
diff changeset
66 int pack_vwrite(int, const char *, const char *, va_list);
311eaa9d004c Renamed pack_* fonction for our guidelines
David Demelier <markand@malikania.fr>
parents: 56
diff changeset
67 int pack_fwrite(int, FILE *, const char *, ...);
311eaa9d004c Renamed pack_* fonction for our guidelines
David Demelier <markand@malikania.fr>
parents: 56
diff changeset
68 int pack_vfwrite(int, FILE *, const char *, va_list);
56
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
69
153
a6a7cd08be72 pack.c:
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
70 int pack_sread(int, uint8_t *, size_t, const char *, ...);
a6a7cd08be72 pack.c:
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
71 int pack_vsread(int, uint8_t *, size_t, const char *, va_list);
57
311eaa9d004c Renamed pack_* fonction for our guidelines
David Demelier <markand@malikania.fr>
parents: 56
diff changeset
72 int pack_read(int, const char *, const char *, ...);
311eaa9d004c Renamed pack_* fonction for our guidelines
David Demelier <markand@malikania.fr>
parents: 56
diff changeset
73 int pack_vread(int, const char *, const char *, va_list);
311eaa9d004c Renamed pack_* fonction for our guidelines
David Demelier <markand@malikania.fr>
parents: 56
diff changeset
74 int pack_fread(int, FILE *, const char *, ...);
311eaa9d004c Renamed pack_* fonction for our guidelines
David Demelier <markand@malikania.fr>
parents: 56
diff changeset
75 int pack_vfread(int, FILE *, const char *, va_list);
56
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
76
135
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 99
diff changeset
77 #ifdef __cplusplus
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 99
diff changeset
78 }
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 99
diff changeset
79 #endif
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 99
diff changeset
80
56
770737295987 Added pack.c pack.h
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 #endif /* _PACK_H_ */