Assert module header file. More...

#include "mcl_core/mcl_log_util.h"

Include dependency graph for mcl_assert.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	MCL_ERROR_RETURN_POINTER(return_value, ...)

#define	MCL_ERROR_RETURN(return_value, ...)

#define	MCL_ASSERT_OK(code)

#define	MCL_ASSERT_NOT_NULL(argument, return_variable)

#define	MCL_ASSERT(condition)

#define	MCL_ASSERT_MESSAGE(condition, ...)

#define	MCL_ASSERT_STATEMENT_MESSAGE(condition, statement, ...)

#define	MCL_ASSERT_CODE(condition, return_code)

#define	MCL_ASSERT_CODE_MESSAGE(condition, return_code, ...)

#define	MCL_ASSERT_STATEMENT_CODE(condition, statement, return_code)

#define	MCL_ASSERT_STATEMENT_CODE_MESSAGE(condition, statement, return_code, ...)

Detailed Description

Assert module header file.

This module contains assert functions.

Copyright: Copyright (C) 2019 Siemens Aktiengesellschaft.
All rights reserved.

Definition in file mcl_assert.h.

Macro Definition Documentation

#define MCL_ASSERT ( condition )

Value:

if(!(condition)) \
    { \
        MCL_ERROR_STRING("Assertion failed for condition = <" #condition ">."); \
        MCL_DEBUG_LEAVE("retVal = <%p>", MCL_NULL); \
        return MCL_NULL; \
    }

Definition at line 46 of file mcl_assert.h.

#define MCL_ASSERT_CODE	(	condition,
		return_code
	)

Value:

if(!(condition)) \
    { \
        MCL_ERROR_STRING("Assertion failed for condition = <" #condition ">."); \
        MCL_DEBUG_LEAVE("retVal = <%d>", (return_code)); \
        return (return_code); \
    }

Definition at line 69 of file mcl_assert.h.

Referenced by _base64_encode_big_number(), and core_configuration_validate().

#define MCL_ASSERT_CODE_MESSAGE	(	condition,
		return_code,
		...
	)

Value:

if(!(condition)) \
    { \
        MCL_ERROR_STRING("Assertion failed for condition = <" #condition ">."); \
        MCL_ERROR_RETURN(return_code, __VA_ARGS__); \
    }

Definition at line 77 of file mcl_assert.h.

Referenced by _calculate_signature(), _create_self_issued_jwt_payload(), _decode_with_table(), _encode_with_table(), _generate_token(), _get_header_and_payload_encoded_base64_url(), _get_rsa_private_key(), _get_rsa_public_key(), _load_initial_credentials(), _response_payload_callback(), _ssl_context_callback(), core_processor_initialize(), core_processor_update_credentials(), hmac_sha256(), jwt_initialize(), mcl_core_configuration_initialize(), mcl_core_configuration_set_parameter(), mcl_core_initialize(), mcl_http_client_initialize(), mcl_http_request_add_header(), mcl_http_response_get_header(), mcl_http_response_initialize(), mcl_list_add(), mcl_list_initialize(), mcl_list_remove(), mcl_random_generate_guid(), mcl_time_util_convert_to_iso_8601_format(), random_generate_guid(), security_generate_rsa_key(), security_handler_initialize(), security_hash_sha256(), security_rsa_get_modulus_and_exponent(), and security_rsa_sign().

#define MCL_ASSERT_MESSAGE	(	condition,
		...
	)

Value:

if(!(condition)) \
    { \
        MCL_ERROR_STRING("Assertion failed for condition = <" #condition ">."); \
        MCL_ERROR_RETURN_POINTER(MCL_NULL, __VA_ARGS__); \
    }

Definition at line 54 of file mcl_assert.h.

#define MCL_ASSERT_NOT_NULL	(	argument,
		return_variable
	)

Value:

if(MCL_NULL == argument) \
    { \
        MCL_ERROR_STRING("Null function argument (" #argument ")."); \
        return_variable = MCL_TRIGGERED_WITH_NULL; \
        goto MCL_FUNCTION_LEAVE_LABEL; \
    }

Definition at line 38 of file mcl_assert.h.

Referenced by mcl_core_configuration_initialize(), mcl_core_configuration_set_parameter(), mcl_core_get_access_token(), mcl_core_get_last_access_token(), mcl_core_get_last_token_time(), mcl_core_initialize(), mcl_core_onboard(), mcl_core_rotate_key(), mcl_core_update_credentials(), mcl_http_client_add_certificate(), mcl_http_client_initialize(), mcl_http_client_send(), mcl_http_request_add_header(), mcl_http_request_initialize(), mcl_http_request_set_parameter(), mcl_http_response_get_header(), mcl_http_response_get_status(), mcl_http_response_initialize(), mcl_json_util_add_bool(), mcl_json_util_add_double(), mcl_json_util_add_item_to_array(), mcl_json_util_add_null(), mcl_json_util_add_object(), mcl_json_util_add_string(), mcl_json_util_add_uint(), mcl_json_util_duplicate(), mcl_json_util_get_array_item(), mcl_json_util_get_array_size(), mcl_json_util_get_bool_value(), mcl_json_util_get_double_value(), mcl_json_util_get_number_value(), mcl_json_util_get_object_item(), mcl_json_util_get_string(), mcl_json_util_has_child(), mcl_json_util_initialize(), mcl_json_util_parse(), mcl_json_util_start_array(), mcl_json_util_start_object(), mcl_json_util_to_string(), mcl_list_add(), mcl_list_exist(), mcl_list_initialize(), mcl_list_next(), mcl_list_remove(), mcl_list_remove_with_content(), mcl_log_util_set_callback(), mcl_random_generate_bytes(), mcl_random_generate_guid(), mcl_string_util_reset(), mcl_string_util_strncmp(), mcl_tls_ca_chain_init(), mcl_tls_socket_init(), mcl_tls_socket_open(), and mcl_tls_socket_set_parameter().

#define MCL_ASSERT_OK ( code )

Value:

if(MCL_OK != code) \
    { \
        MCL_ERROR("Expected: 0, actual: %d for " #code".", code); \
        goto MCL_FUNCTION_LEAVE_LABEL; \
    }

Definition at line 31 of file mcl_assert.h.

Referenced by mcl_core_onboard(), mcl_core_rotate_key(), and mcl_core_update_credentials().

#define MCL_ASSERT_STATEMENT_CODE	(	condition,
		statement,
		return_code
	)

Value:

if(!(condition)) \
    { \
        MCL_ERROR_STRING("Assertion failed for condition = <" #condition ">."); \
        (statement); \
        MCL_DEBUG_LEAVE("retVal = <%d>", (return_code)); \
        return (return_code); \
    }

Definition at line 84 of file mcl_assert.h.

#define MCL_ASSERT_STATEMENT_CODE_MESSAGE	(	condition,
		statement,
		return_code,
		...
	)

Value:

if(!(condition)) \
    { \
        MCL_ERROR_STRING("Assertion failed for condition = <" #condition ">."); \
        (statement); \
        MCL_ERROR_RETURN(return_code, __VA_ARGS__); \
    }

Definition at line 93 of file mcl_assert.h.

Referenced by _create_self_issued_jwt_payload(), _get_header_and_payload_encoded_base64_url(), _get_rsa_private_key(), _get_rsa_public_key(), core_processor_initialize(), core_processor_register(), hmac_sha256(), jwt_initialize(), mcl_core_initialize(), random_generate_guid(), security_generate_rsa_key(), security_rsa_get_modulus_and_exponent(), and security_rsa_sign().

#define MCL_ASSERT_STATEMENT_MESSAGE	(	condition,
		statement,
		...
	)

Value:

if(!(condition)) \
    { \
        MCL_ERROR_STRING("Assertion failed for condition = <" #condition ">."); \
        (statement); \
        MCL_ERROR_RETURN_POINTER(MCL_NULL, __VA_ARGS__); \
    }

Definition at line 61 of file mcl_assert.h.

#define MCL_ERROR_RETURN	(	return_value,
		...
	)

Value:

MCL_ERROR(__VA_ARGS__); \
    MCL_DEBUG_LEAVE("retVal = <%d>", (return_value)); \
    return (return_value);

Definition at line 26 of file mcl_assert.h.

Referenced by _generate_token(), _get_rsa_private_key(), _get_rsa_public_key(), _set_request_options(), hmac_sha256(), and mcl_tls_ca_chain_add_certificate().

#define MCL_ERROR_RETURN_POINTER	(	return_value,
		...
	)

Value:

MCL_ERROR(__VA_ARGS__); \
    MCL_DEBUG_LEAVE("retVal = <%p>", (return_value)); \
    return (return_value);

Definition at line 21 of file mcl_assert.h.

Macros

Detailed Description

Macro Definition Documentation