/*
 * Copyright 2009-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at:
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file 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 IONC_ION_TEST_UTIL_H
#define IONC_ION_TEST_UTIL_H

#include <gtest/gtest.h>
#include <ionc/ion.h>

#define ION_ASSERT_OK(x) ASSERT_EQ(IERR_OK, x)
#define ION_ASSERT_FAIL(x) ASSERT_FALSE(IERR_OK == (x))

#define INSTANTIATE_TEST_CASE_BOOLEAN_PARAM(instantiation_name) \
    INSTANTIATE_TEST_CASE_P(instantiation_name, BinaryAndTextTest, ::testing::Bool())

/**
 * Parameterized test fixture for tests that should be run for both text and binary.
 * Use by declaring a test with TEST_P(BinaryAndTextTest, TestName) {...}.
 */
class BinaryAndTextTest : public ::testing::TestWithParam<bool> {
    virtual void SetUp();
public:
    BOOL is_binary;
};

/**
 * Initializes and opens a new in-memory writer.
 * @param writer - the writer to initialize and open.
 * @param ion_stream - output parameter for the underlying in-memory stream.
 * @param is_binary - TRUE if the writer should be a binary writer; else FALSE.
 * @return IERR_OK, unless the writer or stream fails to open.
 */
iERR ion_test_new_writer(hWRITER *writer, ION_STREAM **ion_stream, BOOL is_binary);

/**
 * Closes a writer and its in-memory stream and copies the written bytes.
 * @param writer - the writer to finish.
 * @param ion_stream - the stream to close.
 * @param out - output parameter for the copied written bytes.
 * @param len - the length of the written bytes.
 * @return IERR_OK, unless the writer or stream fails to close.
 */
iERR ion_test_writer_get_bytes(hWRITER writer, ION_STREAM *ion_stream, BYTE **out, SIZE *len);

/**
 * Creates an ION_SYMBOL with the given SID and calls `ion_writer_write_ion_symbol`.
 * @param writer - the writer to write to.
 * @param sid - the local SID of the symbol to be written.
 * @return the result of `ion_writer_write_ion_symbol`.
 */
iERR ion_test_writer_write_symbol_sid(ION_WRITER *writer, SID sid);

/**
 * Creates an ION_SYMBOL with the given SID and calls `ion_writer_add_annotation_symbol`.
 * @param writer - the writer to write to.
 * @param sid - the local SID of the symbol to be written.
 * @return the result of `ion_writer_add_annotation_symbol`.
 */
iERR ion_test_writer_add_annotation_sid(ION_WRITER *writer, SID sid);

/**
 * Creates an ION_SYMBOL with the given SID and calls `ion_writer_write_field_name_symbol`.
 * @param writer - the writer to write to.
 * @param sid - the local SID of the symbol to be written.
 * @return the result of `ion_writer_write_field_name_symbol`.
 */
iERR ion_test_writer_write_field_name_sid(ION_WRITER *writer, SID sid);

/**
 * Assigns the given char * to an ION_STRING, without copying.
 * @param cstr - the char * to assign.
 * @param out - the ION_STRING to assign to.
 * @return IERR_OK, unless out is NULL.
 */
iERR ion_string_from_cstr(const char *cstr, ION_STRING *out);

/**
 * Initializes and opens a new in-memory reader over the given buffer of Ion data.
 * @param ion_data - the Ion data to read.
 * @param buffer_length - the length of the buffer of Ion data.
 * @param reader - the reader to initialize and open.
 * @return IERR_OK, unless the reader fails to open.
 */
iERR ion_test_new_reader(BYTE *ion_data, SIZE buffer_length, hREADER *reader);

/**
 * Initializes and opens a new in-memory reader over the given string of Ion text.
 * @param ion_text - the Ion text to read.
 * @param reader - the reader to initialize and open.
 * @return IERR_OK, unless the reader fails to open.
 */
iERR ion_test_new_text_reader(const char *ion_text, hREADER *reader);

/**
 * Reads an ION_SYMBOL and provides its local SID.
 * @param reader - the reader from which to read.
 * @param sid - Output parameter for the local SID of the symbol
 * @return the result of `ion_reader_read_symbol.`
 */
iERR ion_test_reader_read_symbol_sid(ION_READER *reader, SID *sid);

/**
 * Reads the Ion string at the given reader's current position and assigns its contents
 * to a char *.
 * @param reader - the reader from which to read the string.
 * @param out - output parameter for the copied string.
 * @return IERR_OK, unless the read or the copy fails.
 */
iERR ion_read_string_as_chars(hREADER reader, char **out);

/**
 * Prints the given bytes in two-digit hexadecimal format, delimited by "\x"
 * @param bytes - the bytes to print.
 * @param length - the number of bytes to print.
 */
void ion_test_print_bytes(BYTE *bytes, SIZE length);

#endif //IONC_ION_TEST_UTIL_H