// -------------------------------------------------------------------------------------------
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
// This file is part of the AWS CDI-SDK, licensed under the BSD 2-Clause "Simplified" License.
// License details at: https://github.com/aws/aws-cdi-sdk/blob/mainline/LICENSE
// -------------------------------------------------------------------------------------------

/**
 * @file
 * @brief
 * The declarations in this header file correspond to the definitions in test_common.c.
 */

#ifndef TEST_COMMON_H__
#define TEST_COMMON_H__

#include <stdarg.h>
#include <stdbool.h>

#include "cdi_logger_api.h"
#include "cdi_log_enums.h"

//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************

/// Forward reference of structure to create pointers later.
typedef struct CommandLineState CommandLineState;
/// Forward reference of structure to create pointers later.
typedef struct CommandLineState* CommandLineHandle;

/// @brief How often to update stdout with payload progress.
#define PAYLOAD_PROGRESS_UPDATE_FREQUENCY   (60)

/// @brief Default value for protocol type.
#define DEFAULT_PROTOCOL_TYPE               (kProtocolTypeRaw)

/// @brief Default number of transactions.
#define DEFAULT_NUM_TRANSACTIONS            (1000)

/// @brief Default payload size.
#define DEFAULT_PAYLOAD_SIZE                (5184000)

/// @brief Default EFA usage
#define DEFAULT_USE_EFA                     (true)

/// @brief Number of elements in a static array.
#define ARRAY_ELEMENT_COUNT(thisarray) ((int)(sizeof(thisarray)/sizeof(thisarray[0])))

//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************

/**
 * Convert a string to an integer.
 *
 * @param str Pointer to string to convert.
 * @param num_ptr Address where to write converted integer value.
 * @param ret_end_str Optional address where to write pointer to string after last character parsed.
 *
 * @return true if successful, otherwise false.
 */
bool TestStringToInt(const char* str, int* num_ptr, char** ret_end_str);

/**
 * Create an instance of a command line parser.
 *
 * @param argc_ptr Pointer to number of command line arguments.
 * @param argv_ptr Pointer pointer to array of pointers to command line arguments.
 * @param ret_handle Address where to write returned handle of parser.
 *
 * @return true if successful, otherwise false.
 */
bool TestCommandLineParserCreate(int* argc_ptr, const char*** argv_ptr, CommandLineHandle* ret_handle);

/**
 * Destroy an instance of the command line parser.
 *
 * @param handle Instance handle returned from TestCommandLineParserCreate().
 */
void TestCommandLineParserDestroy(CommandLineHandle handle);

/**
 * Not using the console logger, so implement this API here so it can be used from within test_common.c and test
 * applications that use this file.
 *
 * @param log_level The log level for this message.
 * @param format_str Format string specifier.
 * @param ...  The remaining parameters contain a variable length list of arguments.
 */
void SimpleConsoleLog(CdiLogLevel log_level, const char* format_str, ...);

#endif // TEST_COMMON_H__