JasPer 3.0.3
jas_stream.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 1999-2000 Image Power, Inc. and the University of
3 * British Columbia.
4 * Copyright (c) 2001-2003 Michael David Adams.
5 * All rights reserved.
6 */
7
8/* __START_OF_JASPER_LICENSE__
9 *
10 * JasPer License Version 2.0
11 *
12 * Copyright (c) 2001-2006 Michael David Adams
13 * Copyright (c) 1999-2000 Image Power, Inc.
14 * Copyright (c) 1999-2000 The University of British Columbia
15 *
16 * All rights reserved.
17 *
18 * Permission is hereby granted, free of charge, to any person (the
19 * "User") obtaining a copy of this software and associated documentation
20 * files (the "Software"), to deal in the Software without restriction,
21 * including without limitation the rights to use, copy, modify, merge,
22 * publish, distribute, and/or sell copies of the Software, and to permit
23 * persons to whom the Software is furnished to do so, subject to the
24 * following conditions:
25 *
26 * 1. The above copyright notices and this permission notice (which
27 * includes the disclaimer below) shall be included in all copies or
28 * substantial portions of the Software.
29 *
30 * 2. The name of a copyright holder shall not be used to endorse or
31 * promote products derived from the Software without specific prior
32 * written permission.
33 *
34 * THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
35 * LICENSE. NO USE OF THE SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER
36 * THIS DISCLAIMER. THE SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS
37 * "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
38 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
39 * PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN NO
40 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
41 * INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
42 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
43 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
44 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. NO ASSURANCES ARE
45 * PROVIDED BY THE COPYRIGHT HOLDERS THAT THE SOFTWARE DOES NOT INFRINGE
46 * THE PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS OF ANY OTHER ENTITY.
47 * EACH COPYRIGHT HOLDER DISCLAIMS ANY LIABILITY TO THE USER FOR CLAIMS
48 * BROUGHT BY ANY OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL
49 * PROPERTY RIGHTS OR OTHERWISE. AS A CONDITION TO EXERCISING THE RIGHTS
50 * GRANTED HEREUNDER, EACH USER HEREBY ASSUMES SOLE RESPONSIBILITY TO SECURE
51 * ANY OTHER INTELLECTUAL PROPERTY RIGHTS NEEDED, IF ANY. THE SOFTWARE
52 * IS NOT FAULT-TOLERANT AND IS NOT INTENDED FOR USE IN MISSION-CRITICAL
53 * SYSTEMS, SUCH AS THOSE USED IN THE OPERATION OF NUCLEAR FACILITIES,
54 * AIRCRAFT NAVIGATION OR COMMUNICATION SYSTEMS, AIR TRAFFIC CONTROL
55 * SYSTEMS, DIRECT LIFE SUPPORT MACHINES, OR WEAPONS SYSTEMS, IN WHICH
56 * THE FAILURE OF THE SOFTWARE OR SYSTEM COULD LEAD DIRECTLY TO DEATH,
57 * PERSONAL INJURY, OR SEVERE PHYSICAL OR ENVIRONMENTAL DAMAGE ("HIGH
58 * RISK ACTIVITIES"). THE COPYRIGHT HOLDERS SPECIFICALLY DISCLAIM ANY
59 * EXPRESS OR IMPLIED WARRANTY OF FITNESS FOR HIGH RISK ACTIVITIES.
60 *
61 * __END_OF_JASPER_LICENSE__
62 */
63
69#ifndef JAS_STREAM_H
70#define JAS_STREAM_H
71
72/******************************************************************************\
73* Includes.
74\******************************************************************************/
75
76/* The configuration header file should be included first. */
77#include <jasper/jas_config.h> /* IWYU pragma: export */
78
79#include <stdio.h>
80#if defined(JAS_HAVE_FCNTL_H)
81#include <fcntl.h>
82#endif
83#include <jasper/jas_types.h>
84
85#ifdef __cplusplus
86extern "C" {
87#endif
88
94/******************************************************************************\
95* Constants.
96\******************************************************************************/
97
98/* On most UNIX systems, we probably need to define O_BINARY ourselves. */
99#ifndef O_BINARY
100#define O_BINARY 0
101#endif
102
103/*
104 * Stream open flags.
105 */
106
107/* The stream was opened for reading. */
108#define JAS_STREAM_READ 0x0001
109/* The stream was opened for writing. */
110#define JAS_STREAM_WRITE 0x0002
111/* The stream was opened for appending. */
112#define JAS_STREAM_APPEND 0x0004
113/* The stream was opened in binary mode. */
114#define JAS_STREAM_BINARY 0x0008
115/* The stream should be created/truncated. */
116#define JAS_STREAM_CREATE 0x0010
117
118/*
119 * Stream buffering flags.
120 */
121
122/* The stream is unbuffered. */
123#define JAS_STREAM_UNBUF 0x0000
124/* The stream is line buffered. */
125#define JAS_STREAM_LINEBUF 0x0001
126/* The stream is fully buffered. */
127#define JAS_STREAM_FULLBUF 0x0002
128/* The buffering mode mask. */
129#define JAS_STREAM_BUFMODEMASK 0x000f
130
131/* The memory associated with the buffer needs to be deallocated when the
132 stream is destroyed. */
133#define JAS_STREAM_FREEBUF 0x0008
134/* The buffer is currently being used for reading. */
135#define JAS_STREAM_RDBUF 0x0010
136/* The buffer is currently being used for writing. */
137#define JAS_STREAM_WRBUF 0x0020
138
139/*
140 * Stream error flags.
141 */
142
143/* The end-of-file has been encountered (on reading). */
144#define JAS_STREAM_EOF 0x0001
145/* An I/O error has been encountered on the stream. */
146#define JAS_STREAM_ERR 0x0002
147/* The read/write limit has been exceeded. */
148#define JAS_STREAM_RWLIMIT 0x0004
149/* The error mask. */
150#define JAS_STREAM_ERRMASK \
151 (JAS_STREAM_EOF | JAS_STREAM_ERR | JAS_STREAM_RWLIMIT)
152
153/*
154 * Other miscellaneous constants.
155 */
156
157/* The default buffer size (for fully-buffered operation). */
158#define JAS_STREAM_BUFSIZE 8192
159/* The default permission mask for file creation. */
160#define JAS_STREAM_PERMS 0666
161
162/* The maximum number of characters that can always be put back on a stream. */
163#define JAS_STREAM_MAXPUTBACK 16
164
165/******************************************************************************\
166* Types.
167\******************************************************************************/
168
169/*
170 * Generic file object.
171 */
172
173typedef void jas_stream_obj_t;
174
175/*
176 * Generic file object operations.
177 */
178
179typedef struct {
180
181 /* Read characters from a file object. */
182 ssize_t (*read_)(jas_stream_obj_t *obj, char *buf, size_t cnt);
183
184 /* Write characters to a file object. */
185 ssize_t (*write_)(jas_stream_obj_t *obj, const char *buf, size_t cnt);
186
187 /* Set the position for a file object. */
188 long (*seek_)(jas_stream_obj_t *obj, long offset, int origin);
189
190 /* Close a file object. */
191 int (*close_)(jas_stream_obj_t *obj);
192
193} jas_stream_ops_t;
194
206typedef struct {
207
208 /* The mode in which the stream was opened. */
209 int openmode_;
210
211 /* The buffering mode. */
212 int bufmode_;
213
214 /* The stream status. */
215 int flags_;
216
217 /* The start of the buffer area to use for reading/writing. */
218 jas_uchar *bufbase_;
219
220 /* The start of the buffer area excluding the extra initial space for
221 character putback. */
222 jas_uchar *bufstart_;
223
224 /* The buffer size. */
225 int bufsize_;
226
227 /* The current position in the buffer. */
228 jas_uchar *ptr_;
229
230 /* The number of characters that must be read/written before
231 the buffer needs to be filled/flushed. */
232 int cnt_;
233
234 /* A trivial buffer to be used for unbuffered operation. */
235 jas_uchar tinybuf_[JAS_STREAM_MAXPUTBACK + 1];
236
237 /* The operations for the underlying stream file object. */
238 const jas_stream_ops_t *ops_;
239
240 /* The underlying stream file object. */
241 jas_stream_obj_t *obj_;
242
243 /* The number of characters read/written. */
244 long rwcnt_;
245
246 /* The maximum number of characters that may be read/written. */
247 long rwlimit_;
248
250
251/*
252 * Regular file object.
253 */
254
255/*
256 * File descriptor file object.
257 */
258typedef struct {
259 int fd;
260 int flags;
261 char pathname[L_tmpnam + 1];
262} jas_stream_fileobj_t;
263
264/* Delete underlying file object upon stream close. */
265#define JAS_STREAM_FILEOBJ_DELONCLOSE 0x01
266/* Do not close underlying file object upon stream close. */
267#define JAS_STREAM_FILEOBJ_NOCLOSE 0x02
268
269/*
270 * Memory file object.
271 */
272
273typedef struct {
274
275 /* The data associated with this file. */
276 jas_uchar *buf_;
277
278 /* The allocated size of the buffer for holding file data. */
279 size_t bufsize_;
280
281 /* The length of the file. */
282 size_t len_;
283
284 /* The seek position. */
285 size_t pos_;
286
287 /* Is the buffer growable? */
288 int growable_;
289
290 /* Was the buffer allocated internally? */
291 int myalloc_;
292
293} jas_stream_memobj_t;
294
295/******************************************************************************\
296* Macros/functions for opening and closing streams.
297\******************************************************************************/
298
313JAS_EXPORT
314jas_stream_t *jas_stream_fopen(const char *filename, const char *mode);
315
340JAS_EXPORT
341jas_stream_t *jas_stream_memopen(char *buffer, size_t buffer_size);
342
351JAS_DEPRECATED
352JAS_EXPORT
353jas_stream_t *jas_stream_memopen2(char *buffer, size_t buffer_size);
354
369JAS_EXPORT
370jas_stream_t *jas_stream_fdopen(int fd, const char *mode);
371
394JAS_EXPORT
395jas_stream_t *jas_stream_freopen(const char *path, const char *mode, FILE *fp);
396
411JAS_EXPORT
413
432JAS_EXPORT
433int jas_stream_close(jas_stream_t *stream);
434
435/******************************************************************************\
436* Macros/functions for getting/setting the stream state.
437\******************************************************************************/
438
449#define jas_stream_eof(stream) \
450 (((stream)->flags_ & JAS_STREAM_EOF) != 0)
451
463#define jas_stream_error(stream) \
464 (((stream)->flags_ & JAS_STREAM_ERR) != 0)
465
475#define jas_stream_clearerr(stream) \
476 ((stream)->flags_ &= ~(JAS_STREAM_ERR | JAS_STREAM_EOF))
477
488#define jas_stream_getrwlimit(stream) \
489 (((const jas_stream_t *)(stream))->rwlimit_)
490
506JAS_EXPORT long jas_stream_setrwlimit(jas_stream_t *stream, long rwlimit);
507
518#define jas_stream_getrwcount(stream) \
519 (((const jas_stream_t *)(stream))->rwcnt_)
520
534JAS_EXPORT
535long jas_stream_setrwcount(jas_stream_t *stream, long rw_count);
536
537/******************************************************************************\
538* Macros/functions for I/O.
539\******************************************************************************/
540
541/* Read a character from a stream. */
542#ifndef NDEBUG
554#define jas_stream_getc(stream) jas_stream_getc_func(stream)
555#else
556#define jas_stream_getc(stream) jas_stream_getc_macro(stream)
557#endif
558
559/* Write a character to a stream. */
560#ifndef NDEBUG
575#define jas_stream_putc(stream, c) jas_stream_putc_func(stream, c)
576#else
577#define jas_stream_putc(stream, c) jas_stream_putc_macro(stream, c)
578#endif
579
618JAS_EXPORT
619size_t jas_stream_read(jas_stream_t *stream, void *buffer, size_t count);
620
646JAS_EXPORT
647unsigned jas_stream_peek(jas_stream_t *stream, void *buffer, size_t count);
648
678JAS_EXPORT
679size_t jas_stream_write(jas_stream_t *stream, const void *buffer,
680 size_t count);
681
703JAS_EXPORT
704int jas_stream_printf(jas_stream_t *stream, const char *format, ...);
705
723JAS_EXPORT
724int jas_stream_puts(jas_stream_t *stream, const char *s);
725
749JAS_EXPORT
750char *jas_stream_gets(jas_stream_t *stream, char *buffer, int buffer_size);
751
770#define jas_stream_peekc(stream) \
771 (((stream)->cnt_ <= 0) ? jas_stream_fillbuf(stream, 0) : \
772 ((int)(*(stream)->ptr_)))
773
797JAS_EXPORT
798int jas_stream_ungetc(jas_stream_t *stream, int c);
799
800/******************************************************************************\
801* Macros/functions for getting/setting the stream position.
802\******************************************************************************/
803
819JAS_EXPORT
820JAS_ATTRIBUTE_PURE
822
842JAS_EXPORT
843long jas_stream_seek(jas_stream_t *stream, long offset, int origin);
844
860JAS_EXPORT
861long jas_stream_tell(jas_stream_t *stream);
862
880JAS_EXPORT
882
883/******************************************************************************\
884* Macros/functions for flushing.
885\******************************************************************************/
886
902JAS_EXPORT
903int jas_stream_flush(jas_stream_t *stream);
904
905/******************************************************************************\
906* Miscellaneous macros/functions.
907\******************************************************************************/
908
938JAS_EXPORT
939int jas_stream_copy(jas_stream_t *destination, jas_stream_t *source,
940 ssize_t count);
941
964JAS_EXPORT
965int jas_stream_display(jas_stream_t *stream, FILE *fp, int count);
966
986JAS_EXPORT
987ssize_t jas_stream_gobble(jas_stream_t *stream, size_t count);
988
1010JAS_EXPORT
1011ssize_t jas_stream_pad(jas_stream_t *stream, size_t count, int value);
1012
1032JAS_EXPORT
1033long jas_stream_length(jas_stream_t *stream);
1034
1035/******************************************************************************\
1036* Internal functions.
1037\******************************************************************************/
1038
1039/* The following functions are for internal use only! If you call them
1040directly, you will die a horrible, miserable, and painful death! */
1041
1042/* These prototypes need to be here for the sake of the stream_getc and
1043stream_putc macros. */
1044/* Library users must not invoke these functions directly. */
1045JAS_EXPORT int jas_stream_fillbuf(jas_stream_t *stream, int getflag);
1046JAS_EXPORT int jas_stream_flushbuf(jas_stream_t *stream, int c);
1047JAS_EXPORT int jas_stream_getc_func(jas_stream_t *stream);
1048JAS_EXPORT int jas_stream_putc_func(jas_stream_t *stream, int c);
1049
1050/* Read a character from a stream. */
1051static inline int jas_stream_getc2(jas_stream_t *stream)
1052{
1053 if (--stream->cnt_ < 0)
1054 return jas_stream_fillbuf(stream, 1);
1055
1056 ++stream->rwcnt_;
1057 return (int)(*stream->ptr_++);
1058}
1059
1060static inline int jas_stream_getc_macro(jas_stream_t *stream)
1061{
1062 if (stream->flags_ & (JAS_STREAM_ERR | JAS_STREAM_EOF | JAS_STREAM_RWLIMIT))
1063 return EOF;
1064
1065 if (stream->rwlimit_ >= 0 && stream->rwcnt_ >= stream->rwlimit_) {
1066 stream->flags_ |= JAS_STREAM_RWLIMIT;
1067 return EOF;
1068 }
1069
1070 return jas_stream_getc2(stream);
1071}
1072
1073/* Write a character to a stream. */
1074static inline int jas_stream_putc2(jas_stream_t *stream, jas_uchar c)
1075{
1076 stream->bufmode_ |= JAS_STREAM_WRBUF;
1077
1078 if (--stream->cnt_ < 0)
1079 return jas_stream_flushbuf(stream, c);
1080 else {
1081 ++stream->rwcnt_;
1082 return (int)(*stream->ptr_++ = c);
1083 }
1084}
1085
1086static inline int jas_stream_putc_macro(jas_stream_t *stream, jas_uchar c)
1087{
1088 if (stream->flags_ & (JAS_STREAM_ERR | JAS_STREAM_EOF | JAS_STREAM_RWLIMIT))
1089 return EOF;
1090
1091 if (stream->rwlimit_ >= 0 && stream->rwcnt_ >= stream->rwlimit_) {
1092 stream->flags_ |= JAS_STREAM_RWLIMIT;
1093 return EOF;
1094 }
1095
1096 return jas_stream_putc2(stream, c);
1097}
1098
1103#ifdef __cplusplus
1104}
1105#endif
1106
1107#endif
JAS_EXPORT jas_stream_t * jas_stream_tmpfile(void)
Open a temporary file as a stream.
Definition: jas_stream.c:471
JAS_EXPORT int jas_stream_display(jas_stream_t *stream, FILE *fp, int count)
Print a hex dump of data read from a stream.
Definition: jas_stream.c:1145
JAS_EXPORT long jas_stream_setrwlimit(jas_stream_t *stream, long rwlimit)
Set the read/write limit for a stream.
Definition: jas_stream.c:1135
JAS_DEPRECATED JAS_EXPORT jas_stream_t * jas_stream_memopen2(char *buffer, size_t buffer_size)
Do not use.
Definition: jas_stream.c:277
JAS_EXPORT unsigned jas_stream_peek(jas_stream_t *stream, void *buffer, size_t count)
Attempt to retrieve one or more pending characters of input from a stream into a buffer without actua...
Definition: jas_stream.c:703
JAS_EXPORT jas_stream_t * jas_stream_fopen(const char *filename, const char *mode)
Open a file as a stream.
Definition: jas_stream.c:283
JAS_EXPORT long jas_stream_tell(jas_stream_t *stream)
Get the current position within the stream.
Definition: jas_stream.c:898
JAS_EXPORT ssize_t jas_stream_gobble(jas_stream_t *stream, size_t count)
Consume (i.e., discard) characters from stream.
Definition: jas_stream.c:816
JAS_EXPORT ssize_t jas_stream_pad(jas_stream_t *stream, size_t count, int value)
Write a fill character multiple times to a stream.
Definition: jas_stream.c:828
JAS_EXPORT int jas_stream_printf(jas_stream_t *stream, const char *format,...)
Write formatted output to a stream.
Definition: jas_stream.c:767
JAS_EXPORT int jas_stream_puts(jas_stream_t *stream, const char *s)
Write a string to a stream.
Definition: jas_stream.c:780
JAS_EXPORT char * jas_stream_gets(jas_stream_t *stream, char *buffer, int buffer_size)
Read a line of input from a stream.
Definition: jas_stream.c:793
JAS_EXPORT int jas_stream_ungetc(jas_stream_t *stream, int c)
Put a character back on a stream.
Definition: jas_stream.c:633
JAS_EXPORT int jas_stream_flush(jas_stream_t *stream)
Flush any pending output to a stream.
Definition: jas_stream.c:973
JAS_EXPORT long jas_stream_seek(jas_stream_t *stream, long offset, int origin)
Set the current position within the stream.
Definition: jas_stream.c:864
JAS_EXPORT jas_stream_t * jas_stream_memopen(char *buffer, size_t buffer_size)
Open a memory buffer as a stream.
Definition: jas_stream.c:203
JAS_EXPORT int jas_stream_close(jas_stream_t *stream)
Close a stream.
Definition: jas_stream.c:591
JAS_EXPORT size_t jas_stream_write(jas_stream_t *stream, const void *buffer, size_t count)
Write characters from a buffer to a stream.
Definition: jas_stream.c:719
JAS_EXPORT JAS_ATTRIBUTE_PURE int jas_stream_isseekable(jas_stream_t *stream)
Determine if stream supports seeking.
Definition: jas_stream.c:844
JAS_EXPORT jas_stream_t * jas_stream_fdopen(int fd, const char *mode)
Open a file descriptor as a stream.
Definition: jas_stream.c:521
JAS_EXPORT int jas_stream_copy(jas_stream_t *destination, jas_stream_t *source, ssize_t count)
Copy data from one stream to another.
Definition: jas_stream.c:1100
JAS_EXPORT long jas_stream_length(jas_stream_t *stream)
Get the size of the file associated with the specified stream.
Definition: jas_stream.c:1196
JAS_EXPORT int jas_stream_rewind(jas_stream_t *stream)
Seek to the beginning of a stream.
Definition: jas_stream.c:858
JAS_EXPORT size_t jas_stream_read(jas_stream_t *stream, void *buffer, size_t count)
Read characters from a stream into a buffer.
Definition: jas_stream.c:650
JAS_EXPORT jas_stream_t * jas_stream_freopen(const char *path, const char *mode, FILE *fp)
Open a stdio (i.e., C standard library) stream as a stream.
Definition: jas_stream.c:350
JAS_EXPORT long jas_stream_setrwcount(jas_stream_t *stream, long rw_count)
Set the read/write count for a stream.
Definition: jas_stream.c:1125
Primitive Types.
I/O stream object.
Definition: jas_stream.h:206