juce::pnglibNamespace::water Namespace Reference

Namespaces
namespace	NumberToStringConverters
namespace	TypeHelpers

Classes
class	CharacterFunctions
class	Atomic
class	CharPointer_UTF8
class	String
struct	StartEndString
class	StringRef

Typedefs
typedef signed char	int8
typedef unsigned char	uint8
typedef signed short	int16
typedef unsigned short	uint16
typedef signed int	int32
typedef unsigned int	uint32
typedef long long	int64
typedef unsigned long long	uint64
typedef int	pointer_sized_int
typedef unsigned int	pointer_sized_uint
typedef uint32	water_uchar

Functions
void	zeromem (void *memory, size_t numBytes) noexcept
template<typename Type>
void	zerostruct (Type &structure) noexcept
template<typename Type>
void	deleteAndZero (Type &pointer)
template<typename Type, typename IntegerType>
Type *	addBytesToPointer (Type *basePointer, IntegerType bytes) noexcept
template<typename Type1, typename Type2>
int	getAddressDifference (Type1 *pointer1, Type2 *pointer2) noexcept
template<class Type>
Type *	createCopyIfNotNull (const Type *objectToCopy)
template<typename Type>
Type	readUnaligned (const void *srcPtr) noexcept
template<typename Type>
void	writeUnaligned (void *dstPtr, Type value) noexcept
String	operator+ (const char *string1, const String &string2)
String	operator+ (char string1, const String &string2)
String	operator+ (water_uchar string1, const String &string2)
String	operator+ (String string1, const String &string2)
String	operator+ (String string1, const char *string2)
String	operator+ (String string1, char characterToAppend)
String	operator+ (String string1, water_uchar characterToAppend)
String &	operator<< (String &string1, char characterToAppend)
String &	operator<< (String &string1, water_uchar characterToAppend)
String &	operator<< (String &string1, const char *string2)
String &	operator<< (String &string1, const String &string2)
String &	operator<< (String &string1, StringRef string2)
String &	operator<< (String &string1, short number)
String &	operator<< (String &string1, int number)
String &	operator<< (String &string1, long number)
String &	operator<< (String &string1, int64 number)
String &	operator<< (String &string1, uint64 number)
String &	operator<< (String &string1, float number)
String &	operator<< (String &string1, double number)
bool	operator== (const String &string1, const String &string2) noexcept
bool	operator== (const String &string1, const char *string2) noexcept
bool	operator== (const String &string1, const CharPointer_UTF8 string2) noexcept
bool	operator!= (const String &string1, const String &string2) noexcept
bool	operator!= (const String &string1, const char *string2) noexcept
bool	operator!= (const String &string1, const CharPointer_UTF8 string2) noexcept
bool	operator> (const String &string1, const String &string2) noexcept
bool	operator< (const String &string1, const String &string2) noexcept
bool	operator>= (const String &string1, const String &string2) noexcept
bool	operator<= (const String &string1, const String &string2) noexcept
template<class traits>
std::basic_ostream< char, traits > &	operator<< (std::basic_ostream< char, traits > &stream, const String &stringToWrite)
OutputStream &	operator<< (OutputStream &stream, const String &stringToWrite)
OutputStream &	operator<< (OutputStream &stream, StringRef stringToWrite)
bool	operator== (const String &string1, StringRef string2) noexcept
bool	operator!= (const String &string1, StringRef string2) noexcept
String	operator+ (String s1, StringRef s2)
String	operator+ (StringRef s1, const String &s2)
String	operator+ (const char *s1, StringRef s2)
String	operator+ (StringRef s1, const char *s2)

Typedef Documentation

int16

typedef signed short juce::pnglibNamespace::water::int16

A platform-independent 16-bit signed integer type.

int32

typedef signed int juce::pnglibNamespace::water::int32

A platform-independent 32-bit signed integer type.

int64

typedef long long juce::pnglibNamespace::water::int64

A platform-independent 64-bit integer type.

int8

typedef signed char juce::pnglibNamespace::water::int8

A platform-independent 8-bit signed integer type.

pointer_sized_int

typedef int juce::pnglibNamespace::water::pointer_sized_int

A signed integer type that's guaranteed to be large enough to hold a pointer without truncating it.

pointer_sized_uint

typedef unsigned int juce::pnglibNamespace::water::pointer_sized_uint

An unsigned integer type that's guaranteed to be large enough to hold a pointer without truncating it.

uint16

typedef unsigned short juce::pnglibNamespace::water::uint16

A platform-independent 16-bit unsigned integer type.

uint32

typedef unsigned int juce::pnglibNamespace::water::uint32

A platform-independent 32-bit unsigned integer type.

uint64

typedef unsigned long long juce::pnglibNamespace::water::uint64

A platform-independent 64-bit unsigned integer type.

uint8

typedef unsigned char juce::pnglibNamespace::water::uint8

A platform-independent 8-bit unsigned integer type.

water_uchar

typedef uint32 juce::pnglibNamespace::water::water_uchar

A platform-independent 32-bit unicode character type.

Function Documentation

addBytesToPointer()

template<typename Type, typename IntegerType>

Type * juce::pnglibNamespace::water::addBytesToPointer ( Type * basePointer, IntegerType bytes )

inlinenoexcept

A handy function which adds a number of bytes to any type of pointer and returns the result. This can be useful to avoid casting pointers to a char* and back when you want to move them by a specific number of bytes,

createCopyIfNotNull()

template<class Type>

Type * juce::pnglibNamespace::water::createCopyIfNotNull ( const Type * objectToCopy )

inline

If a pointer is non-null, this returns a new copy of the object that it points to, or safely returns nullptr if the pointer is null.

deleteAndZero()

template<typename Type>

void juce::pnglibNamespace::water::deleteAndZero ( Type & pointer )

inline

Delete an object pointer, and sets the pointer to null.

Remember that it's not good c++ practice to use delete directly - always try to use a ScopedPointer or other automatic lifetime-management system rather than resorting to deleting raw pointers!

getAddressDifference()

template<typename Type1, typename Type2>

int juce::pnglibNamespace::water::getAddressDifference ( Type1 * pointer1, Type2 * pointer2 )

inlinenoexcept

A handy function which returns the difference between any two pointers, in bytes. The address of the second pointer is subtracted from the first, and the difference in bytes is returned.

operator!=() [1/4]

bool juce::pnglibNamespace::water::operator!= ( const String & string1, const char * string2 )

noexcept

Case-sensitive comparison of two strings.

operator!=() [2/4]

bool juce::pnglibNamespace::water::operator!= ( const String & string1, const CharPointer_UTF8 string2 )

noexcept

Case-sensitive comparison of two strings.

operator!=() [3/4]

bool juce::pnglibNamespace::water::operator!= ( const String & string1, const String & string2 )

noexcept

Case-sensitive comparison of two strings.

operator!=() [4/4]

bool juce::pnglibNamespace::water::operator!= ( const String & string1, StringRef string2 )

noexcept

Case-sensitive comparison of two strings.

operator+() [1/11]

String juce::pnglibNamespace::water::operator+	(	char	string1,
		const String &	string2 )

Concatenates two strings.

operator+() [2/11]

String juce::pnglibNamespace::water::operator+ ( const char * s1, StringRef s2 )

inline

operator+() [3/11]

String juce::pnglibNamespace::water::operator+	(	const char *	string1,
		const String &	string2 )

Concatenates two strings.

operator+() [4/11]

String juce::pnglibNamespace::water::operator+ ( String s1, StringRef s2 )

inline

operator+() [5/11]

String juce::pnglibNamespace::water::operator+	(	String	string1,
		char	characterToAppend )

Concatenates two strings.

operator+() [6/11]

String juce::pnglibNamespace::water::operator+	(	String	string1,
		const char *	string2 )

Concatenates two strings.

operator+() [7/11]

String juce::pnglibNamespace::water::operator+	(	String	string1,
		const String &	string2 )

Concatenates two strings.

operator+() [8/11]

String juce::pnglibNamespace::water::operator+	(	String	string1,
		water_uchar	characterToAppend )

Concatenates two strings.

operator+() [9/11]

String juce::pnglibNamespace::water::operator+ ( StringRef s1, const char * s2 )

inline

operator+() [10/11]

String juce::pnglibNamespace::water::operator+ ( StringRef s1, const String & s2 )

inline

operator+() [11/11]

String juce::pnglibNamespace::water::operator+	(	water_uchar	string1,
		const String &	string2 )

Concatenates two strings.

operator<()

bool juce::pnglibNamespace::water::operator< ( const String & string1, const String & string2 )

noexcept

Case-sensitive comparison of two strings.

operator<<() [1/15]

OutputStream & juce::pnglibNamespace::water::operator<<	(	OutputStream &	stream,
		const String &	stringToWrite )

Writes a string to an OutputStream as UTF8.

operator<<() [2/15]

OutputStream & juce::pnglibNamespace::water::operator<<	(	OutputStream &	stream,
		StringRef	stringToWrite )

Writes a string to an OutputStream as UTF8.

operator<<() [3/15]

template<class traits>

std::basic_ostream< char, traits > & juce::pnglibNamespace::water::operator<<	(	std::basic_ostream< char, traits > &	stream,
		const String &	stringToWrite )

This operator allows you to write a water String directly to std output streams. This is handy for writing strings to std::cout, std::cerr, etc.

operator<<() [4/15]

String & juce::pnglibNamespace::water::operator<<	(	String &	string1,
		char	characterToAppend )

Appends a character at the end of a string.

operator<<() [5/15]

String & juce::pnglibNamespace::water::operator<<	(	String &	string1,
		const char *	string2 )

Appends a string to the end of the first one.

operator<<() [6/15]

String & juce::pnglibNamespace::water::operator<<	(	String &	string1,
		const String &	string2 )

Appends a string to the end of the first one.

operator<<() [7/15]

String & juce::pnglibNamespace::water::operator<<	(	String &	string1,
		double	number )

Appends a decimal number at the end of a string.

operator<<() [8/15]

String & juce::pnglibNamespace::water::operator<<	(	String &	string1,
		float	number )

Appends a decimal number at the end of a string.

operator<<() [9/15]

String & juce::pnglibNamespace::water::operator<<	(	String &	string1,
		int	number )

Appends a decimal number at the end of a string.

operator<<() [10/15]

String & juce::pnglibNamespace::water::operator<<	(	String &	string1,
		int64	number )

Appends a decimal number at the end of a string.

operator<<() [11/15]

String & juce::pnglibNamespace::water::operator<<	(	String &	string1,
		long	number )

Appends a decimal number at the end of a string.

operator<<() [12/15]

String & juce::pnglibNamespace::water::operator<<	(	String &	string1,
		short	number )

Appends a decimal number at the end of a string.

operator<<() [13/15]

String & juce::pnglibNamespace::water::operator<<	(	String &	string1,
		StringRef	string2 )

Appends a string to the end of the first one.

operator<<() [14/15]

String & juce::pnglibNamespace::water::operator<<	(	String &	string1,
		uint64	number )

Appends a decimal number at the end of a string.

operator<<() [15/15]

String & juce::pnglibNamespace::water::operator<<	(	String &	string1,
		water_uchar	characterToAppend )

Appends a character at the end of a string.

operator<=()

bool juce::pnglibNamespace::water::operator<= ( const String & string1, const String & string2 )

noexcept

Case-sensitive comparison of two strings.

operator==() [1/4]

bool juce::pnglibNamespace::water::operator== ( const String & string1, const char * string2 )

noexcept

Case-sensitive comparison of two strings.

operator==() [2/4]

bool juce::pnglibNamespace::water::operator== ( const String & string1, const CharPointer_UTF8 string2 )

noexcept

Case-sensitive comparison of two strings.

operator==() [3/4]

bool juce::pnglibNamespace::water::operator== ( const String & string1, const String & string2 )

noexcept

Case-sensitive comparison of two strings.

operator==() [4/4]

bool juce::pnglibNamespace::water::operator== ( const String & string1, StringRef string2 )

noexcept

Case-sensitive comparison of two strings.

operator>()

bool juce::pnglibNamespace::water::operator> ( const String & string1, const String & string2 )

noexcept

Case-sensitive comparison of two strings.

operator>=()

bool juce::pnglibNamespace::water::operator>= ( const String & string1, const String & string2 )

noexcept

Case-sensitive comparison of two strings.

readUnaligned()

template<typename Type>

Type juce::pnglibNamespace::water::readUnaligned ( const void * srcPtr )

inlinenoexcept

A handy function to read un-aligned memory without a performance penalty or bus-error.

writeUnaligned()

template<typename Type>

void juce::pnglibNamespace::water::writeUnaligned ( void * dstPtr, Type value )

inlinenoexcept

A handy function to write un-aligned memory without a performance penalty or bus-error.

zeromem()

void juce::pnglibNamespace::water::zeromem ( void * memory, size_t numBytes )

inlinenoexcept

Fills a block of memory with zeros.

zerostruct()

template<typename Type>

void juce::pnglibNamespace::water::zerostruct ( Type & structure )

inlinenoexcept

Overwrites a structure or object with zeros.