edlstring.h File Reference

EDLString and EDLSysString classes and associated EDL string manipulation functions. More...

#include <string>
#include <sstream>
#include <limits>
#include <edl/platform.h>
#include <edl/edltypes.h>
#include <edl/edlvector.h>

Include dependency graph for edlstring.h:

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

Go to the source code of this file.

Typedefs
typedef wchar_t	u32char
typedef std::string	EDLSysString
typedef std::istringstream	EDLSysStringIStream
typedef std::ostringstream	EDLSysStringOStream
typedef std::basic_string< u16char >	EDLU16String
typedef std::basic_string< u32char >	EDLU32String
typedef std::wstring	EDLString
typedef std::wistringstream	EDLStringIStream
typedef std::wostringstream	EDLStringOStream
typedef EDLSysString	EDLRawString
typedef CEDLVector< EDLString >	CEDLStringVect
typedef CEDLVector< EDLSysString >	CEDLSysStringVect
typedef CEDLVector< EDLRawString >	CEDLRawStringVect

Functions
bool	equal (const EDLSysString &str1, const EDLSysString &str2)
uint32	hashValue (const EDLSysString &str)
uint32	hashValue (const char *pStr, uint32 lenStr)
uint8	sxtob (char c)
	sxtob converts a hexadecimal character into corresponding (unsigned) integer value.
bool	edlstringEqualsIgnoreCaseCnt (const EDLString &str1, const EDLString &str2, size_t len)
	edlstringEqualsIgnoreCaseCnt performs a case-insensitive maximum-length-constrained string equality test
size_t	edlstringFind (const EDLString &str, EDLString &searchStr)
	edlstringFind searches for a substring within a larger string.
void	edlstringSubstr (const EDLString &str, EDLString &result, size_t start, size_t end)
	edlstringSubstr returns a substring from specified start and end points from a larger string
EDL_API EDLString	EDLSysStringToEDLString (const EDLSysString &edlSysString)
	EDLSysStringToEDLString converts an EDLSysString (UTF8) to an EDLString (UTF16 or UTF32 depending on platform).
EDL_API EDLSysString	EDLStringToEDLSysString (const EDLString &edlString)
	EDLStringToEDLSysString converts an (UTF16 or UTF32 depending on platform) EDLString to an EDLSysString (UTF8).

Variables
_BEGIN_EDL_NAMESPACE typedef char16_t	u16char

Detailed Description

EDLString and EDLSysString classes and associated EDL string manipulation functions.

Typedef Documentation

CEDLRawStringVect

typedef CEDLVector<EDLRawString> CEDLRawStringVect

CEDLStringVect

typedef CEDLVector<EDLString> CEDLStringVect

CEDLSysStringVect

typedef CEDLVector<EDLSysString> CEDLSysStringVect

EDLRawString

typedef EDLSysString EDLRawString

EDLString

typedef std::wstring EDLString

EDLStringIStream

typedef std::wistringstream EDLStringIStream

EDLStringOStream

typedef std::wostringstream EDLStringOStream

EDLSysString

typedef std::string EDLSysString

EDLSysStringIStream

typedef std::istringstream EDLSysStringIStream

EDLSysStringOStream

typedef std::ostringstream EDLSysStringOStream

EDLU16String

typedef std::basic_string<u16char> EDLU16String

EDLU32String

typedef std::basic_string<u32char> EDLU32String

u32char

typedef wchar_t u32char

Function Documentation

edlstringEqualsIgnoreCaseCnt()

bool edlstringEqualsIgnoreCaseCnt ( const EDLString & str1, const EDLString & str2, size_t len )

inline

edlstringEqualsIgnoreCaseCnt performs a case-insensitive maximum-length-constrained string equality test

Parameters

str1	First string
str2	Second string
len	Number of characters to compare

Returns

bool True if the two strings are equal, false if not

edlstringFind()

size_t edlstringFind ( const EDLString & str, EDLString & searchStr )

inline

edlstringFind searches for a substring within a larger string.

Parameters

str	String to be searched
searchStr	Substring to search for

Returns

size_t The starting position of the (first instance of the) substring.

edlstringSubstr()

void edlstringSubstr ( const EDLString & str, EDLString & result, size_t start, size_t end )

inline

edlstringSubstr returns a substring from specified start and end points from a larger string

Parameters

str	Source string
result	String to accept result
start	Start point
end	End point

EDLStringToEDLSysString()

EDL_API EDLSysString EDLStringToEDLSysString

(

const EDLString &

edlString

)

EDLStringToEDLSysString converts an (UTF16 or UTF32 depending on platform) EDLString to an EDLSysString (UTF8).

Parameters

edlString

Source string

Returns

EDLSysString Result of conversion

EDLSysStringToEDLString()

EDL_API EDLString EDLSysStringToEDLString

(

const EDLSysString &

edlSysString

)

EDLSysStringToEDLString converts an EDLSysString (UTF8) to an EDLString (UTF16 or UTF32 depending on platform).

Parameters

edlSysString

Source string

Returns

EDLString Result of conversion

equal()

bool equal ( const EDLSysString & str1, const EDLSysString & str2 )

inline

hashValue() [1/2]

uint32 hashValue	(	const char *	pStr,
		uint32	lenStr )

hashValue() [2/2]

uint32 hashValue

(

const EDLSysString &

str

)

sxtob()

uint8 sxtob ( char c )

inline

sxtob converts a hexadecimal character into corresponding (unsigned) integer value.

Note

There is no guard against being supplied with non-hexadecimal characters)

Parameters

c	The hexadecimal digit

Returns

uint8 The unsigned integer value

Variable Documentation

u16char

_BEGIN_EDL_NAMESPACE typedef char16_t u16char