CPLString Class Reference

Convenient string class based on std::string. More...

#include <cpl_string.h>

Inheritance diagram for CPLString:

Public Member Functions
	CPLString (void)
	CPLString (const std::string &oStr)
	CPLString (const char *pszStr)
	CPLString (const char *pszStr, size_t n)
	operator const char * (void) const
char &	operator[] (std::string::size_type i)
const char &	operator[] (std::string::size_type i) const
char &	operator[] (int i)
const char &	operator[] (int i) const
void	Clear ()
void	Seize (char *pszValue)
CPLSTRING_METHOD_DLL CPLString &	Printf (const char *pszFormat,...)
CPLSTRING_METHOD_DLL CPLString &	vPrintf (const char *pszFormat, va_list args)
CPLSTRING_METHOD_DLL CPLString &	FormatC (double dfValue, const char *pszFormat=nullptr)
CPLSTRING_METHOD_DLL CPLString &	Trim ()
CPLSTRING_METHOD_DLL CPLString &	Recode (const char *pszSrcEncoding, const char *pszDstEncoding)
CPLSTRING_METHOD_DLL CPLString &	replaceAll (const std::string &osBefore, const std::string &osAfter)
CPLSTRING_METHOD_DLL CPLString &	replaceAll (const std::string &osBefore, char chAfter)
CPLSTRING_METHOD_DLL CPLString &	replaceAll (char chBefore, const std::string &osAfter)
CPLSTRING_METHOD_DLL CPLString &	replaceAll (char chBefore, char chAfter)
CPLSTRING_METHOD_DLL size_t	ifind (const std::string &str, size_t pos=0) const
CPLSTRING_METHOD_DLL size_t	ifind (const char *s, size_t pos=0) const
CPLSTRING_METHOD_DLL CPLString &	toupper (void)
CPLSTRING_METHOD_DLL CPLString &	tolower (void)
CPLSTRING_METHOD_DLL bool	endsWith (const std::string &osStr) const

Detailed Description

Convenient string class based on std::string.

Constructor & Destructor Documentation

CPLString() [1/4]

CPLString::CPLString ( void  )

inline

Constructor

CPLString() [2/4]

CPLString::CPLString ( const std::string &  oStr )

inline

Constructor

CPLString() [3/4]

CPLString::CPLString ( const char *  pszStr )

inline

Constructor

CPLString() [4/4]

CPLString::CPLString ( const char *  pszStr, size_t  n  )

inline

Constructor

Member Function Documentation

Clear()

void CPLString::Clear ( )

inline

Clear the string

endsWith()

bool CPLString::endsWith

(

const std::string &

osStr

)

const

Returns whether the string ends with another string

Parameters

osStr

other string.

Returns

true if the string ends wit osStr.

FormatC()

CPLString & CPLString::FormatC	(	double	dfValue,
		const char *	pszFormat = nullptr
	)

Format double in C locale.

The passed value is formatted using the C locale (period as decimal separator) and appended to the target CPLString.

Parameters

dfValue	the value to format.
pszFormat	the sprintf() style format to use or omit for default. Note that this format string should only include one substitution argument and it must be for a double (f or g).

Returns

a reference to the CPLString.

References CPLsnprintf().

ifind() [1/2]

size_t CPLString::ifind	(	const std::string &	str,
		size_t	pos = 0
	)		const

Case insensitive find() alternative.

Parameters

str	substring to find.
pos	offset in the string at which the search starts.

Returns

the position of substring in the string or std::string::npos if not found.

Since

GDAL 1.9.0

Referenced by CPLURLAddKVP(), and CPLURLGetValue().

ifind() [2/2]

size_t CPLString::ifind	(	const char *	s,
		size_t	nPos = 0
	)		const

Case insensitive find() alternative.

Parameters

s	substring to find.
nPos	offset in the string at which the search starts.

Returns

the position of the substring in the string or std::string::npos if not found.

Since

GDAL 1.9.0

References EQUALN, and tolower().

operator const char *()

CPLString::operator const char * ( void  ) const

inline

Return string as zero terminated character array

operator[]() [1/4]

char& CPLString::operator[] ( std::string::size_type  i )

inline

Return character at specified index

operator[]() [2/4]

const char& CPLString::operator[] ( std::string::size_type  i ) const

inline

Return character at specified index

operator[]() [3/4]

char& CPLString::operator[] ( int  i )

inline

Return character at specified index

operator[]() [4/4]

const char& CPLString::operator[] ( int  i ) const

inline

Return character at specified index

Printf()

CPLString & CPLString::Printf	(	const char *	pszFormat,
			...
	)

Assign the content of the string using sprintf()

Referenced by CPLGenerateTempFilename(), CPLQuotedSQLIdentifier(), OGRSimpleCurve::exportToWkt(), CPLODBCSession::Failed(), CPLODBCStatement::GetTypeName(), GOA2GetAuthorizationURL(), GOA2GetRefreshToken(), OGRSpatialReference::importFromEPSGA(), OGRSpatialReference::SetAuthority(), and OGRSpatialReference::SetTOWGS84().

Recode()

CPLString & CPLString::Recode	(	const char *	pszSrcEncoding,
		const char *	pszDstEncoding
	)

Recode the string

References CPL_ENC_UTF8, CPLFree, and CPLRecode().

replaceAll() [1/4]

CPLString & CPLString::replaceAll	(	const std::string &	osBefore,
		const std::string &	osAfter
	)

Replace all occurrences of osBefore with osAfter.

Referenced by replaceAll().

replaceAll() [2/4]

CPLString & CPLString::replaceAll	(	const std::string &	osBefore,
		char	chAfter
	)

Replace all occurrences of osBefore with chAfter.

References replaceAll().

replaceAll() [3/4]

CPLString & CPLString::replaceAll	(	char	chBefore,
		const std::string &	osAfter
	)

Replace all occurrences of chBefore with osAfter.

References replaceAll().

replaceAll() [4/4]

CPLString & CPLString::replaceAll	(	char	chBefore,
		char	chAfter
	)

Replace all occurrences of chBefore with chAfter.

References replaceAll().

Seize()

void CPLString::Seize ( char *  pszValue )

inline

Assign specified string and take ownership of it (assumed to be allocated with CPLMalloc()). NULL can be safely passed to clear the string.

References CPLFree.

Referenced by GOA2GetAuthorizationURL(), and GOA2GetRefreshToken().

tolower()

CPLString & CPLString::tolower

(

void

)

Convert to lower case in place.

Referenced by ifind().

toupper()

CPLString & CPLString::toupper

(

void

)

Convert to upper case in place.

Trim()

CPLString & CPLString::Trim

(

)

Trim white space.

Trims white space off the let and right of the string. White space is any of a space, a tab, a newline ('\n') or a carriage control ('\r').

Returns

a reference to the CPLString.

vPrintf()

CPLString & CPLString::vPrintf	(	const char *	pszFormat,
		va_list	args
	)

Assign the content of the string using vsprintf()

References CPLError(), CPLMalloc(), and CPLvsnprintf().

Referenced by CPLOPrintf(), CPLOvPrintf(), CPLVASPrintf(), CSLAppendPrintf(), and VSIFPrintfL().

---

The documentation for this class was generated from the following files:

• cpl_string.h
• cplstring.cpp