pcsx2/common/src/Utilities/StringHelpers.cpp

/*  PCSX2 - PS2 Emulator for PCs
 *  Copyright (C) 2002-2010  PCSX2 Dev Team
 *
 *  PCSX2 is free software: you can redistribute it and/or modify it under the terms
 *  of the GNU Lesser General Public License as published by the Free Software Found-
 *  ation, either version 3 of the License, or (at your option) any later version.
 *
 *  PCSX2 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 PCSX2.
 *  If not, see <http://www.gnu.org/licenses/>.
 */

#include "PrecompiledHeader.h"
#include <wx/gdicmn.h>		// for wxPoint/wxRect stuff

__fi wxString fromUTF8( const char* src )
{
	// IMPORTANT:  We cannot use wxString::FromUTF8 because it *stupidly* relies on a C++ global instance of
	// wxMBConvUTF8().  C++ initializes and destroys these globals at random, so any object constructor or
	// destructor that attempts to do logging may crash the app (either during startup or during exit) unless
	// we use a LOCAL instance of wxMBConvUTF8(). --air

	// Performance?  No worries.  wxMBConvUTF8() is virtually free.  Initializing a stack copy of the class
	// is just as efficient as passing a pointer to a pre-instanced global. (which makes me wonder wh wxWidgets
	// uses the stupid globals in the first place!)  --air

	return wxString( src, wxMBConvUTF8() );
}

__fi wxString fromAscii( const char* src )
{
	return wxString::FromAscii( src );
}

wxString u128::ToString() const
{
	return pxsFmt( L"0x%08X.%08X.%08X.%08X", _u32[0], _u32[1], _u32[2], _u32[3] );
}

wxString u128::ToString64() const
{
	return pxsFmt( L"0x%08X%08X.%08X%08X", _u32[0], _u32[1], _u32[2], _u32[3] );
}

wxString u128::ToString8() const
{
	FastFormatUnicode result;
	result.Write( L"0x%02X.%02X", _u8[0], _u8[1] );
	for (uint i=2; i<16; i+=2)
		result.Write( L".%02X.%02X", _u8[i], _u8[i+1] );
	return result;
}

void u128::WriteTo( FastFormatAscii& dest ) const
{
	dest.Write( "0x%08X.%08X.%08X.%08X", _u32[0], _u32[1], _u32[2], _u32[3] );
}

void u128::WriteTo64( FastFormatAscii& dest ) const
{
	dest.Write( "0x%08X%08X.%08X%08X", _u32[0], _u32[1], _u32[2], _u32[3] );
}

void u128::WriteTo8( FastFormatAscii& dest ) const
{
	dest.Write( "0x%02X.%02X", _u8[0], _u8[1] );
	for (uint i=2; i<16; i+=2)
		dest.Write( ".%02X.%02X", _u8[i], _u8[i+1] );
}

// Splits a string into parts and adds the parts into the given SafeList.
// This list is not cleared, so concatenating many splits into a single large list is
// the 'default' behavior, unless you manually clear the SafeList prior to subsequent calls.
//
// Note: wxWidgets 2.9 / 3.0 has a wxSplit function, but we're using 2.8 so I had to make
// my own.
void SplitString( wxArrayString& dest, const wxString& src, const wxString& delims, wxStringTokenizerMode mode )
{
	wxStringTokenizer parts( src, delims, mode );
	while( parts.HasMoreTokens() )
		dest.Add( parts.GetNextToken() );
}

// Joins a list of strings into one larger string, using the given string concatenation
// character as a separator.  If you want to be able to split the string later then the
// concatenation string needs to be a single character.
//
// Note: wxWidgets 2.9 / 3.0 has a wxJoin function, but we're using 2.8 so I had to make
// my own.
wxString JoinString( const wxArrayString& src, const wxString& separator )
{
	wxString dest;
	for( int i=0, len=src.GetCount(); i<len; ++i )
	{
		if( src[i].IsEmpty() ) continue;
		if( !dest.IsEmpty() )
			dest += separator;
		dest += src[i];
	}
	return dest;
}

wxString JoinString( const wxChar** src, const wxString& separator )
{
	wxString dest;
	while( *src != NULL )
	{
		if( *src[0] == 0 ) continue;

		if( !dest.IsEmpty() )
			dest += separator;
		dest += *src;
		++src;
	}
	return dest;
}


// Attempts to parse and return a value for the given template type, and throws a ParseError
// exception if the parse fails.  The template type can be anything that is supported/
// implemented via one of the TryParse() method overloads.
//
// This, so far, include types such as wxPoint, wxRect, and wxSize.
//
template< typename T >
T Parse( const wxString& src, const wxString& separators=L",")
{
	T retval;
	if( !TryParse( retval, src, separators ) )
		throw Exception::ParseError( "Parse failure on call to " + fromUTF8(__WXFUNCTION__) + ": " + src );
	return retval;
}


// --------------------------------------------------------------------------------------
//  ToString helpers for wxString!
// --------------------------------------------------------------------------------------

// Converts a wxPoint into a comma-delimited string!
wxString ToString( const wxPoint& src, const wxString& separator )
{
	return wxString() << src.x << separator << src.y;
}

wxString ToString( const wxSize& src, const wxString& separator )
{
	return wxString() << src.GetWidth() << separator << src.GetHeight();
}

// Converts a wxRect into a comma-delimited string!
// Example: 32,64,128,5
wxString ToString( const wxRect& src, const wxString& separator )
{
	return ToString( src.GetLeftTop(), separator ) << separator << ToString( src.GetSize(), separator );
}

// --------------------------------------------------------------------------------------
//  Parse helpers for wxString!
// --------------------------------------------------------------------------------------

bool TryParse( wxPoint& dest, wxStringTokenizer& parts )
{
	long result[2];

	if( !parts.HasMoreTokens() || !parts.GetNextToken().ToLong( &result[0] ) ) return false;
	if( !parts.HasMoreTokens() || !parts.GetNextToken().ToLong( &result[1] ) ) return false;
	dest.x = result[0];
	dest.y = result[1];

	return true;
}

bool TryParse( wxSize& dest, wxStringTokenizer& parts )
{
	long result[2];

	if( !parts.HasMoreTokens() || !parts.GetNextToken().ToLong( &result[0] ) ) return false;
	if( !parts.HasMoreTokens() || !parts.GetNextToken().ToLong( &result[1] ) ) return false;
	dest.SetWidth( result[0] );
	dest.SetHeight( result[1] );

	return true;
}

// Tries to parse the given string into a wxPoint value at 'dest.'  If the parse fails, the
// method aborts and returns false.
bool TryParse( wxPoint& dest, const wxString& src, const wxPoint& defval, const wxString& separators )
{
	dest = defval;
	wxStringTokenizer parts( src, separators );
	return TryParse( dest, parts );
}

bool TryParse( wxSize& dest, const wxString& src, const wxSize& defval, const wxString& separators )
{
	dest = defval;
	wxStringTokenizer parts( src, separators );
	return TryParse( dest, parts );
}

bool TryParse( wxRect& dest, const wxString& src, const wxRect& defval, const wxString& separators )
{
	dest = defval;

	wxStringTokenizer parts( src, separators );

	wxPoint point;
	wxSize size;

	if( !TryParse( point, parts ) ) return false;
	if( !TryParse( size, parts ) ) return false;

	dest = wxRect( point, size );
	return true;
}

// returns TRUE if the parse is valid, or FALSE if it's a comment.
bool pxParseAssignmentString( const wxString& src, wxString& ldest, wxString& rdest )
{
	if( src.StartsWith(L"--") || src.StartsWith( L"//" ) || src.StartsWith( L";" ) )
		return false;

	ldest = src.BeforeFirst(L'=').Trim(true).Trim(false);
	rdest = src.AfterFirst(L'=').Trim(true).Trim(false);
	
	return true;
}

ParsedAssignmentString::ParsedAssignmentString( const wxString& src )
{
	IsComment = pxParseAssignmentString( src, lvalue, rvalue );
}

// Performs a cross-platform puts operation, which adds CRs to naked LFs on Win32 platforms,
// so that Notepad won't throw a fit and Rama can read the logs again! On Unix and Mac platforms,
// the input string is written unmodified.
//
// PCSX2 generally uses Unix-style newlines -- LF (\n) only -- hence there's no need to strip CRs
// from incoming data.  Mac platforms may need an implementation of their own that converts
// newlines to CRs...?
//
void px_fputs( FILE* fp, const char* src )
{
	if( fp == NULL ) return;

#ifdef _WIN32
	// Windows needs CR's partnered with all newlines, or else notepad.exe can't view
	// the stupid logfile.  Best way is to write one char at a time.. >_<

	const char* curchar = src;
	bool prevcr = false;
	while( *curchar != 0 )
	{
		if( *curchar == '\r' )
		{
			prevcr = true;
		}
		else
		{
			// Only write a CR/LF pair if the current LF is not prefixed nor
			// post-fixed by a CR.
			if( *curchar == '\n' && !prevcr && (*(curchar+1) != '\r') )
				fputs( "\r\n", fp );
			else
				fputc( *curchar, fp );

			prevcr = false;
		}
		++curchar;
	}

#else
	// Linux is happy with plain old LFs.  Not sure about Macs... does OSX still
	// go by the old school Mac style of using Crs only?

	fputs( src, fp );	// fputs does not do automatic newlines, so it's ok!
#endif
}