buffer.h

Go to the documentation of this file.

// Copyright (C) 2004-2023 Artifex Software, Inc.
//
// This file is part of MuPDF.
//
// MuPDF is free software: you can redistribute it and/or modify it under the
// terms of the GNU Affero General Public License as published by the Free
// Software Foundation, either version 3 of the License, or (at your option)
// any later version.
//
// MuPDF is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
// details.
//
// You should have received a copy of the GNU Affero General Public License
// along with MuPDF. If not, see <https://www.gnu.org/licenses/agpl-3.0.en.html>
//
// Alternative licensing terms are available from the licensor.
// For commercial licensing, see <https://www.artifex.com/> or contact
// Artifex Software, Inc., 39 Mesa Street, Suite 108A, San Francisco,
// CA 94129, USA, for further information.
 
#ifndef MUPDF_FITZ_BUFFER_H
#define MUPDF_FITZ_BUFFER_H
 
#include "mupdf/fitz/system.h"
#include "mupdf/fitz/context.h"

typedef struct
{
    int refs;
    unsigned char *data;
    size_t cap, len;
    int unused_bits;
    int shared;
} fz_buffer;

fz_buffer *fz_keep_buffer(fz_context *ctx, fz_buffer *buf);

void fz_drop_buffer(fz_context *ctx, fz_buffer *buf);

size_t fz_buffer_storage(fz_context *ctx, fz_buffer *buf, unsigned char **datap);

const char *fz_string_from_buffer(fz_context *ctx, fz_buffer *buf);
 
fz_buffer *fz_new_buffer(fz_context *ctx, size_t capacity);

fz_buffer *fz_new_buffer_from_data(fz_context *ctx, unsigned char *data, size_t size);

fz_buffer *fz_new_buffer_from_shared_data(fz_context *ctx, const unsigned char *data, size_t size);

fz_buffer *fz_new_buffer_from_copied_data(fz_context *ctx, const unsigned char *data, size_t size);

fz_buffer *fz_new_buffer_from_printf(fz_context *ctx, const char *fmt, ...);

fz_buffer *fz_clone_buffer(fz_context *ctx, fz_buffer *buf);

fz_buffer *fz_new_buffer_from_base64(fz_context *ctx, const char *data, size_t size);

void fz_resize_buffer(fz_context *ctx, fz_buffer *buf, size_t capacity);

void fz_grow_buffer(fz_context *ctx, fz_buffer *buf);

void fz_trim_buffer(fz_context *ctx, fz_buffer *buf);

void fz_clear_buffer(fz_context *ctx, fz_buffer *buf);

fz_buffer *fz_slice_buffer(fz_context *ctx, fz_buffer *buf, int64_t start, int64_t end);

void fz_append_buffer(fz_context *ctx, fz_buffer *destination, fz_buffer *source);

void fz_append_base64(fz_context *ctx, fz_buffer *out, const unsigned char *data, size_t size, int newline);

void fz_append_base64_buffer(fz_context *ctx, fz_buffer *out, fz_buffer *data, int newline);

void fz_append_data(fz_context *ctx, fz_buffer *buf, const void *data, size_t len);
void fz_append_string(fz_context *ctx, fz_buffer *buf, const char *data);
void fz_append_byte(fz_context *ctx, fz_buffer *buf, int c);
void fz_append_rune(fz_context *ctx, fz_buffer *buf, int c);
 
void fz_append_uint32_le(fz_context *ctx, fz_buffer *buf, uint32_t x);
void fz_append_uint16_le(fz_context *ctx, fz_buffer *buf, uint16_t x);
void fz_append_uint32_be(fz_context *ctx, fz_buffer *buf, uint32_t x);
void fz_append_uint16_be(fz_context *ctx, fz_buffer *buf, uint16_t x);
 
void fz_append_int32_le(fz_context *ctx, fz_buffer *buf, int32_t x);
void fz_append_int16_le(fz_context *ctx, fz_buffer *buf, int16_t x);
void fz_append_int32_be(fz_context *ctx, fz_buffer *buf, int32_t x);
void fz_append_int16_be(fz_context *ctx, fz_buffer *buf, int16_t x);
 
void fz_append_bits(fz_context *ctx, fz_buffer *buf, int value, int count);
void fz_append_bits_pad(fz_context *ctx, fz_buffer *buf);

void fz_append_pdf_string(fz_context *ctx, fz_buffer *buffer, const char *text);

void fz_append_printf(fz_context *ctx, fz_buffer *buffer, const char *fmt, ...);

void fz_append_vprintf(fz_context *ctx, fz_buffer *buffer, const char *fmt, va_list args);

void fz_terminate_buffer(fz_context *ctx, fz_buffer *buf);

void fz_md5_buffer(fz_context *ctx, fz_buffer *buffer, unsigned char digest[16]);

size_t fz_buffer_extract(fz_context *ctx, fz_buffer *buf, unsigned char **data);
 
#endif