You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
318 lines
9.3 KiB
318 lines
9.3 KiB
#ifndef MUPDF_FITZ_OUTPUT_H
|
|
#define MUPDF_FITZ_OUTPUT_H
|
|
|
|
#include "mupdf/fitz/system.h"
|
|
#include "mupdf/fitz/context.h"
|
|
#include "mupdf/fitz/buffer.h"
|
|
#include "mupdf/fitz/string-util.h"
|
|
#include "mupdf/fitz/stream.h"
|
|
|
|
/*
|
|
Generic output streams - generalise between outputting to a file,
|
|
a buffer, etc.
|
|
*/
|
|
typedef struct fz_output_s fz_output;
|
|
|
|
/*
|
|
fz_output_write_fn: A function type for use when implementing
|
|
fz_outputs. The supplied function of this type is called
|
|
whenever data is written to the output.
|
|
|
|
state: The state for the output stream.
|
|
|
|
data: a pointer to a buffer of data to write.
|
|
|
|
n: The number of bytes of data to write.
|
|
*/
|
|
typedef void (fz_output_write_fn)(fz_context *ctx, void *state, const void *data, size_t n);
|
|
|
|
/*
|
|
fz_output_seek_fn: A function type for use when implementing
|
|
fz_outputs. The supplied function of this type is called when
|
|
fz_seek_output is requested.
|
|
|
|
state: The output stream state to seek within.
|
|
|
|
offset, whence: as defined for fs_seek_output.
|
|
*/
|
|
typedef void (fz_output_seek_fn)(fz_context *ctx, void *state, int64_t offset, int whence);
|
|
|
|
/*
|
|
fz_output_tell_fn: A function type for use when implementing
|
|
fz_outputs. The supplied function of this type is called when
|
|
fz_tell_output is requested.
|
|
|
|
state: The output stream state to report on.
|
|
|
|
Returns the offset within the output stream.
|
|
*/
|
|
typedef int64_t (fz_output_tell_fn)(fz_context *ctx, void *state);
|
|
|
|
/*
|
|
fz_output_close_fn: A function type for use when implementing
|
|
fz_outputs. The supplied function of this type is called
|
|
when the output stream is closed, to flush any pending writes.
|
|
*/
|
|
typedef void (fz_output_close_fn)(fz_context *ctx, void *state);
|
|
|
|
/*
|
|
fz_output_drop_fn: A function type for use when implementing
|
|
fz_outputs. The supplied function of this type is called
|
|
when the output stream is dropped, to release the stream specific
|
|
state information.
|
|
*/
|
|
typedef void (fz_output_drop_fn)(fz_context *ctx, void *state);
|
|
|
|
/*
|
|
fz_stream_from_output_fn: A function type for use when implementing
|
|
fz_outputs. The supplied function of this type is called
|
|
when the fz_stream_from_output is called.
|
|
*/
|
|
typedef fz_stream *(fz_stream_from_output_fn)(fz_context *ctx, void *state);
|
|
|
|
|
|
struct fz_output_s
|
|
{
|
|
void *state;
|
|
fz_output_write_fn *write;
|
|
fz_output_seek_fn *seek;
|
|
fz_output_tell_fn *tell;
|
|
fz_output_close_fn *close;
|
|
fz_output_drop_fn *drop;
|
|
fz_stream_from_output_fn *as_stream;
|
|
char *bp, *wp, *ep;
|
|
};
|
|
|
|
/*
|
|
fz_new_output: Create a new output object with the given
|
|
internal state and function pointers.
|
|
|
|
state: Internal state (opaque to everything but implementation).
|
|
|
|
write: Function to output a given buffer.
|
|
|
|
close: Cleanup function to destroy state when output closed.
|
|
May permissibly be null.
|
|
*/
|
|
fz_output *fz_new_output(fz_context *ctx, int bufsiz, void *state, fz_output_write_fn *write, fz_output_close_fn *close, fz_output_drop_fn *drop);
|
|
|
|
/*
|
|
fz_new_output_with_path: Open an output stream that writes to a
|
|
given path.
|
|
|
|
filename: The filename to write to (specified in UTF-8).
|
|
|
|
append: non-zero if we should append to the file, rather than
|
|
overwriting it.
|
|
*/
|
|
fz_output *fz_new_output_with_path(fz_context *, const char *filename, int append);
|
|
|
|
/*
|
|
fz_new_output_with_buffer: Open an output stream that appends
|
|
to a buffer.
|
|
|
|
buf: The buffer to append to.
|
|
*/
|
|
fz_output *fz_new_output_with_buffer(fz_context *ctx, fz_buffer *buf);
|
|
|
|
/*
|
|
fz_stdout: The standard out output stream. By default
|
|
this stream writes to stdout. This may be overridden
|
|
using fz_set_stdout.
|
|
*/
|
|
fz_output *fz_stdout(fz_context *ctx);
|
|
|
|
/*
|
|
fz_stderr: The standard error output stream. By default
|
|
this stream writes to stderr. This may be overridden
|
|
using fz_set_stderr.
|
|
*/
|
|
fz_output *fz_stderr(fz_context *ctx);
|
|
|
|
/*
|
|
fz_set_stdout: Replace default standard output stream
|
|
with a given stream.
|
|
|
|
out: The new stream to use.
|
|
*/
|
|
void fz_set_stdout(fz_context *ctx, fz_output *out);
|
|
|
|
/*
|
|
fz_set_stderr: Replace default standard error stream
|
|
with a given stream.
|
|
|
|
err: The new stream to use.
|
|
*/
|
|
void fz_set_stderr(fz_context *ctx, fz_output *err);
|
|
|
|
/*
|
|
fz_write_printf: Format and write data to an output stream.
|
|
See fz_vsnprintf for formatting details.
|
|
*/
|
|
void fz_write_printf(fz_context *ctx, fz_output *out, const char *fmt, ...);
|
|
|
|
/*
|
|
fz_write_vprintf: va_list version of fz_write_printf.
|
|
*/
|
|
void fz_write_vprintf(fz_context *ctx, fz_output *out, const char *fmt, va_list ap);
|
|
|
|
/*
|
|
fz_seek_output: Seek to the specified file position.
|
|
See fseek for arguments.
|
|
|
|
Throw an error on unseekable outputs.
|
|
*/
|
|
void fz_seek_output(fz_context *ctx, fz_output *out, int64_t off, int whence);
|
|
|
|
/*
|
|
fz_tell_output: Return the current file position.
|
|
|
|
Throw an error on untellable outputs.
|
|
*/
|
|
int64_t fz_tell_output(fz_context *ctx, fz_output *out);
|
|
|
|
/*
|
|
fz_flush_output: Flush unwritten data.
|
|
*/
|
|
void fz_flush_output(fz_context *ctx, fz_output *out);
|
|
|
|
/*
|
|
fz_close_output: Flush pending output and close an output stream.
|
|
*/
|
|
void fz_close_output(fz_context *, fz_output *);
|
|
|
|
/*
|
|
fz_drop_output: Free an output stream. Don't forget to close it first!
|
|
*/
|
|
void fz_drop_output(fz_context *, fz_output *);
|
|
|
|
/*
|
|
fz_stream_from_output: obtain the fz_output in the form of a fz_stream
|
|
|
|
This allows data to be read back from some forms of fz_output object.
|
|
When finished reading, the fz_stream should be released by calling
|
|
fz_drop_stream. Until the fz_stream is dropped, no further operations
|
|
should be performed on the fz_output object.
|
|
*/
|
|
fz_stream *fz_stream_from_output(fz_context *, fz_output *);
|
|
|
|
/*
|
|
fz_write_data: Write data to output.
|
|
|
|
data: Pointer to data to write.
|
|
size: Size of data to write in bytes.
|
|
*/
|
|
void fz_write_data(fz_context *ctx, fz_output *out, const void *data, size_t size);
|
|
|
|
/*
|
|
fz_write_string: Write a string. Does not write zero terminator.
|
|
*/
|
|
void fz_write_string(fz_context *ctx, fz_output *out, const char *s);
|
|
|
|
/*
|
|
fz_write_int32_be: Write a big-endian 32-bit binary integer.
|
|
*/
|
|
void fz_write_int32_be(fz_context *ctx, fz_output *out, int x);
|
|
|
|
/*
|
|
fz_write_int32_le: Write a little-endian 32-bit binary integer.
|
|
*/
|
|
void fz_write_int32_le(fz_context *ctx, fz_output *out, int x);
|
|
|
|
/*
|
|
fz_write_int16_be: Write a big-endian 16-bit binary integer.
|
|
*/
|
|
void fz_write_int16_be(fz_context *ctx, fz_output *out, int x);
|
|
|
|
/*
|
|
fz_write_int16_le: Write a little-endian 16-bit binary integer.
|
|
*/
|
|
void fz_write_int16_le(fz_context *ctx, fz_output *out, int x);
|
|
|
|
/*
|
|
fz_write_byte: Write a single byte.
|
|
*/
|
|
void fz_write_byte(fz_context *ctx, fz_output *out, unsigned char x);
|
|
|
|
/*
|
|
fz_write_rune: Write a UTF-8 encoded unicode character.
|
|
*/
|
|
void fz_write_rune(fz_context *ctx, fz_output *out, int rune);
|
|
|
|
/*
|
|
fz_write_base64: Write base64 encoded data.
|
|
*/
|
|
void fz_write_base64(fz_context *ctx, fz_output *out, const unsigned char *data, int size, int newline);
|
|
void fz_write_base64_buffer(fz_context *ctx, fz_output *out, fz_buffer *data, int newline);
|
|
|
|
/*
|
|
fz_format_string: Our customised 'printf'-like string formatter.
|
|
Takes %c, %d, %s, %u, %x, as usual.
|
|
Modifiers are not supported except for zero-padding ints (e.g. %02d, %03u, %04x, etc).
|
|
%g output in "as short as possible hopefully lossless non-exponent" form,
|
|
see fz_ftoa for specifics.
|
|
%f and %e output as usual.
|
|
%C outputs a utf8 encoded int.
|
|
%M outputs a fz_matrix*. %R outputs a fz_rect*. %P outputs a fz_point*.
|
|
%q and %( output escaped strings in C/PDF syntax.
|
|
%l{d,u,x} indicates that the values are int64_t.
|
|
%z{d,u,x} indicates that the value is a size_t.
|
|
|
|
user: An opaque pointer that is passed to the emit function.
|
|
emit: A function pointer called to emit output bytes as the string is being formatted.
|
|
*/
|
|
void
|
|
fz_format_string(fz_context *ctx, void *user, void (*emit)(fz_context *ctx, void *user, int c), const char *fmt, va_list args);
|
|
|
|
/*
|
|
fz_vsnprintf: A vsnprintf work-alike, using our custom formatter.
|
|
*/
|
|
size_t fz_vsnprintf(char *buffer, size_t space, const char *fmt, va_list args);
|
|
|
|
/*
|
|
fz_snprintf: The non va_list equivalent of fz_vsnprintf.
|
|
*/
|
|
size_t fz_snprintf(char *buffer, size_t space, const char *fmt, ...);
|
|
|
|
/*
|
|
fz_asprintf: Print to allocated string.
|
|
*/
|
|
char *fz_asprintf(fz_context *ctx, const char *fmt, ...);
|
|
|
|
/*
|
|
fz_tempfilename: Get a temporary filename based upon 'base'.
|
|
|
|
'hint' is the path of a file (normally the existing document file)
|
|
supplied to give the function an idea of what directory to use. This
|
|
may or may not be used depending on the implementation's whim.
|
|
|
|
The returned path must be freed.
|
|
*/
|
|
char *fz_tempfilename(fz_context *ctx, const char *base, const char *hint);
|
|
|
|
/*
|
|
fz_save_buffer: Save contents of a buffer to file.
|
|
*/
|
|
void fz_save_buffer(fz_context *ctx, fz_buffer *buf, const char *filename);
|
|
|
|
/*
|
|
Compression and other filtering outputs.
|
|
|
|
These outputs write encoded data to another output. Create a filter
|
|
output with the destination, write to the filter, then drop it when
|
|
you're done. These can also be chained together, for example to write
|
|
ASCII Hex encoded, Deflate compressed, and RC4 encrypted data to a
|
|
buffer output.
|
|
|
|
Output streams don't use reference counting, so make sure to drop all
|
|
of the filters in the reverse order of creation so that data is flushed
|
|
properly.
|
|
*/
|
|
fz_output *fz_new_asciihex_output(fz_context *ctx, fz_output *chain);
|
|
fz_output *fz_new_ascii85_output(fz_context *ctx, fz_output *chain);
|
|
fz_output *fz_new_rle_output(fz_context *ctx, fz_output *chain);
|
|
fz_output *fz_new_arc4_output(fz_context *ctx, fz_output *chain, unsigned char *key, size_t keylen);
|
|
fz_output *fz_new_deflate_output(fz_context *ctx, fz_output *chain, int effort, int raw);
|
|
|
|
#endif
|