libical/apidocs/icalmemory_8h_source.html

/*======================================================================

 FILE: icalmemory.h

 CREATOR: eric 30 June 1999


 (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>


 This library is free software; you can redistribute it and/or modify

 it under the terms of either:


    The LGPL as published by the Free Software Foundation, version

    2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html


 Or:


    The Mozilla Public License Version 2.0. You may obtain a copy of

    the License at https://www.mozilla.org/MPL/


 The Initial Developer of the Original Code is Eric Busboom

======================================================================*/


#ifndef ICALMEMORY_H

#define ICALMEMORY_H


#include "libical_ical_export.h"


LIBICAL_ICAL_EXPORT void *icalmemory_tmp_buffer(size_t size);


LIBICAL_ICAL_EXPORT char *icalmemory_tmp_copy(const char *str);


LIBICAL_ICAL_EXPORT void icalmemory_add_tmp_buffer(void *buf);


LIBICAL_ICAL_EXPORT void icalmemory_free_ring(void);


/* Non-tmp buffers must be freed. These are mostly wrappers around

 * malloc, etc, but are used so the caller can change the memory

 * allocators in a future version of the library */


LIBICAL_ICAL_EXPORT void *icalmemory_new_buffer(size_t size);


LIBICAL_ICAL_EXPORT void *icalmemory_resize_buffer(void *buf, size_t size);


LIBICAL_ICAL_EXPORT void icalmemory_free_buffer(void *buf);


/* THESE ROUTINES CAN NOT BE USED ON TMP BUFFERS. Only use them on

   normally allocated memory, or on buffers created from

   icalmemory_new_buffer, never with buffers created by

   icalmemory_tmp_buffer. If icalmemory_append_string has to resize a

   buffer on the ring, the ring will loose track of it an you will

   have memory problems. */


LIBICAL_ICAL_EXPORT void icalmemory_append_string(char **buf, char **pos, size_t *buf_size,

                                                  const char *string);


LIBICAL_ICAL_EXPORT void icalmemory_append_char(char **buf, char **pos, size_t *buf_size, char ch);


LIBICAL_ICAL_EXPORT char *icalmemory_strdup(const char *s);


#endif /* !ICALMEMORY_H */

icalmemory_free_ring
void icalmemory_free_ring(void)
Frees all memory used in the ring.
Definition icalmemory.c:227

icalmemory_free_buffer
void icalmemory_free_buffer(void *buf)
Releases a buffer.
Definition icalmemory.c:287

icalmemory_strdup
char * icalmemory_strdup(const char *s)
Creates a duplicate of a string.
Definition icalmemory.c:251

icalmemory_append_string
void icalmemory_append_string(char **buf, char **pos, size_t *buf_size, const char *string)
Appends a string to a buffer.
Definition icalmemory.c:292

icalmemory_resize_buffer
void * icalmemory_resize_buffer(void *buf, size_t size)
Resizes a buffer created with icalmemory_new_buffer().
Definition icalmemory.c:275

icalmemory_new_buffer
void * icalmemory_new_buffer(size_t size)
Creates new buffer with the specified size.
Definition icalmemory.c:261

icalmemory_tmp_copy
char * icalmemory_tmp_copy(const char *str)
Creates a copy of the given string, stored on the ring buffer, and returns it.
Definition icalmemory.c:242

icalmemory_append_char
void icalmemory_append_char(char **buf, char **pos, size_t *buf_size, char ch)
Appends a character to a buffer.
Definition icalmemory.c:330

icalmemory_add_tmp_buffer
void icalmemory_add_tmp_buffer(void *buf)
Adds an externally allocated buffer to the ring.
Definition icalmemory.c:182

icalmemory_tmp_buffer
void * icalmemory_tmp_buffer(size_t size)
Creates a new temporary buffer on the ring and returns it.
Definition icalmemory.c:205