membuffer.h

Go to the documentation of this file.

/*******************************************************************************
 *
 * Copyright (c) 2000-2003 Intel Corporation
 * All rights reserved.
 * Copyright (c) 2012 France Telecom All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * - Neither name of Intel Corporation nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 ******************************************************************************/
 
#ifndef GENLIB_UTIL_MEMBUFFER_H
#define GENLIB_UTIL_MEMBUFFER_H

 
#include "upnputil.h"
#include <stdlib.h>
 
#define MINVAL(a, b) ((a) < (b) ? (a) : (b))
#define MAXVAL(a, b) ((a) > (b) ? (a) : (b))

typedef struct
{
        char *buf;
        size_t length;
} memptr;

typedef struct
{
        char *buf;
        size_t length;
        size_t capacity;
        size_t size_inc;
#define MEMBUF_DEF_SIZE_INC (size_t)5
} membuffer;
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

char *str_alloc(
        const char *str,
        size_t str_len);

int memptr_cmp(
        memptr *m,
        const char *s);

int memptr_cmp_nocase(
        memptr *m,
        const char *s);

int membuffer_set_size(
        membuffer *m,
        size_t new_length);

void membuffer_init(
        membuffer *m);

void membuffer_destroy(
        membuffer *m);

int membuffer_assign(
        membuffer *m,
        const void *buf,
        size_t buf_len);

int membuffer_assign_str(
        membuffer *m,
        const char *c_str);

int membuffer_append(
        membuffer *m,
        const void *buf,
        size_t buf_len);

int membuffer_append_str(
        membuffer *m,
        const char *c_str);

int membuffer_insert(
        membuffer *m,
        const void *buf,
        size_t buf_len,
        size_t index);

void membuffer_delete(
        membuffer *m,
        size_t index,
        size_t num_bytes);
 
/*
 * \brief Detaches current buffer and returns it. The caller must free the
 * returned buffer using free(). After this call, length becomes 0.
 *
 * \return A pointer to the current buffer.
 */
char *membuffer_detach(
        membuffer *m);
 
/*
 * \brief Free existing memory in membuffer and assign the new buffer in its
 * place.
 *
 * \note 'new_buf' must be allocted using malloc or realloc so that it can be
 * freed using free().
 */
void membuffer_attach(
        membuffer *m,
        char *new_buf,
        size_t buf_len);
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* GENLIB_UTIL_MEMBUFFER_H */