warzone2100/lib/framework/strlfuncs.h

/*
	This file is part of Warzone 2100.
	Copyright (C) 2007  Giel van Schijndel
	Copyright (C) 2007  Warzone Resurrection Project

	Warzone 2100 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.

	Warzone 2100 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 Warzone 2100; if not, write to the Free Software
	Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/

#ifndef __INCLUDED_FRAMEWORK_STRLFUNCS_H__
#define __INCLUDED_FRAMEWORK_STRLFUNCS_H__

#include <string.h>
#include <stddef.h>

/** \def STR_L_FUNC_TRUNCATION_DETECT
 *  The "original" strlcpy() and strlcat() functions will return the amount
 *  of characters the destination string would be long, if no truncation has
 *  occurred.
 *  
 *  When STR_L_FUNC_TRUNCATION_DETECT is defined this behaviour will be
 *  simulated.
 *
 *  Right now though this behaviour isn't required, and as such it isn't
 *  compiled in by leaving STR_L_FUNC_TRUNCATION_DETECT undefined.
 */

#ifdef STR_L_FUNC_TRUNCATION_DETECT
static inline size_t strlcpy(char* dest, const char* src, size_t size)
#else
static inline void strlcpy(char* dest, const char* src, size_t size)
#endif
{
	strncpy(dest, src, size - 1);

	// Guarantee to nul-terminate
	dest[size - 1] = '\0';

#ifdef STR_L_FUNC_TRUNCATION_DETECT
	return strlen(src);
#endif
}

#ifdef STR_L_FUNC_TRUNCATION_DETECT
static inline size_t strlcat(char* dest, const char* src, size_t size)
#else
static inline void strlcat(char* dest, const char* src, size_t size)
#endif
{
	size_t dest_len = strlen(dest);

	strncat(dest, src, size - dest_len - 1);

#ifdef STR_L_FUNC_TRUNCATION_DETECT
	return strlen(src) + dest_len;
#endif
}

#endif // __INCLUDED_FRAMEWORK_STRLFUNCS_H__