Ichthyostega
806db414dd
* Lumiera source code always was copyrighted by individual contributors * there is no entity "Lumiera.org" which holds any copyrights * Lumiera source code is provided under the GPL Version 2+ == Explanations == Lumiera as a whole is distributed under Copyleft, GNU General Public License Version 2 or above. For this to become legally effective, the ''File COPYING in the root directory is sufficient.'' The licensing header in each file is not strictly necessary, yet considered good practice; attaching a licence notice increases the likeliness that this information is retained in case someone extracts individual code files. However, it is not by the presence of some text, that legally binding licensing terms become effective; rather the fact matters that a given piece of code was provably copyrighted and published under a license. Even reformatting the code, renaming some variables or deleting parts of the code will not alter this legal situation, but rather creates a derivative work, which is likewise covered by the GPL! The most relevant information in the file header is the notice regarding the time of the first individual copyright claim. By virtue of this initial copyright, the first author is entitled to choose the terms of licensing. All further modifications are permitted and covered by the License. The specific wording or format of the copyright header is not legally relevant, as long as the intention to publish under the GPL remains clear. The extended wording was based on a recommendation by the FSF. It can be shortened, because the full terms of the license are provided alongside the distribution, in the file COPYING.
119 lines
3.8 KiB
C
119 lines
3.8 KiB
C
/*
|
||
TMPBUF.h - Round Robin Temporary buffers
|
||
|
||
Copyright (C)
|
||
2008, 2010 Christian Thaeter <ct@pipapo.org>
|
||
|
||
**Lumiera** 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. See the file COPYING for further details.
|
||
|
||
*/
|
||
|
||
|
||
/** @file tmpbuf.h
|
||
** Round robin temporary buffers.
|
||
** This helper provides some buffers per thread which are round-robin recycled with each use.
|
||
** The idea is to have fast buffers for temporal data without need for explicit heap management.
|
||
** There is a fixed number of buffers per thread, which will be re-used with a round-robin pattern,
|
||
** without any safety checks. The caller just needs to ensure not to use too much of these buffers.
|
||
** Typical usage is for "just printing a damn number", hand it over to a library, which will copy
|
||
** the data anyway.
|
||
**
|
||
** @warning this is the restored old version from bc989dab7a97fc69c (July 2010)
|
||
** (the improved version is still buggy as of 5/2011)
|
||
*/
|
||
|
||
|
||
#ifndef LUMIERA_TMPBUF_H
|
||
#define LUMIERA_TMPBUF_H
|
||
|
||
#include <stdlib.h>
|
||
|
||
|
||
|
||
/**
|
||
* Number of buffers in the ring
|
||
* This also defines how many concurent buffers can be in use in one thread (including nested calls)
|
||
* tmpbufs are only suitable for nested calls where one knows in advance how much tmpbufs might be used
|
||
*
|
||
* @warning the value defined here must be a power of 2
|
||
*/
|
||
#define LUMIERA_TMPBUF_NUM 16
|
||
|
||
|
||
|
||
/**
|
||
* free all buffers associated with this thread.
|
||
* This function is called automatically, usually one doesnt need to call it.
|
||
*/
|
||
void
|
||
lumiera_tmpbuf_freeall (void);
|
||
|
||
/**
|
||
* Query a thread local tmpbuf.
|
||
* @param size minimal needed size for the tmpbuf
|
||
* @return the tmpbuf
|
||
*/
|
||
void*
|
||
lumiera_tmpbuf_provide (size_t size);
|
||
|
||
/**
|
||
* Duplicate string to a tmpbuf.
|
||
* @param src string to be duplicated
|
||
* @param size maximal length to be copied
|
||
* @return temporary buffer containing a copy of the string
|
||
*/
|
||
char*
|
||
lumiera_tmpbuf_strndup (const char* src, size_t size);
|
||
|
||
/**
|
||
* Construct a string in a tmpbuf.
|
||
* @param size maximal length for the string
|
||
* @param fmt printf like formatstring
|
||
* @param ... parameters
|
||
* @return temporary buffer containing the constructed of the string
|
||
*/
|
||
char*
|
||
lumiera_tmpbuf_snprintf (size_t size, const char* fmt, ...);
|
||
|
||
|
||
/**
|
||
* Concat up to 3 strings in a tmpbuf.
|
||
* @param str1 first string to concat or NULL
|
||
* @param str1_len how much of the first string shall be used
|
||
* @param str2 second string to concat or NULL
|
||
* @param str2_len how much of the second string shall be used
|
||
* @param str3 third string to concat or NULL
|
||
* @param str3_len how much of the third string shall be used
|
||
* @return temporary buffer containing the constructed of the string
|
||
*/
|
||
char*
|
||
lumiera_tmpbuf_strcat3 (const char* str1, size_t str1_len,
|
||
const char* str2, size_t str2_len,
|
||
const char* str3, size_t str3_len);
|
||
|
||
/**
|
||
* Translates characters in a string, similar to the shell 'tr' utility
|
||
* @param in input string to be translated
|
||
* @param from source character set
|
||
* @param to destination character set
|
||
* @param def default destination character when a character is not in the source set,
|
||
* when NULL then translation will abort on unknown characters and return NULL,
|
||
* when "" then unknown characters will be removed
|
||
* when set to a single character string, unknown characters will be replaced with this character
|
||
* @return temporary buffer containing the constructed of the string
|
||
*/
|
||
char*
|
||
lumiera_tmpbuf_tr (const char* in, const char* from, const char* to, const char* def);
|
||
|
||
|
||
#endif
|
||
/*
|
||
// Local Variables:
|
||
// mode: C
|
||
// c-file-style: "gnu"
|
||
// indent-tabs-mode: nil
|
||
// End:
|
||
*/
|