dynamic_string.h

/**
 *  @file dynamic_string.h
 *  @author André Dietrich
 *  @date 14 December 2016
 *
 *  @copyright Copyright 2016 André Dietrich. All rights reserved.
 *
 *  @license This project is released under the MIT-License.
 *
 *  @brief Definition of C string manipulation functions.
 *
 *
 */

#ifndef STRING_C_H
#define STRING_C_H

#include "dynamic_types.h"

#include <stdlib.h>

/** @brief Returns the length of an string.                                   */
dyn_ushort dyn_strlen   (dyn_const_str str);
/** @brief Concatenate strings                                                */
void       dyn_strcat   (dyn_str destination, dyn_const_str source);
/** @brief Concatenate strings, required memory is automatically allocated.   */
void       dyn_strcat2  (dyn_str destination, dyn_const_str source);
/** @brief Copy string.                                                       */
void       dyn_strcpy   (dyn_str destination, dyn_const_str source);
/** @brief Integer to ASCII-string conversion.                                */
void       dyn_itoa     (dyn_str str, dyn_int i);

/** @brief Calculates the number of required characters for integer to string
 *         (decimal) conversion, minus increases the value by one.            */
dyn_ushort  dyn_itoa_len (dyn_int i);

/** @brief Float to ASCII-string conversion (decimal).                        */
void       dyn_ftoa     (dyn_str str, const dyn_float f);

/** @brief Calculates the number of required characters for float to string
 *         (decimal) conversion, minus increases the value by one.            */
dyn_ushort dyn_ftoa_len (const dyn_float f);

/** @brief Compares the string a to the string b.                             */
dyn_char    dyn_strcmp   (dyn_const_str a, dyn_const_str b);

#endif