string_type.h

Go to the documentation of this file.

/*!**********************************************************************
*
* @copyright Copyright (C) 2016 Siemens Aktiengesellschaft.\n
*            All rights reserved.
*
*************************************************************************
*
* @file     string_type.h
* @date     Aug 2, 2016
* @brief    String type module header file.
*
* This module introduces #string_t type which holds the C string inside along with length information.
* Operations that can be performed on this type are also defined in this module.
*
************************************************************************/

#ifndef STRING_TYPE_H_
#define STRING_TYPE_H_

#include "list.h"
#include "string_util.h"

extern const char *hex_table;

typedef enum E_MCL_STRING_TYPE
{
    MCL_STRING_COPY_DESTROY, 
    MCL_STRING_NOT_COPY_DESTROY, 
    MCL_STRING_NOT_COPY_NOT_DESTROY 
} E_MCL_STRING_TYPE;

typedef struct string_t
{
    char *buffer;           
    mcl_size_t length;      
    E_MCL_STRING_TYPE type; 
} string_t;

E_MCL_ERROR_CODE string_initialize(const string_t *other, string_t **string);

E_MCL_ERROR_CODE string_initialize_new(const char *value, mcl_size_t value_length, string_t **string);

E_MCL_ERROR_CODE string_initialize_dynamic(const char *value, mcl_size_t value_length, string_t **string);

E_MCL_ERROR_CODE string_initialize_static(const char *value, mcl_size_t value_length, string_t **string);

E_MCL_ERROR_CODE string_set(string_t *string, const char *value, mcl_size_t value_length);

E_MCL_ERROR_CODE string_compare(const string_t *string, const string_t *other);

E_MCL_ERROR_CODE string_compare_with_cstr(const string_t *string, const char *other);

E_MCL_ERROR_CODE string_split(string_t *string, const char token, list_t **string_list);

E_MCL_ERROR_CODE string_convert_binary_to_hex(const mcl_uint8_t *buffer, mcl_size_t buffer_size, string_t **hex_data);

void string_release(string_t *string);

void string_destroy(string_t **string);

E_MCL_ERROR_CODE string_concatenate_cstr(string_t *string, char *c_string, string_t **result);

E_MCL_ERROR_CODE string_concatenate(string_t *string_1, string_t *string_2, string_t **result);

E_MCL_ERROR_CODE string_replace(string_t *source, const char *old_string, const char *new_string, string_t **result);

#endif //STRING_TYPE_H_