inc/c_util/rc_string.h

// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

#ifndef RC_STRING_H
#define RC_STRING_H

#ifdef __cplusplus
#include <cstddef>
#include <cstdarg>
#else
#include <stdarg.h>
#include <stddef.h>
#endif

#include "c_pal/thandle.h"

#include "umock_c/umock_c_prod.h"

#ifdef __cplusplus
extern "C"
{
#endif

typedef struct RC_STRING_TAG
{
    const char* string;
} RC_STRING;

THANDLE_TYPE_DECLARE(RC_STRING);

typedef void (*RC_STRING_FREE_FUNC)(void* context);

#define PRI_RC_STRING "s"

/*Codes_SRS_RC_STRING_01_021: [ RC_STRING_VALUE shall print the string field of rc. ]*/
#define RC_STRING_VALUE(rc) ((rc)->string)

/*Codes_SRS_RC_STRING_42_001: [ If rc is NULL then RC_STRING_AS_CHARPTR shall return NULL. ]*/
/*Codes_SRS_RC_STRING_42_002: [ If rc is non-NULL then RC_STRING_AS_CHARPTR shall return the string field of rc. ]*/
#define RC_STRING_AS_CHARPTR(rc) (((rc) == NULL) ? NULL : (rc)->string)

/*Codes_SRS_RC_STRING_01_022: [ If rc is NULL, RC_STRING_VALUE_OR_NULL shall print NULL. ]*/
/*Codes_SRS_RC_STRING_01_023: [ If rc is non NULL, RC_STRING_VALUE_OR_NULL shall print the string field of rc. ]*/
#define RC_STRING_VALUE_OR_NULL(rc) (((rc) == NULL) ? "NULL" : (rc)->string)

MOCKABLE_FUNCTION(, THANDLE(RC_STRING), rc_string_create, const char*, string);
MOCKABLE_FUNCTION(, THANDLE(RC_STRING), rc_string_create_with_move_memory, const char*, string);
MOCKABLE_FUNCTION(, THANDLE(RC_STRING), rc_string_create_with_custom_free, const char*, string, RC_STRING_FREE_FUNC, free_func, void*, free_func_context);
MOCKABLE_FUNCTION(, THANDLE(RC_STRING), rc_string_recreate, THANDLE(RC_STRING), self);

// Macro for mockable rc_string_create_with_vformat to verify the arguments as if printf was called
#define rc_string_create_with_format(format, ...) (0?printf((format), ## __VA_ARGS__):0, rc_string_create_with_format_function((format), ##__VA_ARGS__))
// The non-mockable function for rc_string_create_with_vformat (because we can't mock ... arguments)
THANDLE(RC_STRING) rc_string_create_with_format_function(const char* format, ...);
// The mockable function, called by rc_string_create_with_format_function
MOCKABLE_FUNCTION(, THANDLE(RC_STRING), rc_string_create_with_vformat, const char*, format, va_list, va);

#ifdef __cplusplus
}
#endif

#endif  /* RC_STRING_H */