#include <nsStringAPI.h>
#include <nsTArray.h>
#include <prprf.h>
#include <sbMemoryUtils.h>

Include dependency graph for sbStringUtils.h:

This graph shows which files directly or indirectly include this file:

Classes
class	sbAutoString

class	sbCAutoString

class	SBVoidString

class	SBVoidCString

class	SBLocalizedString

Macros
#define	SB_STRING_BUNDLE_URL "chrome://songbird/locale/songbird.properties"

Functions
PRInt32	nsString_FindCharInSet (const nsAString &aString, const char *aPattern, PRInt32 aOffset=0)

void	AppendInt (nsAString &str, PRUint64 val)

PRInt64	nsString_ToInt64 (const nsAString &str, nsresult *rv=nsnull)

PRUint64	nsString_ToUint64 (const nsAString &str, nsresult *rv=nsnull)

void	SB_CompressWhitespace (nsAString &aString, PRBool aLeading=PR_TRUE, PRBool aTrailing=PR_TRUE)

nsresult	SB_StringEnumeratorEquals (nsIStringEnumerator aLeft, nsIStringEnumerator aRight, PRBool *_retval)

void	nsString_ReplaceChar (nsAString &aString, const nsAString &aOldChars, const PRUnichar aNewChar)

void	nsCString_ReplaceChars (nsACString &aOldString, const nsACString &aOldChars, const char aNewChar)

void	nsString_ReplaceSubstring (nsAString &aString, const nsAString &aOldString, const nsAString &aNewString)

PRBool	IsLikelyUTF8 (const nsACString &aString)

PRBool	IsUTF8 (const nsACString &aString)

void	nsString_Split (const nsAString &aString, const nsAString &aDelimiter, nsTArray< nsString > &aSubStringArray)

void	nsCString_Split (const nsACString &aString, const nsACString &aDelimiter, nsTArray< nsCString > &aSubStringArray)

nsString	SB_FormatISO8601TimeString (PRTime aTime)

nsresult	SB_ParseISO8601TimeString (const nsAString &aISO8601TimeString, PRTime *aTime)

nsresult	SBGetLocalizedString (nsAString &aString, const nsAString &aKey, const nsAString &aDefault, class nsIStringBundle *aStringBundle=nsnull)

nsresult	SBGetLocalizedString (nsAString &aString, const nsAString &aKey)

nsresult	SBGetLocalizedString (nsAString &aString, const char aKey, const char aDefault=nsnull, class nsIStringBundle *aStringBundle=nsnull)

nsresult	SBGetLocalizedFormattedString (nsAString &aString, const nsAString &aKey, const nsTArray< nsString > &aParams, const nsAString &aDefault, class nsIStringBundle *aStringBundle)

template<class T >
T const &	sbAppendStringArrayDefaultExtractor (T const &aArrayItem)

template<class S , class Sep , class T , class E >
S	sbAppendStringArray (S &aTarget, Sep const &aSeparator, T const &aStringArray, E aExtractor)

template<class S , class Sep , class T >
S	sbAppendStringArray (S &aTarget, Sep const &aSeparator, T const &aStringArray)

template<class StringType , class EnumeratorType >
nsresult	sbAppendStringEnumerator (StringType &aStringArray, EnumeratorType *aEnumerator)

	SB_AUTO_NULL_CLASS (sbAutoSmprintf, char *, PR_smprintf_free(mValue))

template<class T >
T	sbEscapeXML (T const &aSrc)

Macro Definition Documentation

#define SB_STRING_BUNDLE_URL "chrome://songbird/locale/songbird.properties"

Definition at line 308 of file sbStringUtils.h.

Function Documentation

void AppendInt	(	nsAString &	str,
		PRUint64	val
	)

Definition at line 58 of file sbStringUtils.cpp.

Here is the caller graph for this function:

PRBool IsLikelyUTF8 ( const nsACString & aString )

Return true if the given string is possibly UTF8 (i.e. it errs on the side of returning true)

Note that it assumes all 7-bit encodings are utf8, and doesn't check for invalid characters (e.g. 0xFFFE, surrogates). This is a weaker check than the nsReadableUtils version.

Definition at line 274 of file sbStringUtils.cpp.

Here is the call graph for this function:

PRBool IsUTF8 ( const nsACString & aString )

Returns true if the given string is UTF8

Note that this actually decodes the UTF8 string so it is significantly slower than IsLikelyUTF8.

Definition at line 328 of file sbStringUtils.cpp.

void nsCString_ReplaceChars	(	nsACString &	aOldString,
		const nsACString &	aOldChars,
		const char	aNewChar
	)

Definition at line 239 of file sbStringUtils.cpp.

Here is the caller graph for this function:

void nsCString_Split	(	const nsACString &	aString,
		const nsACString &	aDelimiter,
		nsTArray< nsCString > &	aSubStringArray
	)

Split the string specified by aString into sub-strings using the delimiter specified by aDelimiter and place the sub-strings in the array specified by aStringArray.

Parameters

aString	String to split.
aDelimiter	Sub-string delimiter.
aSubStringArray	Array of sub-strings.

Definition at line 394 of file sbStringUtils.cpp.

Here is the caller graph for this function:

PRInt32 nsString_FindCharInSet	(	const nsAString &	aString,
		const char *	aPattern,
		PRInt32	aOffset = `0`
	)

See Also: nsString::FindCharInSet

Definition at line 38 of file sbStringUtils.cpp.

void nsString_ReplaceChar	(	nsAString &	aString,
		const nsAString &	aOldChars,
		const PRUnichar	aNewChar
	)

Searches a string for any occurences of any character of a set and replace them with a replacement character. Modifies the string in-place.

See Also: nsString_internal::ReplaceChar

Definition at line 225 of file sbStringUtils.cpp.

Here is the caller graph for this function:

void nsString_ReplaceSubstring	(	nsAString &	aString,
		const nsAString &	aOldString,
		const nsAString &	aNewString
	)

Searches a string for any occurences of the substring and replaces it with the replacement string. Modifies the string in-place.

See Also: nsString_internal::ReplaceSubstring

Definition at line 252 of file sbStringUtils.cpp.

void nsString_Split	(	const nsAString &	aString,
		const nsAString &	aDelimiter,
		nsTArray< nsString > &	aSubStringArray
	)

Split the string specified by aString into sub-strings using the delimiter specified by aDelimiter and place the sub-strings in the array specified by aStringArray.

Parameters

aString	String to split.
aDelimiter	Sub-string delimiter.
aSubStringArray	Array of sub-strings.

Definition at line 353 of file sbStringUtils.cpp.

Here is the caller graph for this function:

PRInt64 nsString_ToInt64	(	const nsAString &	str,
		nsresult *	rv = `nsnull`
	)

Definition at line 66 of file sbStringUtils.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

PRUint64 nsString_ToUint64	(	const nsAString &	str,
		nsresult *	rv = `nsnull`
	)

Definition at line 91 of file sbStringUtils.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

SB_AUTO_NULL_CLASS	(	sbAutoSmprintf	,
		char *	,
		PR_smprintf_free(mValue)
	)

void SB_CompressWhitespace	(	nsAString &	aString,
		PRBool	aLeading,
		PRBool	aTrailing
	)

Trim whitespace from the beginning and end of a string; then compress remaining runs of whitespace characters to a single space.

Parameters

aString	String to compress.
aLeading	Whether to compress the leading whitespace.
aTrailing	Whether to compress the trailing whitespace.

See Also: CompressWhitespace in nsStringAPI.

This is originated from CompressWhitespace in nsStringAPI, with modification. Make sure to update it when the upstream is changed.

Definition at line 120 of file sbStringUtils.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

nsString SB_FormatISO8601TimeString ( PRTime aTime )

Creates an ISO 8610 formatted time string from the aTime passed in

Parameters

aTime The time to create the formatted string

Returns: The time as an ISO 8601 formatted string

Definition at line 434 of file sbStringUtils.cpp.

nsresult SB_ParseISO8601TimeString	(	const nsAString &	aISO8601TimeString,
		PRTime *	aTime
	)

Parse the ISO 8601 formatted time string specified by aISO8601TimeString and return the time in aTime.

Parameters

aISO8601TimeString	ISO 8601 formatted time string to parse.
aTime	Returned time.

Definition at line 444 of file sbStringUtils.cpp.

Here is the call graph for this function:

nsresult SB_StringEnumeratorEquals	(	nsIStringEnumerator *	aLeft,
		nsIStringEnumerator *	aRight,
		PRBool *	_retval
	)

Definition at line 165 of file sbStringUtils.cpp.

template<class S , class Sep , class T , class E >

S sbAppendStringArray	(	S &	aTarget,
		Sep const &	aSeparator,
		T const &	aStringArray,
		E	aExtractor
	)

inline

Definition at line 423 of file sbStringUtils.h.

Here is the caller graph for this function:

template<class S , class Sep , class T >

S sbAppendStringArray	(	S &	aTarget,
		Sep const &	aSeparator,
		T const &	aStringArray
	)

inline

Definition at line 465 of file sbStringUtils.h.

Here is the call graph for this function:

template<class T >

T const& sbAppendStringArrayDefaultExtractor ( T const & aArrayItem )

inline

Definition at line 416 of file sbStringUtils.h.

template<class StringType , class EnumeratorType >

nsresult sbAppendStringEnumerator	(	StringType &	aStringArray,
		EnumeratorType *	aEnumerator
	)

inline

Append the strings in the string enumerator specified by aEnumerator to the string array specified by aStringArray.

Parameters

aStringArray	String array to which to append.
aEnumerator	Source string enumerator.

Example:

nsTArray<nsString> stringArray; nsCOMPtr<nsIStringEnumerator> stringEnumerator = GetStringEnumerator(); sbAppendStringEnumerator(stringArray, stringEnumerator);

Definition at line 488 of file sbStringUtils.h.

template<class T >

T sbEscapeXML ( T const & aSrc )

This method escapes strings for use in HTML/XML.documents copied from nsEscape.cpp version of nsEscapeHTML2

Definition at line 528 of file sbStringUtils.h.

nsresult SBGetLocalizedFormattedString	(	nsAString &	aString,
		const nsAString &	aKey,
		const nsTArray< nsString > &	aParams,
		const nsAString &	aDefault,
		class nsIStringBundle *	aStringBundle
	)

Get and return in aString the formatted localized string with the key specified by aKey using the format parameters specified by aParams and the string bundle specified by aStringBundle. If the string cannot be found, return the default string specified by aDefault; if aDefault is void, return aKey. If aStringBundle is not specified, use the main Songbird string bundle.

Parameters

aString	Returned localized string.
aKey	Localized string key.
aParams	Format params array.
aDefault	Optional default string.
aStringBundle	Optional string bundle.

Definition at line 593 of file sbStringUtils.cpp.

Here is the caller graph for this function:

nsresult SBGetLocalizedString	(	nsAString &	aString,
		const nsAString &	aKey,
		const nsAString &	aDefault,
		class nsIStringBundle *	aStringBundle
	)

Get and return in aString the localized string with the key specified by aKey using the string bundle specified by aStringBundle. If the string cannot be found, return the default string specified by aDefault; if aDefault is not specified, return aKey.

If aStringBundle is not specified, use the main Songbird string bundle.

Parameters

aString	Returned localized string.
aKey	Localized string key.
aDefault	Optional default string.
aStringBundle	Optional string bundle.

Get and return in aString the localized string with the key specified by aKey using the string bundle specified by aStringBundle. If the string cannot be found, return the default string specified by aDefault; if aDefault is void, return aKey.

If aStringBundle is not specified, use the main Songbird string bundle.

Parameters

aString	Returned localized string.
aKey	Localized string key.
aDefault	Optional default string.
aStringBundle	Optional string bundle.

Definition at line 513 of file sbStringUtils.cpp.

Here is the caller graph for this function:

nsresult SBGetLocalizedString	(	nsAString &	aString,
		const nsAString &	aKey
	)

Definition at line 550 of file sbStringUtils.cpp.

Here is the call graph for this function:

nsresult SBGetLocalizedString	(	nsAString &	aString,
		const char *	aKey,
		const char *	aDefault = `nsnull`,
		class nsIStringBundle *	aStringBundle = `nsnull`
	)

Definition at line 557 of file sbStringUtils.cpp.

Here is the call graph for this function:

Classes

Macros

Functions

Macro Definition Documentation

Function Documentation