/**
 * @file   nullable_attribute.c
 *
 * @section LICENSE
 *
 * The MIT License
 *
 * @copyright Copyright (c) 2020 TileDB, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * @section DESCRIPTION
 *
 * When run, this program will create a simple 2D dense array with one fixed
 * nullable attribute and one var-sized nullable attribute, write some data
 * to it, and read the data back on both attributes.
 */

#include <stdio.h>
#include <stdlib.h>
#include <tiledb/tiledb.h>

// Name of array.
const char* array_name = "nullable_attribute_array";

void create_array() {
  // Create TileDB context
  tiledb_ctx_t* ctx;
  tiledb_ctx_alloc(NULL, &ctx);

  // The array will be 2x2 with dimensions "rows" and "cols", with domain [1,2]
  int dim_domain[] = {1, 2, 1, 2};
  int tile_extents[] = {2, 2};
  tiledb_dimension_t* d1;
  tiledb_dimension_alloc(
      ctx, "rows", TILEDB_INT32, &dim_domain[0], &tile_extents[0], &d1);
  tiledb_dimension_t* d2;
  tiledb_dimension_alloc(
      ctx, "cols", TILEDB_INT32, &dim_domain[2], &tile_extents[1], &d2);

  // Create domain
  tiledb_domain_t* domain;
  tiledb_domain_alloc(ctx, &domain);
  tiledb_domain_add_dimension(ctx, domain, d1);
  tiledb_domain_add_dimension(ctx, domain, d2);

  // Create two attributes, the first fixed and the second var-sized
  tiledb_attribute_t* a1;
  tiledb_attribute_alloc(ctx, "a1", TILEDB_INT32, &a1);
  tiledb_attribute_t* a2;
  tiledb_attribute_alloc(ctx, "a2", TILEDB_INT32, &a2);
  tiledb_attribute_set_cell_val_num(ctx, a2, TILEDB_VAR_NUM);

  // Set both attributes as nullable
  tiledb_attribute_set_nullable(ctx, a1, 1);
  tiledb_attribute_set_nullable(ctx, a2, 1);

  // Create array schema
  tiledb_array_schema_t* array_schema;
  tiledb_array_schema_alloc(ctx, TILEDB_DENSE, &array_schema);
  tiledb_array_schema_set_cell_order(ctx, array_schema, TILEDB_ROW_MAJOR);
  tiledb_array_schema_set_tile_order(ctx, array_schema, TILEDB_ROW_MAJOR);
  tiledb_array_schema_set_domain(ctx, array_schema, domain);
  tiledb_array_schema_add_attribute(ctx, array_schema, a1);
  tiledb_array_schema_add_attribute(ctx, array_schema, a2);

  // Create array
  tiledb_array_create(ctx, array_name, array_schema);

  // Clean up
  tiledb_attribute_free(&a1);
  tiledb_attribute_free(&a2);
  tiledb_dimension_free(&d1);
  tiledb_dimension_free(&d2);
  tiledb_domain_free(&domain);
  tiledb_array_schema_free(&array_schema);
  tiledb_ctx_free(&ctx);
}

void write_array() {
  // Create TileDB context
  tiledb_ctx_t* ctx;
  tiledb_ctx_alloc(NULL, &ctx);

  // Open array for writing
  tiledb_array_t* array;
  tiledb_array_alloc(ctx, array_name, &array);
  tiledb_array_open(ctx, array, TILEDB_WRITE);

  // Prepare some data for the array
  int a1_data[] = {100, 200, 300, 400};
  uint64_t a1_data_size = sizeof(a1_data);

  int a2_data[] = {10, 10, 20, 30, 30, 30, 40, 40};
  uint64_t a2_data_size = sizeof(a2_data);
  uint64_t a2_el_off[] = {0, 2, 3, 6};
  uint64_t a2_off[4];
  for (int i = 0; i < 4; ++i)
    a2_off[i] = a2_el_off[i] * sizeof(int);
  uint64_t a2_off_size = sizeof(a2_off);

  // Create the query
  tiledb_query_t* query;
  tiledb_query_alloc(ctx, array, TILEDB_WRITE, &query);
  tiledb_query_set_layout(ctx, query, TILEDB_ROW_MAJOR);

  // Specify the validity buffer for each attribute
  uint8_t a1_validity_buf[] = {1, 0, 0, 1};
  uint64_t a1_validity_buf_size = sizeof(a1_validity_buf);
  uint8_t a2_validity_buf[] = {0, 1, 1, 1, 0, 0, 1, 1};
  uint64_t a2_validity_buf_size = sizeof(a2_validity_buf);

  // Set the query buffers specifying the validity for each data
  tiledb_query_set_buffer_nullable(
      ctx,
      query,
      "a1",
      (void*)a1_data,
      &a1_data_size,
      a1_validity_buf,
      &a1_validity_buf_size);
  tiledb_query_set_buffer_var_nullable(
      ctx,
      query,
      "a2",
      a2_off,
      &a2_off_size,
      (void*)a2_data,
      &a2_data_size,
      a2_validity_buf,
      &a2_validity_buf_size);

  // Submit query
  tiledb_query_submit(ctx, query);

  // Close array
  tiledb_array_close(ctx, array);

  // Clean up
  tiledb_array_free(&array);
  tiledb_query_free(&query);
  tiledb_ctx_free(&ctx);
}

void read_array() {
  // Create TileDB context
  tiledb_ctx_t* ctx;
  tiledb_ctx_alloc(NULL, &ctx);

  // Open array for writing
  tiledb_array_t* array;
  tiledb_array_alloc(ctx, array_name, &array);
  tiledb_array_open(ctx, array, TILEDB_READ);

  // Read the full array
  int subarray_full[] = {1, 2, 1, 2};

  // Set maximum buffer sizes
  uint64_t a1_data_size = 16;
  uint64_t a1_validity_buf_size = a1_data_size;

  uint64_t a2_data_size = 32;
  uint64_t a2_off_size = 32;
  uint64_t a2_validity_buf_size = a2_data_size;

  // Prepare the vector that will hold the result
  int* a1_data = (int*)malloc(a1_data_size);
  int* a2_data = (int*)malloc(a2_data_size);
  uint64_t* a2_off = (uint64_t*)malloc(a2_off_size);

  // Prepare the vector that will hold the validity buffers
  uint8_t* a1_validity_buf = (uint8_t*)malloc(a1_validity_buf_size);
  uint8_t* a2_validity_buf = (uint8_t*)malloc(a2_validity_buf_size);

  // Create query
  tiledb_query_t* query;
  tiledb_query_alloc(ctx, array, TILEDB_READ, &query);
  tiledb_query_set_subarray(ctx, query, subarray_full);
  tiledb_query_set_layout(ctx, query, TILEDB_ROW_MAJOR);

  // Set the query buffers specifying the validity for each data
  tiledb_query_set_buffer_nullable(
      ctx,
      query,
      "a1",
      a1_data,
      &a1_data_size,
      a1_validity_buf,
      &a1_validity_buf_size);
  tiledb_query_set_buffer_var_nullable(
      ctx,
      query,
      "a2",
      a2_off,
      &a2_off_size,
      a2_data,
      &a2_data_size,
      a2_validity_buf,
      &a2_validity_buf_size);

  // Submit query
  tiledb_query_submit(ctx, query);

  // Close array
  tiledb_array_close(ctx, array);

  // Print out the data we read for each nullable atttribute
  int i = 0;
  printf("a1: \n");
  for (i = 0; i < 4; ++i) {
    (a1_validity_buf[i] > 0) ? printf("%d ", a1_data[i]) : printf("NULL ");
  }
  printf("\n");

  printf("a2: \n");
  for (i = 0; i < 8; ++i) {
    (a2_validity_buf[i] > 0) ? printf("%d ", a2_data[i]) : printf("NULL ");
  }
  printf("\n");

  // Clean up
  free((void*)a1_data);
  free((void*)a1_validity_buf);
  free((void*)a2_data);
  free((void*)a2_off);
  free((void*)a2_validity_buf);
  tiledb_array_free(&array);
  tiledb_query_free(&query);
  tiledb_ctx_free(&ctx);
}

int main() {
  // Get object type
  tiledb_ctx_t* ctx;
  tiledb_ctx_alloc(NULL, &ctx);
  tiledb_object_t type;
  tiledb_object_type(ctx, array_name, &type);

  if (type == TILEDB_ARRAY) {
    tiledb_object_remove(ctx, array_name);
  }
  tiledb_ctx_free(&ctx);

  create_array();
  write_array();
  read_array();

  return 0;
}