string_util.h
Go to the documentation of this file.
1 /*!**********************************************************************
2 *
3 * @copyright Copyright (C) 2016 Siemens Aktiengesellschaft.\n
4 * All rights reserved.
5 *
6 *************************************************************************
7 *
8 * @file string_util.h
9 * @date Aug 12, 2016
10 * @brief String utility module implementation file.
11 *
12 * This module implements utility functions for basic string operations.
13 *
14 ************************************************************************/
15 
16 #ifndef STRING_UTIL_H_
17 #define STRING_UTIL_H_
18 
19 #include "mcl/mcl_common.h"
20 
27 mcl_size_t string_util_strlen(const char *buffer);
28 
36 mcl_size_t string_util_strnlen(const char *buffer, mcl_size_t maximum_length);
37 
45 void string_util_strncpy(char *destination, const char *source, mcl_size_t count);
46 
54 void string_util_strncat(char *destination, const char *source, mcl_size_t count);
55 
68 E_MCL_ERROR_CODE string_util_strncmp(const char *string_1, const char *string_2, mcl_size_t count);
69 
82 E_MCL_ERROR_CODE string_util_snprintf(char *string, mcl_size_t length, const char *format, ...);
83 
96 mcl_bool_t string_util_memcmp(const void *block_1, const void *block_2, mcl_size_t count);
97 
105 void string_util_memcpy(void *destination, const void *source, mcl_size_t count);
106 
113 char *string_util_strdup(const char *string);
114 
123 mcl_bool_t string_util_find(const char *source, const char *target, mcl_size_t *start_index);
124 
133 mcl_bool_t string_util_find_case_insensitive(const char *source, const char *target, mcl_size_t *start_index);
134 
141 mcl_bool_t string_util_is_space(char character);
142 
151 long string_util_strtol(const char *source, int base, char **end_pointer);
152 
153 #endif //STRING_UTIL_H_
Common module interface header file.
mcl_size_t string_util_strnlen(const char *buffer, mcl_size_t maximum_length)
Standard library strnlen wrapper.
Definition: string_util.c:34
void string_util_strncpy(char *destination, const char *source, mcl_size_t count)
Standard library strncpy wrapper. Also sets the terminating null char at the end if source is not lon...
Definition: string_util.c:48
E_MCL_ERROR_CODE
MCL Error code definitions. Every function returning an error code uses this enum values...
Definition: mcl_common.h:137
void string_util_strncat(char *destination, const char *source, mcl_size_t count)
Standard library strncat wrapper.
Definition: string_util.c:61
E_MCL_ERROR_CODE string_util_strncmp(const char *string_1, const char *string_2, mcl_size_t count)
Standard library strncmp wrapper.
Definition: string_util.c:74
mcl_bool_t string_util_find(const char *source, const char *target, mcl_size_t *start_index)
Finds the first occurence of target in source and puts it's first index to start_index.
Definition: string_util.c:156
long string_util_strtol(const char *source, int base, char **end_pointer)
Returns the first occurrence of an integral value in source string.
Definition: string_util.c:232
mcl_size_t string_util_strlen(const char *buffer)
Standard library strlen wrapper.
Definition: string_util.c:24
mcl_bool_t string_util_find_case_insensitive(const char *source, const char *target, mcl_size_t *start_index)
Finds the first occurence of target in source and puts it's first index to start_index.
Definition: string_util.c:189
mcl_bool_t string_util_is_space(char character)
Checks if a character is whitespace.
Definition: string_util.c:222
size_t mcl_size_t
Definition: mcl_common.h:38
mcl_uint8_t mcl_bool_t
Definition: mcl_common.h:47
char * string_util_strdup(const char *string)
Standard library strdup wrapper.
Definition: string_util.c:140
mcl_bool_t string_util_memcmp(const void *block_1, const void *block_2, mcl_size_t count)
Standard library memcmp wrapper.
Definition: string_util.c:121
void string_util_memcpy(void *destination, const void *source, mcl_size_t count)
Standard library memcpy wrapper.
Definition: string_util.c:131
E_MCL_ERROR_CODE string_util_snprintf(char *string, mcl_size_t length, const char *format,...)
Standard library snprintf wrapper.
Definition: string_util.c:95