util_str.cpp

/*
   Copyright (C) 1999-2007 id Software, Inc. and contributors.
   For a list of contributors, see the accompanying CONTRIBUTORS file.

   This file is part of GtkRadiant.

   GtkRadiant 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.

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

//need to rewrite this

#include "util_str.h"
#include <stdlib.h>
#include <ctype.h>
#include <stdio.h>
#include <stdarg.h>

#ifdef _WIN32
#pragma warning(disable : 4244)     // 'conversion' conversion from 'type1' to 'type2', possible loss of data
#pragma warning(disable : 4710)     // function 'blah' not inlined
#endif

static const int STR_ALLOC_GRAN = 20;

// screwy but intentional
#ifdef __APPLE_BUG__
char *idStr::__tolower
#else
char *idStr::tolower
#endif
(
	char *s1
){
	char *s;

	s = s1;
	while ( *s )
	{
		*s = ::tolower( *s );
		s++;
	}

	return s1;
}

// screwy but intentional
#ifdef __APPLE_BUG__
char *idStr::__toupper
#else
char *idStr::toupper
#endif
(
	char *s1
){
	char *s;

	s = s1;
	while ( *s )
	{
		*s = ::toupper( *s );
		s++;
	}

	return s1;
}

int idStr::icmpn
(
	const char *s1,
	const char *s2,
	int n
){
	int c1;
	int c2;

	do
	{
		c1 = *s1++;
		c2 = *s2++;

		if ( !n-- ) {
			// idStrings are equal until end point
			return 0;
		}

		if ( c1 != c2 ) {
			if ( c1 >= 'a' && c1 <= 'z' ) {
				c1 -= ( 'a' - 'A' );
			}

			if ( c2 >= 'a' && c2 <= 'z' ) {
				c2 -= ( 'a' - 'A' );
			}

			if ( c1 < c2 ) {
				// strings less than
				return -1;
			}
			else if ( c1 > c2 ) {
				// strings greater than
				return 1;
			}
		}
	}
	while ( c1 );

	// strings are equal
	return 0;
}

int idStr::icmp
(
	const char *s1,
	const char *s2
){
	int c1;
	int c2;

	do
	{
		c1 = *s1++;
		c2 = *s2++;

		if ( c1 != c2 ) {
			if ( c1 >= 'a' && c1 <= 'z' ) {
				c1 -= ( 'a' - 'A' );
			}

			if ( c2 >= 'a' && c2 <= 'z' ) {
				c2 -= ( 'a' - 'A' );
			}

			if ( c1 < c2 ) {
				// strings less than
				return -1;
			}
			else if ( c1 > c2 ) {
				// strings greater than
				return 1;
			}
		}
	}
	while ( c1 );

	// strings are equal
	return 0;
}

int idStr::cmpn
(
	const char *s1,
	const char *s2,
	int n
){
	int c1;
	int c2;

	do
	{
		c1 = *s1++;
		c2 = *s2++;

		if ( !n-- ) {
			// strings are equal until end point
			return 0;
		}

		if ( c1 < c2 ) {
			// strings less than
			return -1;
		}
		else if ( c1 > c2 ) {
			// strings greater than
			return 1;
		}
	}
	while ( c1 );

	// strings are equal
	return 0;
}

int idStr::cmp
(
	const char *s1,
	const char *s2
){
	int c1;
	int c2;

	do
	{
		c1 = *s1++;
		c2 = *s2++;

		if ( c1 < c2 ) {
			// strings less than
			return -1;
		}
		else if ( c1 > c2 ) {
			// strings greater than
			return 1;
		}
	}
	while ( c1 );

	// strings are equal
	return 0;
}

/*
   ============
   IsNumeric

   Checks a string to see if it contains only numerical values.
   ============
 */
bool idStr::isNumeric
(
	const char *str
){
	int len;
	int i;
	bool dot;

	if ( *str == '-' ) {
		str++;
	}

	dot = false;
	len = strlen( str );
	for ( i = 0; i < len; i++ )
	{
		if ( !isdigit( str[ i ] ) ) {
			if ( ( str[ i ] == '.' ) && !dot ) {
				dot = true;
				continue;
			}
			return false;
		}
	}

	return true;
}

idStr operator+
(
	const idStr& a,
	const float b
){
	char text[ 20 ];

	idStr result( a );

	sprintf( text, "%f", b );
	result.append( text );

	return result;
}

idStr operator+
(
	const idStr& a,
	const int b
){
	char text[ 20 ];

	idStr result( a );

	sprintf( text, "%d", b );
	result.append( text );

	return result;
}

idStr operator+
(
	const idStr& a,
	const unsigned b
){
	char text[ 20 ];

	idStr result( a );

	sprintf( text, "%u", b );
	result.append( text );

	return result;
}

idStr& idStr::operator+=
(
	const float a
){
	char text[ 20 ];

	sprintf( text, "%f", a );
	append( text );

	return *this;
}

idStr& idStr::operator+=
(
	const int a
){
	char text[ 20 ];

	sprintf( text, "%d", a );
	append( text );

	return *this;
}

idStr& idStr::operator+=
(
	const unsigned a
){
	char text[ 20 ];

	sprintf( text, "%u", a );
	append( text );

	return *this;
}

void idStr::CapLength
(
	int newlen
){
	assert( m_data );

	if ( length() <= newlen ) {
		return;
	}

	EnsureDataWritable();

	m_data->data[newlen] = 0;
	m_data->len = newlen;
}

void idStr::EnsureDataWritable
(
	void
){
	assert( m_data );
	strdata *olddata;
	int len;

	if ( !m_data->refcount ) {
		return;
	}

	olddata = m_data;
	len = length();

	m_data = new strdata;

	EnsureAlloced( len + 1, false );
	strncpy( m_data->data, olddata->data, len + 1 );
	m_data->len = len;

	olddata->DelRef();
}

void idStr::EnsureAlloced( int amount, bool keepold ) {

	if ( !m_data ) {
		m_data = new strdata();
	}

	// Now, let's make sure it's writable
	EnsureDataWritable();

	char *newbuffer;
	bool wasalloced = ( m_data->alloced != 0 );

	if ( amount < m_data->alloced ) {
		return;
	}

	assert( amount );
	if ( amount == 1 ) {
		m_data->alloced = 1;
	}
	else {
		int newsize, mod;
		mod = amount % STR_ALLOC_GRAN;
		if ( !mod ) {
			newsize = amount;
		}
		else {
			newsize = amount + STR_ALLOC_GRAN - mod;
		}
		m_data->alloced = newsize;
	}

	newbuffer = new char[m_data->alloced];
	if ( wasalloced && keepold ) {
		strcpy( newbuffer, m_data->data );
	}

	if ( m_data->data ) {
		delete [] m_data->data;
	}
	m_data->data = newbuffer;
}

void idStr::BackSlashesToSlashes
(
	void
){
	int i;

	EnsureDataWritable();

	for ( i = 0; i < m_data->len; i++ )
	{
		if ( m_data->data[i] == '\\' ) {
			m_data->data[i] = '/';
		}
	}
}

void idStr::snprintf
(
	char *dst,
	int size,
	const char *fmt,
	...
){
	char buffer[0x10000];
	int len;
	va_list argptr;

	va_start( argptr,fmt );
	len = vsprintf( buffer,fmt,argptr );
	va_end( argptr );

	assert( len < size );

	strncpy( dst, buffer, size - 1 );
}

#ifdef _WIN32
#pragma warning(disable : 4189)     // local variable is initialized but not referenced
#endif

/*
   =================
   TestStringClass

   This is a fairly rigorous test of the idStr class's functionality.
   Because of the fairly global and subtle ramifications of a bug occuring
   in this class, it should be run after any changes to the class.
   Add more tests as functionality is changed.  Tests should include
   any possible bounds violation and NULL data tests.
   =================
 */
void TestStringClass
(
	void
){
	char ch;                            // ch == ?
	idStr   *t;                         // t == ?
	idStr a;                                // a.len == 0, a.data == "\0"
	idStr b;                                // b.len == 0, b.data == "\0"
	idStr c( "test" );                  // c.len == 4, c.data == "test\0"
	idStr d( c );                       // d.len == 4, d.data == "test\0"
	idStr e( reinterpret_cast<const char *>( NULL ) );
	// e.len == 0, e.data == "\0"					ASSERT!
	int i;                              // i == ?

	i = a.length();                 // i == 0
	i = c.length();                 // i == 4

	t = new idStr();                        // t->len == 0, t->data == "\0"
	delete t;                           // t == ?

	b = "test";                         // b.len == 4, b.data == "test\0"
	t = new idStr( "test" );            // t->len == 4, t->data == "test\0"
	delete t;                           // t == ?

	a = c;                              // a.len == 4, a.data == "test\0"
//   a = "";
	a = NULL;                           // a.len == 0, a.data == "\0"					ASSERT!
	a = c + d;                          // a.len == 8, a.data == "testtest\0"
	a = c + "wow";                      // a.len == 7, a.data == "testwow\0"
	a = c + reinterpret_cast<const char *>( NULL );
	// a.len == 4, a.data == "test\0"			ASSERT!
	a = "this" + d;                 // a.len == 8, a.data == "thistest\0"
	a = reinterpret_cast<const char *>( NULL ) + d;
	// a.len == 4, a.data == "test\0"			ASSERT!
	a += c;                             // a.len == 8, a.data == "testtest\0"
	a += "wow";                         // a.len == 11, a.data == "testtestwow\0"
	a += reinterpret_cast<const char *>( NULL );
	// a.len == 11, a.data == "testtestwow\0"	ASSERT!

	a = "test";                         // a.len == 4, a.data == "test\0"
	ch = a[ 0 ];                        // ch == 't'
	ch = a[ -1 ];                       // ch == 0											ASSERT!
	ch = a[ 1000 ];                 // ch == 0											ASSERT!
	ch = a[ 0 ];                        // ch == 't'
	ch = a[ 1 ];                        // ch == 'e'
	ch = a[ 2 ];                        // ch == 's'
	ch = a[ 3 ];                        // ch == 't'
	ch = a[ 4 ];                        // ch == '\0'										ASSERT!
	ch = a[ 5 ];                        // ch == '\0'										ASSERT!

	a[ 1 ] = 'b';                       // a.len == 4, a.data == "tbst\0"
	a[ -1 ] = 'b';                      // a.len == 4, a.data == "tbst\0"			ASSERT!
	a[ 0 ] = '0';                       // a.len == 4, a.data == "0bst\0"
	a[ 1 ] = '1';                       // a.len == 4, a.data == "01st\0"
	a[ 2 ] = '2';                       // a.len == 4, a.data == "012t\0"
	a[ 3 ] = '3';                       // a.len == 4, a.data == "0123\0"
	a[ 4 ] = '4';                       // a.len == 4, a.data == "0123\0"			ASSERT!
	a[ 5 ] = '5';                       // a.len == 4, a.data == "0123\0"			ASSERT!
	a[ 7 ] = '7';                       // a.len == 4, a.data == "0123\0"			ASSERT!

	a = "test";                         // a.len == 4, a.data == "test\0"
	b = "no";                           // b.len == 2, b.data == "no\0"

	i = ( a == b );                 // i == 0
	i = ( a == c );                 // i == 1

	i = ( a == "blow" );                // i == 0
	i = ( a == "test" );                // i == 1
	i = ( a == NULL );              // i == 0											ASSERT!

	i = ( "test" == b );                // i == 0
	i = ( "test" == a );                // i == 1
	i = ( NULL == a );              // i == 0											ASSERT!

	i = ( a != b );                 // i == 1
	i = ( a != c );                 // i == 0

	i = ( a != "blow" );                // i == 1
	i = ( a != "test" );                // i == 0
	i = ( a != NULL );              // i == 1											ASSERT!

	i = ( "test" != b );                // i == 1
	i = ( "test" != a );                // i == 0
	i = ( NULL != a );              // i == 1											ASSERT!

	a = "test";                  // a.data == "test"
	b = a;                       // b.data == "test"

	a = "not";                  // a.data == "not", b.data == "test"

	a = b;                       // a.data == b.data == "test"

	a += b;                      // a.data == "testtest", b.data = "test"

	a = b;

	a[1] = '1';                  // a.data = "t1st", b.data = "test"
}

#ifdef _WIN32
#pragma warning(default : 4189)     // local variable is initialized but not referenced
#pragma warning(disable : 4514)     // unreferenced inline function has been removed
#endif