BLI_string.h

Go to the documentation of this file.

/*
 * $Id: BLI_string.h 36933 2011-05-26 21:04:01Z campbellbarton $
 *
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program 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 program 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, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 *
 * $Id: BLI_string.h 36933 2011-05-26 21:04:01Z campbellbarton $ 
*/

#ifndef BLI_STRING_H
#define BLI_STRING_H

#ifdef __cplusplus
extern "C" {
#endif

char *BLI_strdup(const char *str);

char *BLI_strdupn(const char *str, const size_t len);

char *BLI_strdupcat(const char *str1, const char *str2);

char *BLI_strncpy(char *dst, const char *src, const size_t maxncpy);

        /* Makes a copy of the text within the "" that appear after some text 'blahblah'
         * i.e. for string 'pose["apples"]' with prefix 'pose[', it should grab "apples"
         * 
         *      - str: is the entire string to chop
         *      - prefix: is the part of the string to leave out 
         *
         * Assume that the strings returned must be freed afterwards, and that the inputs will contain 
         * data we want...
         */
char *BLI_getQuotedStr(const char *str, const char *prefix);

char *BLI_replacestr(char *str, const char *oldText, const char *newText);

        /* 
         * Replacement for snprintf
         */
size_t BLI_snprintf(char *buffer, size_t len, const char *format, ...)
#ifdef __GNUC__
__attribute__ ((format (printf, 3, 4)))
#endif
;

        /* 
         * Print formatted string into a newly mallocN'd string
         * and return it.
         */
char *BLI_sprintfN(const char *format, ...)
#ifdef __GNUC__
__attribute__ ((format (printf, 1, 2)))
#endif
;

int BLI_strcaseeq(const char *a, const char *b);

char *BLI_strcasestr(const char *s, const char *find);
int BLI_strcasecmp(const char *s1, const char *s2);
int BLI_strncasecmp(const char *s1, const char *s2, size_t len);
int BLI_natstrcmp(const char *s1, const char *s2);
size_t BLI_strnlen(const char *str, size_t maxlen);

void BLI_timestr(double _time, char *str); /* time var is global */

int BLI_utf8_invalid_byte(const char *str, int length);
int BLI_utf8_invalid_strip(char *str, int length);

void BLI_ascii_strtolower(char *str, int len);
void BLI_ascii_strtoupper(char *str, int len);

#ifdef __cplusplus
}
#endif

#endif