varbuf.h

Go to the documentation of this file.

/*
 * libdpkg - Debian packaging suite library routines
 * varbuf.h - variable length expandable buffer handling
 *
 * Copyright © 1994, 1995 Ian Jackson <ijackson@chiark.greenend.org.uk>
 * Copyright © 2008-2015 Guillem Jover <guillem@debian.org>
 *
 * This is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef LIBDPKG_VARBUF_H
#define LIBDPKG_VARBUF_H
 
#include <stddef.h>
#include <stdarg.h>
#include <stdbool.h>
#include <string.h>
 
#include <dpkg/macros.h>
 
DPKG_BEGIN_DECLS
 
struct varbuf {
        size_t used, size;
        char *buf;
 
#ifdef __cplusplus
        explicit varbuf(size_t _size = 0);
        ~varbuf();
        void init(size_t _size = 0);
        void reset();
        void destroy();
        int fmt(const char *_fmt, ...) DPKG_ATTR_PRINTF(2);
        int vfmt(const char *_fmt, va_list va) DPKG_ATTR_VPRINTF(2);
        void operator()(int c);
        void operator()(const char *s);
        const char *string();
#endif
};
 
#define VARBUF_INIT { 0, 0, NULL }
 
#define VARBUF_OBJECT (struct varbuf)VARBUF_INIT
 
struct varbuf *varbuf_new(size_t size);
void varbuf_init(struct varbuf *v, size_t size);
void varbuf_grow(struct varbuf *v, size_t need_size);
void varbuf_trunc(struct varbuf *v, size_t used_size);
char *varbuf_detach(struct varbuf *v);
void varbuf_reset(struct varbuf *v);
void varbuf_destroy(struct varbuf *v);
void varbuf_free(struct varbuf *v);
 
const char *varbuf_str(struct varbuf *v);
 
void varbuf_set_varbuf(struct varbuf *v, struct varbuf *other);
void varbuf_set_buf(struct varbuf *v, const void *buf, size_t size);
#define varbuf_set_str(v, s) varbuf_set_buf(v, s, strlen(s))
#define varbuf_set_strn(v, s, n) varbuf_set_buf(v, s, strnlen(s, n))
 
void varbuf_add_varbuf(struct varbuf *v, const struct varbuf *other);
void varbuf_add_char(struct varbuf *v, int c);
void varbuf_dup_char(struct varbuf *v, int c, size_t n);
void varbuf_map_char(struct varbuf *v, int c_src, int c_dst);
#define varbuf_add_str(v, s) varbuf_add_buf(v, s, strlen(s))
#define varbuf_add_strn(v, s, n) varbuf_add_buf(v, s, strnlen(s, n))
void varbuf_add_dir(struct varbuf *v, const char *dirname);
void varbuf_add_buf(struct varbuf *v, const void *s, size_t size);
 
bool varbuf_has_prefix(struct varbuf *v, struct varbuf *prefix);
bool varbuf_has_suffix(struct varbuf *v, struct varbuf *suffix);
void varbuf_trim_varbuf_prefix(struct varbuf *v, struct varbuf *prefix);
void varbuf_trim_char_prefix(struct varbuf *v, int prefix);
 
int varbuf_printf(struct varbuf *v, const char *fmt, ...) DPKG_ATTR_PRINTF(2);
int varbuf_vprintf(struct varbuf *v, const char *fmt, va_list va)
        DPKG_ATTR_VPRINTF(2);
 
struct varbuf_state {
        struct varbuf *v;
        size_t used;
};
 
void varbuf_snapshot(struct varbuf *v, struct varbuf_state *vs);
void varbuf_rollback(struct varbuf_state *vs);
size_t varbuf_rollback_len(struct varbuf_state *vs);
const char *varbuf_rollback_start(struct varbuf_state *vs);
 
DPKG_END_DECLS
 
#ifdef __cplusplus
inline
varbuf::varbuf(size_t _size)
{
        varbuf_init(this, _size);
}
 
inline
varbuf::~varbuf()
{
        varbuf_destroy(this);
}
 
inline void
varbuf::init(size_t _size)
{
        varbuf_init(this, _size);
}
 
inline void
varbuf::reset()
{
        used = 0;
}
 
inline void
varbuf::destroy()
{
        varbuf_destroy(this);
}
 
inline int
varbuf::fmt(const char *_fmt, ...)
{
        va_list args;
        int rc;
 
        va_start(args, _fmt);
        rc = varbuf_vprintf(this, _fmt, args);
        va_end(args);
 
        return rc;
}
 
inline int
varbuf::vfmt(const char *_fmt, va_list va)
{
        return varbuf_vprintf(this, _fmt, va);
}
 
inline void
varbuf::operator()(int c)
{
        varbuf_add_char(this, c);
}
 
inline void
varbuf::operator()(const char *s)
{
        varbuf_add_str(this, s);
}
 
inline const char *
varbuf::string()
{
        return varbuf_str(this);
}
#endif
 
#endif /* LIBDPKG_VARBUF_H */