String.h

Go to the documentation of this file.

/***************************************************************************************************
 
  Zyan Disassembler Library (Zydis)
 
  Original Author : Florian Bernd, Joel H�ner
 
 * 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_STRING_H
#define ZYDIS_STRING_H
 
#include <Zydis/CommonTypes.h>
#include <Zydis/Status.h>
#include <Zydis/Internal/LibC.h>
 
/* ============================================================================================== */
/* Enums and types                                                                                */
/* ============================================================================================== */
 
/* ---------------------------------------------------------------------------------------------- */
/* String                                                                                         */
/* ---------------------------------------------------------------------------------------------- */
 
typedef struct ZydisString_ 
{
    char *buffer;
    ZydisUSize length;
    ZydisUSize capacity;
} ZydisString;
 
/* ---------------------------------------------------------------------------------------------- */
/* Static string                                                                                  */
/* ---------------------------------------------------------------------------------------------- */
 
#pragma pack(push, 1)
 
typedef struct ZydisStaticString_
{
    const char* buffer;
    ZydisU8 length;
} ZydisStaticString;
 
#pragma pack(pop)
 
/* ---------------------------------------------------------------------------------------------- */
/* Letter Case                                                                                    */
/* ---------------------------------------------------------------------------------------------- */
 
typedef ZydisU8 ZydisLetterCase;
 
enum ZydisLetterCases
{
    ZYDIS_LETTER_CASE_DEFAULT,
    ZYDIS_LETTER_CASE_LOWER,
    ZYDIS_LETTER_CASE_UPPER,
 
    ZYDIS_LETTER_CASE_MAX_VALUE = ZYDIS_LETTER_CASE_UPPER
};
 
/* ---------------------------------------------------------------------------------------------- */
 
/* ============================================================================================== */
/* Macros                                                                                         */
/* ============================================================================================== */
 
/* ---------------------------------------------------------------------------------------------- */
/* Helper Macros                                                                                  */
/* ---------------------------------------------------------------------------------------------- */
 
#define ZYDIS_MAKE_STRING(string) \
    { (char*)string, sizeof(string) - 1, sizeof(string) - 1 }
 
#define ZYDIS_MAKE_STATIC_STRING(string) \
    { string, sizeof(string) - 1 }
 
/* ---------------------------------------------------------------------------------------------- */
 
/* ============================================================================================== */
/* Functions                                                                                      */
/* ============================================================================================== */
 
/* ---------------------------------------------------------------------------------------------- */
/* Basic Operations                                                                               */
/* ---------------------------------------------------------------------------------------------- */
 
ZYDIS_NO_EXPORT ZYDIS_INLINE ZydisStatus ZydisStringInit(ZydisString* string, char* value)
{
    if (!string || !value)
    {
        return ZYDIS_STATUS_INVALID_PARAMETER;
    }
 
    const ZydisUSize length = ZydisStrLen(value);
    string->buffer   = value;
    string->length   = length;
    string->capacity = length; 
    
    return ZYDIS_STATUS_SUCCESS;
}
 
ZYDIS_NO_EXPORT ZYDIS_INLINE ZydisStatus ZydisStringFinalize(ZydisString* string)
{
    if (!string)
    {
        return ZYDIS_STATUS_INVALID_PARAMETER;
    }
    if (string->length >= string->capacity)
    {
        return ZYDIS_STATUS_INSUFFICIENT_BUFFER_SIZE;
    }
 
    string->buffer[string->length] = 0;
    return ZYDIS_STATUS_SUCCESS;
}
 
/* ---------------------------------------------------------------------------------------------- */
 
ZYDIS_NO_EXPORT ZydisStatus ZydisStringAppendEx(ZydisString* string, const ZydisString* text,
    ZydisLetterCase letterCase);
 
ZYDIS_NO_EXPORT ZYDIS_INLINE ZydisStatus ZydisStringAppendExC(ZydisString* string, 
    const char* text, ZydisLetterCase letterCase)
{
    ZydisString other;
    ZYDIS_CHECK(ZydisStringInit(&other, (char*)text));
    
    return ZydisStringAppendEx(string, &other, letterCase);
}
 
ZYDIS_NO_EXPORT ZYDIS_INLINE ZydisStatus ZydisStringAppendExStatic(ZydisString* string, 
    const ZydisStaticString* text, ZydisLetterCase letterCase)
{
    if (!text || !text->buffer)
    {
        return ZYDIS_STATUS_INVALID_PARAMETER;
    }
 
    ZydisString other;
    other.buffer = (char*)text->buffer;
    other.length = text->length;
    
    return ZydisStringAppendEx(string, &other, letterCase);
}
 
ZYDIS_NO_EXPORT ZYDIS_INLINE ZydisStatus ZydisStringAppend(ZydisString* string, 
    const ZydisString* text)
{
    return ZydisStringAppendEx(string, text, ZYDIS_LETTER_CASE_DEFAULT);
}
 
ZYDIS_NO_EXPORT ZYDIS_INLINE ZydisStatus ZydisStringAppendC(ZydisString* string, const char* text)
{
    ZydisString other;
    ZYDIS_CHECK(ZydisStringInit(&other, (char*)text));
    
    return ZydisStringAppendEx(string, &other, ZYDIS_LETTER_CASE_DEFAULT);
}
 
ZYDIS_NO_EXPORT ZYDIS_INLINE ZydisStatus ZydisStringAppendStatic(ZydisString* string, 
    const ZydisStaticString* text, ZydisLetterCase letterCase)
{
    if (!text || !text->buffer)
    {
        return ZYDIS_STATUS_INVALID_PARAMETER;
    }
 
    ZydisString other;
    other.buffer = (char*)text->buffer;
    other.length = text->length;
    
    return ZydisStringAppendEx(string, &other, letterCase);
}
 
/* ---------------------------------------------------------------------------------------------- */
/* Formatting                                                                                     */
/* ---------------------------------------------------------------------------------------------- */
 
ZYDIS_NO_EXPORT ZydisStatus ZydisPrintDecU(ZydisString* string, ZydisU64 value, 
    ZydisU8 paddingLength);
 
ZYDIS_NO_EXPORT ZydisStatus ZydisPrintDecS(ZydisString* string, ZydisI64 value, 
    ZydisU8 paddingLength);
 
ZYDIS_NO_EXPORT ZydisStatus ZydisPrintHexU(ZydisString* string, ZydisU64 value,
    ZydisU8 paddingLength, ZydisBool uppercase, const ZydisString* prefix, 
    const ZydisString* suffix);
 
ZYDIS_NO_EXPORT ZydisStatus ZydisPrintHexS(ZydisString* string, ZydisI64 value, 
    ZydisU8 paddingLength, ZydisBool uppercase, const ZydisString* prefix, 
    const ZydisString* suffix);
 
/* ---------------------------------------------------------------------------------------------- */
 
/* ============================================================================================== */
 
#endif // ZYDIS_STRING_H