oc_helpers.h

Go to the documentation of this file.

/*
// Copyright (c) 2016 Intel Corporation
// Copyright (c) 2021 Cascoda Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
*/
#ifndef OC_HELPERS_H
#define OC_HELPERS_H
 
#include "util/oc_list.h"
#include "util/oc_mmem.h"
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct oc_mmem oc_handle_t, oc_string_t, oc_array_t, oc_string_array_t,
  oc_byte_string_array_t;
 
enum StringRepresentation {
  DEC_REPRESENTATION = 0,
  HEX_REPRESENTATION,
};
 
#define oc_cast(block, type) ((type *)(OC_MMEM_PTR(&(block))))
 
#define oc_string(ocstring) (oc_cast(ocstring, char))
 
#define oc_string_checked(ocstring)                                            \
  (oc_cast(ocstring, char) ? oc_cast(ocstring, char) : "NULL")
 
#ifdef OC_MEMORY_TRACE
#define oc_alloc_string(ocstring, size)                                        \
  _oc_alloc_string(__func__, ocstring, size)
#define oc_new_string(ocstring, str, str_len)                                  \
  _oc_new_string(__func__, ocstring, str, str_len)
 
#define oc_free_string(ocstring) _oc_free_string(__func__, ocstring)
#define oc_free_int_array(ocarray) (_oc_free_array(__func__, ocarray, INT_POOL))
#define oc_free_bool_array(ocarray)                                            \
  (_oc_free_array(__func__, ocarray, BYTE_POOL))
#define oc_free_float_array(ocarray)                                           \
  (_oc_free_array(__func__, ocarray, FLOAT_POOL))
#define oc_free_double_array(ocarray)                                          \
  (_oc_free_array(__func__, ocarray, DOUBLE_POOL))
 
#define oc_new_int_array(ocarray, size)                                        \
  (_oc_new_array(__func__, ocarray, size, INT_POOL))
#define oc_new_bool_array(ocarray, size)                                       \
  (_oc_new_array(__func__, ocarray, size, BYTE_POOL))
#define oc_new_float_array(ocarray, size)                                      \
  (_oc_new_array(__func__, ocarray, size, FLOAT_POOL))
#define oc_new_double_array(ocarray, size)                                     \
  (_oc_new_array(__func__, ocarray, size, DOUBLE_POOL))
 
#define oc_new_string_array(ocstringarray, size)                               \
  (_oc_alloc_string_array(__func__, ocstringarray, size))
 
#define oc_free_string_array(ocstringarray)                                    \
  (_oc_free_string(__func__, ocstringarray))
 
#define oc_new_byte_string_array(ocstringarray, size)                          \
  (_oc_alloc_string_array(__func__, ocstringarray, size))
 
#define oc_free_byte_string_array(ocstringarray)                               \
  (__func__, _oc_free_string(ocstringarray))
 
#else /* OC_MEMORY_TRACE */
 
#define oc_alloc_string(ocstring, size) _oc_alloc_string((ocstring), (size))
 
#define oc_new_string(ocstring, str, str_len)                                  \
  _oc_new_string(ocstring, str, str_len)
 
#define oc_new_byte_string(ocstring, str, str_len)                             \
  _oc_new_byte_string(ocstring, str, str_len)
 
#define oc_free_string(ocstring) _oc_free_string(ocstring)
 
#define oc_free_int_array(ocarray) (_oc_free_array(ocarray, INT_POOL))
 
#define oc_free_bool_array(ocarray) (_oc_free_array(ocarray, BYTE_POOL))
 
#define oc_free_float_array(ocarray) (_oc_free_array(ocarray, FLOAT_POOL))
 
#define oc_free_double_array(ocarray) (_oc_free_array(ocarray, DOUBLE_POOL))
 
#define oc_new_int_array(ocarray, size) (_oc_new_array(ocarray, size, INT_POOL))
 
#define oc_new_bool_array(ocarray, size)                                       \
  (_oc_new_array(ocarray, size, BYTE_POOL))
 
#define oc_new_float_array(ocarray, size)                                      \
  (_oc_new_array(ocarray, size, FLOAT_POOL))
 
#define oc_new_double_array(ocarray, size)                                     \
  (_oc_new_array(ocarray, size, DOUBLE_POOL))
 
#define oc_new_string_array(ocstringarray, size)                               \
  (_oc_alloc_string_array(ocstringarray, size))
 
#define oc_free_string_array(ocstringarray) (_oc_free_string(ocstringarray))
 
#define oc_new_byte_string_array(ocstringarray, size)                          \
  (_oc_alloc_string_array(ocstringarray, size))
 
#define oc_free_byte_string_array(ocstringarray)                               \
  (_oc_free_string(ocstringarray))
 
#endif /* !OC_MEMORY_TRACE */
#define _MAKE_NULL(...) NULL
#define _ECHO
#define OC_SIZE_ZERO() _MAKE_NULL, 0
#define OC_SIZE_MANY(x) _ECHO, x
#define oc_mmem_create_const(count, ptr)                                       \
  {                                                                            \
    NULL, count, ptr                                                           \
  }
#define oc_string_create_const(s) oc_mmem_create_const(sizeof(s), s)
#define oc_string_array_create_const(f, n, ...)                                \
  oc_mmem_create_const(                                                        \
    (n * STRING_ARRAY_ITEM_MAX_LEN),                                           \
    f((const char[n][STRING_ARRAY_ITEM_MAX_LEN]){ __VA_ARGS__ }))
#define oc_int_array_create_const(f, n, ...)                                   \
  oc_mmem_create_const(n, f((const int64_t[n]){ __VA_ARGS__ }))
#define oc_bool_array_create_const(f, n, ...)                                  \
  oc_mmem_create_const(n, f((const bool[n]){ __VA_ARGS__ }))
#define oc_float_array_create_const(f, n, ...)                                 \
  oc_mmem_create_const(n, f((const float[n]){ __VA_ARGS__ }))
#define oc_double_array_create_const(f, n, ...)                                \
  oc_mmem_create_const(n, f((const double[n]){ __VA_ARGS__ }))
 
void oc_concat_strings(oc_string_t *concat, const char *str1, const char *str2);
#define oc_string_len(ocstring) ((ocstring).size ? (ocstring).size - 1 : 0)
#define oc_byte_string_len(ocstring) ((ocstring).size)
 
#define oc_int_array_size(ocintarray) ((ocintarray).size)
#define oc_bool_array_size(ocboolarray) ((ocboolarray).size)
#define oc_float_array_size(ocfloatarray) ((ocfloatarray).size)
#define oc_double_array_size(ocdoublearray) ((ocdoublearray).size)
#define oc_string_array_size(ocstringarray)                                    \
  ((ocstringarray).size / STRING_ARRAY_ITEM_MAX_LEN)
#define oc_int_array(ocintarray) (oc_cast(ocintarray, int64_t))
#define oc_bool_array(ocboolarray) (oc_cast(ocboolarray, bool))
#define oc_float_array(ocfloatarray) (oc_cast(ocfloatarray, float))
#define oc_double_array(ocdoublearray) (oc_cast(ocdoublearray, double))
#define oc_string_array(ocstringarray)                                         \
  ((char(*)[STRING_ARRAY_ITEM_MAX_LEN])(OC_MMEM_PTR(&(ocstringarray))))
 
#ifdef OC_DYNAMIC_ALLOCATION
#define STRING_ARRAY_ITEM_MAX_LEN 32
#else /* OC_DYNAMIC_ALLOCATION */
#define STRING_ARRAY_ITEM_MAX_LEN 32
#endif /* !OC_DYNAMIC_ALLOCATION */
 
bool _oc_copy_string_to_array(oc_string_array_t *ocstringarray,
                              const char str[], size_t index);
bool _oc_string_array_add_item(oc_string_array_t *ocstringarray,
                               const char str[]);
void oc_join_string_array(oc_string_array_t *ocstringarray,
                          oc_string_t *ocstring);
 
bool _oc_copy_byte_string_to_array(oc_string_array_t *ocstringarray,
                                   const char str[], size_t str_len,
                                   size_t index);
bool _oc_byte_string_array_add_item(oc_string_array_t *ocstringarray,
                                    const char str[], size_t str_len);
 
/* Arrays of text strings */
#define oc_string_array_add_item(ocstringarray, str)                           \
  (_oc_string_array_add_item(&(ocstringarray), str))
#define oc_string_array_get_item(ocstringarray, index)                         \
  (oc_string(ocstringarray) + (index)*STRING_ARRAY_ITEM_MAX_LEN)
#define oc_string_array_set_item(ocstringarray, str, index)                    \
  (_oc_copy_string_to_array(&(ocstringarray), str, index))
#define oc_string_array_get_item_size(ocstringarray, index)                    \
  (strlen((const char *)oc_string_array_get_item(ocstringarray, index)))
#define oc_string_array_get_allocated_size(ocstringarray)                      \
  ((ocstringarray).size / STRING_ARRAY_ITEM_MAX_LEN)
 
/* Arrays of byte strings */
#define oc_byte_string_array_add_item(ocstringarray, str, str_len)             \
  (_oc_byte_string_array_add_item(&(ocstringarray), str, str_len))
#define oc_byte_string_array_get_item(ocstringarray, index)                    \
  (oc_string(ocstringarray) + (index)*STRING_ARRAY_ITEM_MAX_LEN + 1)
#define oc_byte_string_array_set_item(ocstringarray, str, str_len, index)      \
  (_oc_copy_byte_string_to_array(&(ocstringarray), str, str_len, index))
#define oc_byte_string_array_get_item_size(ocstringarray, index)               \
  (*(oc_string(ocstringarray) + (index)*STRING_ARRAY_ITEM_MAX_LEN))
#define oc_byte_string_array_get_allocated_size(ocstringarray)                 \
  ((ocstringarray).size / STRING_ARRAY_ITEM_MAX_LEN)
 
void _oc_new_string(
#ifdef OC_MEMORY_TRACE
  const char *func,
#endif
  oc_string_t *ocstring, const char *str, size_t str_len);
 
void _oc_new_byte_string(
#ifdef OC_MEMORY_TRACE
  const char *func,
#endif
  oc_string_t *ocstring, const char *str, size_t str_len);
 
void _oc_alloc_string(
#ifdef OC_MEMORY_TRACE
  const char *func,
#endif
  oc_string_t *ocstring, size_t size);
 
void _oc_free_string(
#ifdef OC_MEMORY_TRACE
  const char *func,
#endif
  oc_string_t *ocstring);
 
void _oc_free_array(
#ifdef OC_MEMORY_TRACE
  const char *func,
#endif
  oc_array_t *ocarray, pool type);
 
void _oc_new_array(
#ifdef OC_MEMORY_TRACE
  const char *func,
#endif
  oc_array_t *ocarray, size_t size, pool type);
 
void _oc_alloc_string_array(
#ifdef OC_MEMORY_TRACE
  const char *func,
#endif
  oc_string_array_t *ocstringarray, size_t size);
 
int oc_conv_byte_array_to_hex_string(const uint8_t *array, size_t array_len,
                                     char *hex_str, size_t *hex_str_len);
 
int oc_conv_hex_string_to_byte_array(const char *hex_str, size_t hex_str_len,
                                     uint8_t *array, size_t *array_len);
int oc_conv_hex_string_to_oc_string(const char *hex_str, size_t hex_str_len,
                                    oc_string_t *out);
 
int oc_string_is_hex_array(oc_string_t hex_string);
 
int oc_string_print_hex(oc_string_t hex_string);
 
int oc_string_println_hex(oc_string_t hex_string);
 
int oc_char_convert_to_lower(char *string);
 
int oc_char_print_hex(const char *str, int str_len);
int oc_char_println_hex(const char *str, int str_len);
 
bool oc_uri_contains_wildcard(const char *uri);
 
int oc_uri_get_wildcard_value_as_int(const char *uri_resource, size_t uri_len,
                                     const char *uri_invoked,
                                     size_t invoked_len);
 
bool oc_uri_contains_wildcard_value_underscore(const char *uri_resource,
                                               size_t uri_len,
                                               const char *uri_invoked,
                                               size_t invoked_len);
 
int oc_uri_get_wildcard_value_as_int_after_underscore(const char *uri_resource,
                                                      size_t uri_len,
                                                      const char *uri_invoked,
                                                      size_t invoked_len);
 
int oc_uri_get_wildcard_value_as_string(const char *uri_resource,
                                        size_t uri_len, const char *uri_invoked,
                                        size_t invoked_len, const char **value);
 
char *oc_strnchr(const char *string, char p, int size);
 
int oc_get_sn_from_ep(const char *param, int param_len, char *sn, int sn_len,
                      uint32_t *ia);
 
int oc_get_sn_ia_iid_from_ep(const char *param, int param_len, char *sn,
                             int sn_len, uint32_t *ia, uint64_t *iid);
 
int oc_string_copy_from_char(oc_string_t *string1, const char *string2);
 
int oc_string_copy_from_char_with_size(oc_string_t *string1,
                                       const char *string2, size_t string2_len);
 
int oc_byte_string_copy_from_char_with_size(oc_string_t *string1,
                                            const char *string2,
                                            size_t string2_len);
 
int oc_string_copy(oc_string_t *string1, oc_string_t string2);
 
int oc_byte_string_copy(oc_string_t *string1, oc_string_t string2);
 
int oc_string_cmp(oc_string_t string1, oc_string_t string2);
 
int oc_byte_string_cmp(oc_string_t string1, oc_string_t string2);
 
int oc_url_cmp(oc_string_t string1, oc_string_t string2);
 
int oc_print_uint64_t(uint64_t number, enum StringRepresentation rep);
 
int oc_conv_uint64_to_dec_string(char *str, uint64_t number);
 
int oc_conv_uint64_to_hex_string(char *str, uint64_t number);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OC_HELPERS_H */