string_array.h

Go to the documentation of this file.

/*!**********************************************************************
*
* @copyright Copyright (C) 2016 Siemens Aktiengesellschaft.\n
*            All rights reserved.
*
*************************************************************************
*
* @file     string_array.h
* @date     Aug 19, 2016
* @brief    String array module header file.
*
* String Array is used to collect different #string_t string objects.
* By #string_array_to_string() function it gives the capability to concatenate the strings.
*
************************************************************************/

#ifndef STRING_ARRAY_H_
#define STRING_ARRAY_H_

#include "string_type.h"

#define DEFAULT_INCREMENT_VALUE 5

typedef struct string_array_item_t
{
    string_t *string;   
    mcl_bool_t destroy; 
} string_array_item_t;

typedef struct string_array_t
{
    string_array_item_t *items; 
    mcl_size_t count;           
    mcl_size_t index;           
    mcl_size_t increment_value; 
    mcl_size_t total_length;    
} string_array_t;

E_MCL_ERROR_CODE string_array_initialize(mcl_size_t count, string_array_t **array);

E_MCL_ERROR_CODE string_array_set_increment(string_array_t *array, mcl_size_t increment_value);

E_MCL_ERROR_CODE string_array_add(string_array_t *array, string_t *string, mcl_bool_t destroy);

E_MCL_ERROR_CODE string_array_set(string_array_t *array, mcl_size_t index, string_t *string);

string_t *string_array_get(string_array_t *array, mcl_size_t index);

string_t *string_array_to_string(string_array_t *array);

void string_array_destroy(string_array_t **array);

#endif //STRING_ARRAY_H_