String.h

Go to the documentation of this file.

/***************************************************************************************************
 
 Zyan Disassembler Library (Zydis)
 
 Original Author : Florian Bernd, Joel Hoener
 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 
***************************************************************************************************/
 
#ifndef ZYDIS_INTERNAL_STRING_H
#define ZYDIS_INTERNAL_STRING_H
 
#include <Zycore/LibC.h>
#include <Zycore/String.h>
#include <Zycore/Types.h>
#include <Zycore/Format.h>
#include <Zydis/ShortString.h>
#include <Zycore/Defines.h>
#include <Zycore/Status.h>
#include <Zycore/Vector.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ============================================================================================== */
/* Enums and types */
/* ============================================================================================== */
 
/* ---------------------------------------------------------------------------------------------- */
/* Letter Case */
/* ---------------------------------------------------------------------------------------------- */
 
typedef enum ZydisLetterCase_
{
 ZYDIS_LETTER_CASE_DEFAULT,
 ZYDIS_LETTER_CASE_LOWER,
 ZYDIS_LETTER_CASE_UPPER,
 
 ZYDIS_LETTER_CASE_MAX_VALUE = ZYDIS_LETTER_CASE_UPPER,
 ZYDIS_LETTER_CASE_REQUIRED_BITS = ZYAN_BITS_TO_REPRESENT(ZYDIS_LETTER_CASE_MAX_VALUE)
} ZydisLetterCase;
 
/* ---------------------------------------------------------------------------------------------- */
 
/* ============================================================================================== */
/* Macros */
/* ============================================================================================== */
 
/* ---------------------------------------------------------------------------------------------- */
/* Internal macros */
/* ---------------------------------------------------------------------------------------------- */
 
#define ZYDIS_STRING_ASSERT_NULLTERMINATION(string) \
 ZYAN_ASSERT(*(char*)((ZyanU8*)(string)->vector.data + (string)->vector.size - 1) == '\0');
 
#define ZYDIS_STRING_NULLTERMINATE(string) \
 *(char*)((ZyanU8*)(string)->vector.data + (string)->vector.size - 1) = '\0';
 
/* ---------------------------------------------------------------------------------------------- */
 
/* ============================================================================================== */
/* Internal Functions */
/* ============================================================================================== */
 
/* ---------------------------------------------------------------------------------------------- */
/* Appending */
/* ---------------------------------------------------------------------------------------------- */
 
ZYAN_INLINE ZyanStatus ZydisStringAppend(ZyanString* destination, const ZyanStringView* source)
{
 ZYAN_ASSERT(destination && source);
 ZYAN_ASSERT(!destination->vector.allocator);
 ZYAN_ASSERT(destination->vector.size && source->string.vector.size);
 
 if (destination->vector.size + source->string.vector.size - 1 > destination->vector.capacity)
 {
 return ZYAN_STATUS_INSUFFICIENT_BUFFER_SIZE;
 }
 
 ZYAN_MEMCPY((char*)destination->vector.data + destination->vector.size - 1,
 source->string.vector.data, source->string.vector.size - 1);
 
 destination->vector.size += source->string.vector.size - 1;
 ZYDIS_STRING_NULLTERMINATE(destination);
 
 return ZYAN_STATUS_SUCCESS;
}
 
ZYAN_INLINE ZyanStatus ZydisStringAppendCase(ZyanString* destination, const ZyanStringView* source,
 ZydisLetterCase letter_case)
{
 ZYAN_ASSERT(destination && source);
 ZYAN_ASSERT(!destination->vector.allocator);
 ZYAN_ASSERT(destination->vector.size && source->string.vector.size);
 
 if (destination->vector.size + source->string.vector.size - 1 > destination->vector.capacity)
 {
 return ZYAN_STATUS_INSUFFICIENT_BUFFER_SIZE;
 }
 
 ZYAN_MEMCPY((char*)destination->vector.data + destination->vector.size - 1,
 source->string.vector.data, source->string.vector.size - 1);
 
 switch (letter_case)
 {
 case ZYDIS_LETTER_CASE_DEFAULT:
 break;
 case ZYDIS_LETTER_CASE_LOWER:
 {
 const ZyanUSize index = destination->vector.size - 1;
 const ZyanUSize count = source->string.vector.size - 1;
 char* s = (char*)destination->vector.data + index;
 for (ZyanUSize i = index; i < index + count; ++i)
 {
 const char c = *s;
 if ((c >= 'A') && (c <= 'Z'))
 {
 *s = c | 32;
 }
 ++s;
 }
 break;
 }
 case ZYDIS_LETTER_CASE_UPPER:
 {
 const ZyanUSize index = destination->vector.size - 1;
 const ZyanUSize count = source->string.vector.size - 1;
 char* s = (char*)destination->vector.data + index;
 for (ZyanUSize i = index; i < index + count; ++i)
 {
 const char c = *s;
 if ((c >= 'a') && (c <= 'z'))
 {
 *s = c & ~32;
 }
 ++s;
 }
 break;
 }
 default:
 ZYAN_UNREACHABLE;
 }
 
 destination->vector.size += source->string.vector.size - 1;
 ZYDIS_STRING_NULLTERMINATE(destination);
 
 return ZYAN_STATUS_SUCCESS;
}
 
ZYAN_INLINE ZyanStatus ZydisStringAppendShort(ZyanString* destination,
 const ZydisShortString* source)
{
 ZYAN_ASSERT(destination && source);
 ZYAN_ASSERT(!destination->vector.allocator);
 ZYAN_ASSERT(destination->vector.size && source->size);
 
 if (destination->vector.size + source->size > destination->vector.capacity)
 {
 return ZYAN_STATUS_INSUFFICIENT_BUFFER_SIZE;
 }
 
 ZYAN_MEMCPY((char*)destination->vector.data + destination->vector.size - 1, source->data,
 (ZyanUSize)source->size + 1);
 
 destination->vector.size += source->size;
 ZYDIS_STRING_ASSERT_NULLTERMINATION(destination);
 
 return ZYAN_STATUS_SUCCESS;
}
 
ZYAN_INLINE ZyanStatus ZydisStringAppendShortCase(ZyanString* destination,
 const ZydisShortString* source, ZydisLetterCase letter_case)
{
 ZYAN_ASSERT(destination && source);
 ZYAN_ASSERT(!destination->vector.allocator);
 ZYAN_ASSERT(destination->vector.size && source->size);
 
 if (destination->vector.size + source->size > destination->vector.capacity)
 {
 return ZYAN_STATUS_INSUFFICIENT_BUFFER_SIZE;
 }
 
 ZYAN_MEMCPY((char*)destination->vector.data + destination->vector.size - 1, source->data,
 (ZyanUSize)source->size + 1);
 
 switch (letter_case)
 {
 case ZYDIS_LETTER_CASE_DEFAULT:
 break;
 case ZYDIS_LETTER_CASE_LOWER:
 {
 const ZyanUSize index = destination->vector.size - 1;
 const ZyanUSize count = source->size;
 char* s = (char*)destination->vector.data + index;
 for (ZyanUSize i = index; i < index + count; ++i)
 {
 const char c = *s;
 if ((c >= 'A') && (c <= 'Z'))
 {
 *s = c | 32;
 }
 ++s;
 }
 break;
 }
 case ZYDIS_LETTER_CASE_UPPER:
 {
 const ZyanUSize index = destination->vector.size - 1;
 const ZyanUSize count = source->size;
 char* s = (char*)destination->vector.data + index;
 for (ZyanUSize i = index; i < index + count; ++i)
 {
 const char c = *s;
 if ((c >= 'a') && (c <= 'z'))
 {
 *s = c & ~32;
 }
 ++s;
 }
 break;
 }
 default:
 ZYAN_UNREACHABLE;
 }
 
 destination->vector.size += source->size;
 ZYDIS_STRING_ASSERT_NULLTERMINATION(destination);
 
 return ZYAN_STATUS_SUCCESS;
}
 
/* ---------------------------------------------------------------------------------------------- */
/* Formatting */
/* ---------------------------------------------------------------------------------------------- */
 
ZyanStatus ZydisStringAppendDecU(ZyanString* string, ZyanU64 value, ZyanU8 padding_length,
 const ZyanStringView* prefix, const ZyanStringView* suffix);
 
ZYAN_INLINE ZyanStatus ZydisStringAppendDecS(ZyanString* string, ZyanI64 value,
 ZyanU8 padding_length, ZyanBool force_sign, const ZyanStringView* prefix,
 const ZyanStringView* suffix)
{
 static const ZydisShortString str_add = ZYDIS_MAKE_SHORTSTRING("+");
 static const ZydisShortString str_sub = ZYDIS_MAKE_SHORTSTRING("-");
 
 if (value < 0)
 {
 ZYAN_CHECK(ZydisStringAppendShort(string, &str_sub));
 if (prefix)
 {
 ZYAN_CHECK(ZydisStringAppend(string, prefix));
 }
 return ZydisStringAppendDecU(string, ZyanAbsI64(value), padding_length,
 (const ZyanStringView*)ZYAN_NULL, suffix);
 }
 
 if (force_sign)
 {
 ZYAN_ASSERT(value >= 0);
 ZYAN_CHECK(ZydisStringAppendShort(string, &str_add));
 }
 return ZydisStringAppendDecU(string, value, padding_length, prefix, suffix);
}
 
ZyanStatus ZydisStringAppendHexU(ZyanString* string, ZyanU64 value, ZyanU8 padding_length,
 ZyanBool force_leading_number, ZyanBool uppercase, const ZyanStringView* prefix,
 const ZyanStringView* suffix);
 
ZYAN_INLINE ZyanStatus ZydisStringAppendHexS(ZyanString* string, ZyanI64 value,
 ZyanU8 padding_length, ZyanBool force_leading_number, ZyanBool uppercase, ZyanBool force_sign,
 const ZyanStringView* prefix, const ZyanStringView* suffix)
{
 static const ZydisShortString str_add = ZYDIS_MAKE_SHORTSTRING("+");
 static const ZydisShortString str_sub = ZYDIS_MAKE_SHORTSTRING("-");
 
 if (value < 0)
 {
 ZYAN_CHECK(ZydisStringAppendShort(string, &str_sub));
 if (prefix)
 {
 ZYAN_CHECK(ZydisStringAppend(string, prefix));
 }
 return ZydisStringAppendHexU(string, ZyanAbsI64(value), padding_length,
 force_leading_number, uppercase, (const ZyanStringView*)ZYAN_NULL, suffix);
 }
 
 if (force_sign)
 {
 ZYAN_ASSERT(value >= 0);
 ZYAN_CHECK(ZydisStringAppendShort(string, &str_add));
 }
 return ZydisStringAppendHexU(string, value, padding_length, force_leading_number, uppercase,
 prefix, suffix);
}
 
/* ---------------------------------------------------------------------------------------------- */
 
/* ============================================================================================== */
 
#ifdef __cplusplus
}
#endif
 
#endif // ZYDIS_INTERNAL_STRING_H