ezEngine  Milestone 9
ezConversionUtils Namespace Reference

This namespace contains functions to convert between different types. More...

Functions

EZ_FOUNDATION_DLL ezResult StringToInt (const char *szString, ezInt32 &out_Res, const char **out_LastParsePosition=nullptr)
 Parses szString and converts it to an integer value. Returns EZ_FAILURE if the string contains no parsable integer value. More...
 
EZ_FOUNDATION_DLL ezResult StringToInt64 (const char *szString, ezInt64 &out_Res, const char **out_LastParsePosition=nullptr)
 Same as StringToInt but converts to a 64bit integer value instead.
 
EZ_FOUNDATION_DLL ezResult StringToFloat (const char *szString, double &out_Res, const char **out_LastParsePosition=nullptr)
 Parses szString and converts it to a double value. Returns EZ_FAILURE if the string contains no parseable floating point value. More...
 
EZ_FOUNDATION_DLL ezResult StringToBool (const char *szString, bool &out_Res, const char **out_LastParsePosition=nullptr)
 Parses szString and checks that the first word it finds starts with a phrase that can be interpreted as a boolean value. More...
 
EZ_FOUNDATION_DLL ezUInt32 ExtractFloatsFromString (const char *szText, ezUInt32 uiNumFloats, float *out_pFloats, const char **out_LastParsePosition=nullptr)
 Parses szText and tries to find up to uiNumFloats float values to extract. Skips all characters that cannot be interpreted as numbers. More...
 
EZ_FOUNDATION_DLL ezInt8 HexCharacterToIntValue (char Character)
 Converts a hex character ('0', '1', ... '9', 'A'/'a', ... 'F'/'f') to the corresponding int value 0 - 15. More...
 
EZ_FOUNDATION_DLL ezUInt32 ConvertHexStringToUInt32 (const char *szHEX)
 Converts a hex string (i.e. 0xAABBCCDD) into its uint32 value.
 
EZ_FOUNDATION_DLL void ConvertHexToBinary (const char *szHEX, ezUInt8 *pBinary, ezUInt32 uiBinaryBuffer)
 Converts a HEX string to a binary value. More...
 
template<typename APPEND_CONTAINER_LAMBDA >
void ConvertBinaryToHex (const void *pBinaryData, ezUInt32 uiBytes, APPEND_CONTAINER_LAMBDA append)
 Converts a binary stream to a HEX string. More...
 
EZ_FOUNDATION_DLL ezUuid ConvertStringToUuid (const char *szUuidString)
 Converts a string that was written with ezConversionUtils::ToString(ezUuid) back to an ezUuid object.
 
EZ_FOUNDATION_DLL bool IsStringUuid (const char *szText)
 Returns true when the given string is in the exact format "{ 05af8d07-0b38-44a6-8d50-49731ae2625d }" This includes braces, whitespaces and dashes. This is the format that ToString produces.
 
EZ_ALWAYS_INLINE const ezStringBuilderToString (bool value, ezStringBuilder &out_Result)
 Converts a bool to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (ezInt8 value, ezStringBuilder &out_Result)
 Converts a 8bit signed integer to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (ezUInt8 value, ezStringBuilder &out_Result)
 Converts a 8bit unsigned integer to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (ezInt16 value, ezStringBuilder &out_Result)
 Converts a 16bit signed integer to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (ezUInt16 value, ezStringBuilder &out_Result)
 Converts a 16bit unsigned integer to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (ezInt32 value, ezStringBuilder &out_Result)
 Converts a 32bit signed integer to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (ezUInt32 value, ezStringBuilder &out_Result)
 Converts a 32bit unsigned integer to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (ezInt64 value, ezStringBuilder &out_Result)
 Converts a 64bit signed integer to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (ezUInt64 value, ezStringBuilder &out_Result)
 Converts a 64bit unsigned integer to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (float value, ezStringBuilder &out_Result)
 Converts a float to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (double value, ezStringBuilder &out_Result)
 Converts a double to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (const ezColor &value, ezStringBuilder &out_Result)
 Converts a color to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (const ezColorGammaUB &value, ezStringBuilder &out_Result)
 Converts a color to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (const ezVec2 &value, ezStringBuilder &out_Result)
 Converts a vec2 to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (const ezVec3 &value, ezStringBuilder &out_Result)
 Converts a vec3 to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (const ezVec4 &value, ezStringBuilder &out_Result)
 Converts a vec4 to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (const ezVec2I32 &value, ezStringBuilder &out_Result)
 Converts a vec2I32 to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (const ezVec3I32 &value, ezStringBuilder &out_Result)
 Converts a vec3I32 to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (const ezVec4I32 &value, ezStringBuilder &out_Result)
 Converts a vec4I32 to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (const ezQuat &value, ezStringBuilder &out_Result)
 Converts a quat to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (const ezMat3 &value, ezStringBuilder &out_Result)
 Converts a mat3 to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (const ezMat4 &value, ezStringBuilder &out_Result)
 Converts a mat4 to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (const ezTransform &value, ezStringBuilder &out_Result)
 Converts a transform to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (const ezUuid &value, ezStringBuilder &out_Result)
 Converts a Uuid to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (const ezStringView &value, ezStringBuilder &out_Result)
 Converts a ezStringView to a string.
 
EZ_FOUNDATION_DLL const ezStringBuilderToString (const ezDynamicArray< ezVariant, ezDefaultAllocatorWrapper > &value, ezStringBuilder &out_Result)
 Converts a ezVariantArray to a string.
 
template<typename T >
EZ_ALWAYS_INLINE const ezStringBuilderToString (const T &value, ezStringBuilder &out_Result)
 Fallback ToString implementation for all types that don't have one.
 
EZ_FOUNDATION_DLL ezColor GetColorByName (const char *szColorName, bool *out_ValidColorName=nullptr)
 Returns the color with the given name. More...
 
EZ_FOUNDATION_DLL ezString GetColorName (const ezColor &col)
 The inverse of GetColorByName.
 
const ezStringBuilderToString (const ezDynamicArray< ezVariant > &value, ezStringBuilder &out_Result)
 

Detailed Description

This namespace contains functions to convert between different types.

Contains helper functions to convert from strings to numerical values. To convert from numerical values to strings, use ezStringBuilder::Format, which provides a rich set of formatting options.

Function Documentation

◆ ConvertBinaryToHex()

template<typename APPEND_CONTAINER_LAMBDA >
void ezConversionUtils::ConvertBinaryToHex ( const void *  pBinaryData,
ezUInt32  uiBytes,
APPEND_CONTAINER_LAMBDA  append 
)
inline

Converts a binary stream to a HEX string.

The result is returned by calling a lambda to append to an output container. The lambda signature must be: void Append(const char* twoChars) The given string will contain exactly two characters and will be zero terminated.

◆ ConvertHexToBinary()

void ezConversionUtils::ConvertHexToBinary ( const char *  szHEX,
ezUInt8 *  pBinary,
ezUInt32  uiBinaryBuffer 
)

Converts a HEX string to a binary value.

"0x" or "0X" at the start is allowed and will be skipped. A maximum of uiBinaryBuffer bytes is written to pBinary. If the string contains fewer HEX values than fit into pBinary, the remaining bytes will not be touched, so make sure all data is properly initialized! The hex values are read 2 characters at a time to form a single byte value. If at the end a single character is left (so an odd number of characters in total) that character is ignored entirely! Values are started to be written at pBinary and then the pointer is increased, so the first values in szHEX represent to least significant bytes in pBinary.

Note
This function does not validate that the incoming string is actually valid HEX. If an invalid character is used, the result will be invalid and there is no error reported.

◆ ExtractFloatsFromString()

ezUInt32 ezConversionUtils::ExtractFloatsFromString ( const char *  szText,
ezUInt32  uiNumFloats,
float *  out_pFloats,
const char **  out_LastParsePosition = nullptr 
)

Parses szText and tries to find up to uiNumFloats float values to extract. Skips all characters that cannot be interpreted as numbers.

This function can be used to convert string representations of vectors or other more complex numbers. It will parse the string from front to back and convert anything that looks like a number and add it to the given float array. For example a text like '(1, 2, 3)' will result in up to three floats. Since any invalid character is skipped, the parenthesis and commas will be ignored (though they act as delimiters, of course).

Parameters
szTextThe null terminated string to parse.
uiNumFloatsThe maximum number of floats to extract.
out_pFloatsAn array of floats that can hold at least uiNumFloats. The results are written to this array.
out_LastParsePositionThe position in szText where the function stopped parsing. It will stop either because the end of the string was reached, or uiNumFloats values were successfully extracted.
Returns
The number of successfully extracted values (and thus valid values in out_pFloats).

◆ GetColorByName()

ezColor ezConversionUtils::GetColorByName ( const char *  szColorName,
bool *  out_ValidColorName = nullptr 
)

Returns the color with the given name.

Allowed are all predefined color names (case-insensitive), as well as Hex-Values in the form '#RRGGBB' and '#RRGGBBAA' If out_ValidColorName is a valid pointer, it contains true if the color name was known, otherwise false

◆ HexCharacterToIntValue()

ezInt8 ezConversionUtils::HexCharacterToIntValue ( char  Character)

Converts a hex character ('0', '1', ... '9', 'A'/'a', ... 'F'/'f') to the corresponding int value 0 - 15.

Note
Returns -1 for invalid HEX characters.

◆ StringToBool()

ezResult ezConversionUtils::StringToBool ( const char *  szString,
bool &  out_Res,
const char **  out_LastParsePosition = nullptr 
)

Parses szString and checks that the first word it finds starts with a phrase that can be interpreted as a boolean value.

Parameters
szStringIf szString starts with whitespace characters, they are skipped. EZ_SUCCESS is returned (and out_Res is filled with true/false), if the string then starts with any of the following phrases: "true", "false", "on", "off", "yes", "no", "1", "0", "enable", "disable". EZ_FAILURE is returned if none of those is encountered (or the string is empty). It does not matter, whether the string continues with some other text, e.g. "nolf" is still interpreted as "no". That means you can pass strings such as "true, a = false" into this function to just parse the next piece of a command line.
out_ResIf EZ_SUCCESS is returned, out_Res contains a valid value. Otherwise it is not modified. That means you can initialize it with a default value that can be used even if EZ_FAILURE is returned.
out_LastParsePositionOn success out_LastParsePosition will contain the address of the character in szString that stopped the parser. This might point to the zero terminator of szString, or to the next character after the phrase "true", "false", "on", "off", etc. which was interpreted as a boolean value. If you want to parse strictly (e.g. you do not want to parse "Nolf" as "no") you can use this result to check that only certain characters were encountered after the boolean phrase (such as '\0' or ',' etc.).
Returns
EZ_SUCCESS if any phrase was encountered that can be interpreted as a boolean value. EZ_FAILURE otherwise.

◆ StringToFloat()

ezResult ezConversionUtils::StringToFloat ( const char *  szString,
double &  out_Res,
const char **  out_LastParsePosition = nullptr 
)

Parses szString and converts it to a double value. Returns EZ_FAILURE if the string contains no parseable floating point value.

Parameters
szStringIf szString is nullptr or an empty string or starts with some non-whitespace and non-sign character, EZ_FAILURE is returned. All whitespace at the start of the string are skipped. Each minus sign flips the sign of the output value, so –3 will return 3. Plus signs are skipped and have no effect, so -+3 will still return -3. The value string may contain one '.' to separate integer and fractional part. It may also contain an 'e' for scientific notation followed by an integer exponent value. No '.' may follow after an 'e' anymore. Additionally the value may be terminated by an 'f' to indicate a floating point value. The 'f' will be skipped (as can be observed through out_LastParsePosition, and it will terminate further parsing, but it will not affect the precision of the result. Commas (',') are never treated as fractional part separators (as in the German locale).
out_ResIf EZ_SUCCESS is returned, out_Res will contain the result. Otherwise it stays unmodified. The result may have rounding errors, i.e. even though a double may be able to represent the string value exactly, there is no guarantee that out_Res will be 100% identical. If that is required, use the C lib atof() function.
out_LastParsePositionOn success out_LastParsePosition will contain the address of the character in szString that stopped the parser. This might point to the zero terminator of szString, or to some unexpected character, since for example "5+6" will parse as '5' and '+' will be the position where the parser stopped (returning EZ_SUCCESS). If you want to parse strictly (e.g. you do not want to parse "5+6" as "5") you can use this result to check that only certain characters were encountered after the float (e.g. only '\0' or ',').
Returns
EZ_SUCCESS if any text was encountered that can be interpreted as a floating point value. EZ_FAILURE otherwise.
Note
The difference to the C lib atof() function is that this function properly returns whether something could get parsed as a floating point value, at all. atof() just returns zero in such a case. Also the way whitespace and signs at the beginning of the string are handled is different and StringToFloat will return 'success' if it finds anything that can be parsed as a float, even if the string continues with invalid text. So you can parse "2.54f+3.5" as "2.54f" and out_LastParsePosition will tell you where the parser stopped. On the down-side StringToFloat() is probably not as precise as atof(), because of a very simplistic conversion algorithm. If you require the features of StringToFloat() and the precision of atof(), you can let StringToFloat() handle the cases for detecting the validity, the sign and where the value ends and then use atof to parse only that substring with maximum precision.

◆ StringToInt()

ezResult ezConversionUtils::StringToInt ( const char *  szString,
ezInt32 &  out_Res,
const char **  out_LastParsePosition = nullptr 
)

Parses szString and converts it to an integer value. Returns EZ_FAILURE if the string contains no parsable integer value.

Parameters
szStringIf szString is nullptr or an empty string or starts with an some non-whitespace and non-sign character, EZ_FAILURE is returned. All whitespace at the start of the string are skipped. Each minus sign flips the sign of the output value, so –3 will return 3. Plus signs are skipped and have no effect, so -+3 will still return -3.
out_ResThe parsed value is returned in out_Res on success. On failure out_Res is not modified at all, so you can store a default value in it, before calling StringToInt() and always use that value, even without checking for success or failure.
out_LastParsePositionOn success out_LastParsePosition will contain the address of the character in szString that stopped the parser. This might point to the zero terminator of szString, or to some non-digit character, since for example "5+6" will parse as '5' and '+' will be the position where the parser stopped (returning EZ_SUCCESS). If szString is supposed to only contain one full integer and nothing else, then out_LastParsePosition should always point to a zero terminator (otherwise the string was malformed).
Returns
EZ_SUCCESS if any integer value could get properly extracted from szString (including 0). This includes that only some part of the string was parsed until a non-digit character was encountered. EZ_FAILURE if the string starts with something that can not be interpreted as an integer.