JasPer: jas_stream.h Source File

JasPer 4.1.1 |

Loading...
Searching...
No Matches
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
206 typedef 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
249} jas_stream_t;
250
251/*
252 * Regular file object.
253 */
254
255/*
256 * File descriptor file object.
257 */
258typedef struct {
259 int fd;
260 int flags;
261#if defined(JAS_WASI_LIBC)
262#define L_tmpnam 4096
263#endif
264 char pathname[L_tmpnam + 1];
265} jas_stream_fileobj_t;
266
267/* Delete underlying file object upon stream close. */
268#define JAS_STREAM_FILEOBJ_DELONCLOSE 0x01
269/* Do not close underlying file object upon stream close. */
270#define JAS_STREAM_FILEOBJ_NOCLOSE 0x02
271
272/*
273 * Memory file object.
274 */
275
276typedef struct {
277
278 /* The data associated with this file. */
279 jas_uchar *buf_;
280
281 /* The allocated size of the buffer for holding file data. */
282 size_t bufsize_;
283
284 /* The length of the file. */
285 size_t len_;
286
287 /* The seek position. */
288 size_t pos_;
289
290 /* Is the buffer growable? */
291 int growable_;
292
293 /* Was the buffer allocated internally? */
294 int myalloc_;
295
296} jas_stream_memobj_t;
297
298/******************************************************************************\
299* Macros/functions for opening and closing streams.
300\******************************************************************************/
301
316JAS_EXPORT
317 jas_stream_t *jas_stream_fopen(const char *filename, const char *mode);
318
343JAS_EXPORT
344 jas_stream_t *jas_stream_memopen(char *buffer, size_t buffer_size);
345
354JAS_DEPRECATED
355JAS_EXPORT
356 jas_stream_t *jas_stream_memopen2(char *buffer, size_t buffer_size);
357
372JAS_EXPORT
373 jas_stream_t *jas_stream_fdopen(int fd, const char *mode);
374
397JAS_EXPORT
398 jas_stream_t *jas_stream_freopen(const char *path, const char *mode, FILE *fp);
399
414JAS_EXPORT
415 jas_stream_t *jas_stream_tmpfile(void);
416
435JAS_EXPORT
436int jas_stream_close(jas_stream_t *stream);
437
438/******************************************************************************\
439* Macros/functions for getting/setting the stream state.
440\******************************************************************************/
441
452#define jas_stream_eof(stream) \
453 (((stream)->flags_ & JAS_STREAM_EOF) != 0)
454
466#define jas_stream_error(stream) \
467 (((stream)->flags_ & JAS_STREAM_ERR) != 0)
468
478#define jas_stream_clearerr(stream) \
479 ((stream)->flags_ &= ~(JAS_STREAM_ERR | JAS_STREAM_EOF))
480
491#define jas_stream_getrwlimit(stream) \
492 (((const jas_stream_t *)(stream))->rwlimit_)
493
509JAS_EXPORT long jas_stream_setrwlimit(jas_stream_t *stream, long rwlimit);
510
521#define jas_stream_getrwcount(stream) \
522 (((const jas_stream_t *)(stream))->rwcnt_)
523
537JAS_EXPORT
538long jas_stream_setrwcount(jas_stream_t *stream, long rw_count);
539
540/******************************************************************************\
541* Macros/functions for I/O.
542\******************************************************************************/
543
544/* Read a character from a stream. */
545#ifndef NDEBUG
557#define jas_stream_getc(stream) jas_stream_getc_func(stream)
558#else
559#define jas_stream_getc(stream) jas_stream_getc_macro(stream)
560#endif
561
562/* Write a character to a stream. */
563#ifndef NDEBUG
578#define jas_stream_putc(stream, c) jas_stream_putc_func(stream, c)
579#else
580#define jas_stream_putc(stream, c) jas_stream_putc_macro(stream, c)
581#endif
582
621JAS_EXPORT
622size_t jas_stream_read(jas_stream_t *stream, void *buffer, size_t count);
623
649JAS_EXPORT
650unsigned jas_stream_peek(jas_stream_t *stream, void *buffer, size_t count);
651
681JAS_EXPORT
682size_t jas_stream_write(jas_stream_t *stream, const void *buffer,
683 size_t count);
684
706JAS_EXPORT
707int jas_stream_printf(jas_stream_t *stream, const char *format, ...);
708
726JAS_EXPORT
727int jas_stream_puts(jas_stream_t *stream, const char *s);
728
752JAS_EXPORT
753char *jas_stream_gets(jas_stream_t *stream, char *buffer, int buffer_size);
754
773#define jas_stream_peekc(stream) \
774 (((stream)->cnt_ <= 0) ? jas_stream_fillbuf(stream, 0) : \
775 ((int)(*(stream)->ptr_)))
776
800JAS_EXPORT
801int jas_stream_ungetc(jas_stream_t *stream, int c);
802
803/******************************************************************************\
804* Macros/functions for getting/setting the stream position.
805\******************************************************************************/
806
822JAS_EXPORT
823JAS_ATTRIBUTE_PURE
824int jas_stream_isseekable(jas_stream_t *stream);
825
845JAS_EXPORT
846long jas_stream_seek(jas_stream_t *stream, long offset, int origin);
847
863JAS_EXPORT
864long jas_stream_tell(jas_stream_t *stream);
865
883JAS_EXPORT
884int jas_stream_rewind(jas_stream_t *stream);
885
886/******************************************************************************\
887* Macros/functions for flushing.
888\******************************************************************************/
889
905JAS_EXPORT
906int jas_stream_flush(jas_stream_t *stream);
907
908/******************************************************************************\
909* Miscellaneous macros/functions.
910\******************************************************************************/
911
941JAS_EXPORT
942int jas_stream_copy(jas_stream_t *destination, jas_stream_t *source,
943 ssize_t count);
944
967JAS_EXPORT
968int jas_stream_display(jas_stream_t *stream, FILE *fp, int count);
969
989JAS_EXPORT
990ssize_t jas_stream_gobble(jas_stream_t *stream, size_t count);
991
1013JAS_EXPORT
1014ssize_t jas_stream_pad(jas_stream_t *stream, size_t count, int value);
1015
1035JAS_EXPORT
1036long jas_stream_length(jas_stream_t *stream);
1037
1038/******************************************************************************\
1039* Internal functions.
1040\******************************************************************************/
1041
1042/* The following functions are for internal use only! If you call them
1043directly, you will die a horrible, miserable, and painful death! */
1044
1045/* These prototypes need to be here for the sake of the stream_getc and
1046stream_putc macros. */
1047/* Library users must not invoke these functions directly. */
1048JAS_EXPORT int jas_stream_fillbuf(jas_stream_t *stream, int getflag);
1049JAS_EXPORT int jas_stream_flushbuf(jas_stream_t *stream, int c);
1050JAS_EXPORT int jas_stream_getc_func(jas_stream_t *stream);
1051JAS_EXPORT int jas_stream_putc_func(jas_stream_t *stream, int c);
1052
1053/* Read a character from a stream. */
1054static inline int jas_stream_getc2(jas_stream_t *stream)
1055{
1056 if (--stream->cnt_ < 0)
1057 return jas_stream_fillbuf(stream, 1);
1058
1059 ++stream->rwcnt_;
1060 return (int)(*stream->ptr_++);
1061}
1062
1063static inline int jas_stream_getc_macro(jas_stream_t *stream)
1064{
1065 if (stream->flags_ & (JAS_STREAM_ERR | JAS_STREAM_EOF | JAS_STREAM_RWLIMIT))
1066 return EOF;
1067
1068 if (stream->rwlimit_ >= 0 && stream->rwcnt_ >= stream->rwlimit_) {
1069 stream->flags_ |= JAS_STREAM_RWLIMIT;
1070 return EOF;
1071 }
1072
1073 return jas_stream_getc2(stream);
1074}
1075
1076/* Write a character to a stream. */
1077static inline int jas_stream_putc2(jas_stream_t *stream, jas_uchar c)
1078{
1079 stream->bufmode_ |= JAS_STREAM_WRBUF;
1080
1081 if (--stream->cnt_ < 0)
1082 return jas_stream_flushbuf(stream, c);
1083 else {
1084 ++stream->rwcnt_;
1085 return (int)(*stream->ptr_++ = c);
1086 }
1087}
1088
1089static inline int jas_stream_putc_macro(jas_stream_t *stream, jas_uchar c)
1090{
1091 if (stream->flags_ & (JAS_STREAM_ERR | JAS_STREAM_EOF | JAS_STREAM_RWLIMIT))
1092 return EOF;
1093
1094 if (stream->rwlimit_ >= 0 && stream->rwcnt_ >= stream->rwlimit_) {
1095 stream->flags_ |= JAS_STREAM_RWLIMIT;
1096 return EOF;
1097 }
1098
1099 return jas_stream_putc2(stream, c);
1100}
1101
1106#ifdef __cplusplus
1107}
1108#endif
1109
1110#endif
jas_stream_tmpfile
JAS_EXPORT jas_stream_t * jas_stream_tmpfile(void)
Open a temporary file as a stream.
Definition jas_stream.c:473
jas_stream_display
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:1148
jas_stream_setrwlimit
JAS_EXPORT long jas_stream_setrwlimit(jas_stream_t *stream, long rwlimit)
Set the read/write limit for a stream.
Definition jas_stream.c:1138
jas_stream_memopen2
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_stream_peek
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:706
jas_stream_fopen
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_stream_tell
JAS_EXPORT long jas_stream_tell(jas_stream_t *stream)
Get the current position within the stream.
Definition jas_stream.c:901
jas_stream_gobble
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:819
jas_stream_pad
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:831
jas_stream_printf
JAS_EXPORT int jas_stream_printf(jas_stream_t *stream, const char *format,...)
Write formatted output to a stream.
Definition jas_stream.c:770
jas_stream_puts
JAS_EXPORT int jas_stream_puts(jas_stream_t *stream, const char *s)
Write a string to a stream.
Definition jas_stream.c:783
jas_stream_gets
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:796
jas_stream_ungetc
JAS_EXPORT int jas_stream_ungetc(jas_stream_t *stream, int c)
Put a character back on a stream.
Definition jas_stream.c:635
jas_stream_flush
JAS_EXPORT int jas_stream_flush(jas_stream_t *stream)
Flush any pending output to a stream.
Definition jas_stream.c:976
jas_stream_seek
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:867
jas_stream_memopen
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_stream_close
JAS_EXPORT int jas_stream_close(jas_stream_t *stream)
Close a stream.
Definition jas_stream.c:593
jas_stream_write
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:722
jas_stream_isseekable
JAS_EXPORT JAS_ATTRIBUTE_PURE int jas_stream_isseekable(jas_stream_t *stream)
Determine if stream supports seeking.
Definition jas_stream.c:847
jas_stream_fdopen
JAS_EXPORT jas_stream_t * jas_stream_fdopen(int fd, const char *mode)
Open a file descriptor as a stream.
Definition jas_stream.c:523
jas_stream_copy
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:1103
jas_stream_length
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:1198
jas_stream_rewind
JAS_EXPORT int jas_stream_rewind(jas_stream_t *stream)
Seek to the beginning of a stream.
Definition jas_stream.c:861
jas_stream_read
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:652
jas_stream_freopen
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_stream_setrwcount
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:1128
jas_types.h
Primitive Types.
jas_stream_t
I/O stream object.
Definition jas_stream.h:206