netcdf-c/nc_test/tst_formats.c

/* This is part of the netCDF package. Copyright 2005-2007 University
   Corporation for Atmospheric Research/Unidata. See COPYRIGHT file
   for conditions of use.

   Test handling of formats.

   Ed Hartnett, 11/22/17
*/

#include "config.h"
#include <nc_tests.h>
#include "err_macros.h"

#define FILE_NAME_BASE "tst_formats"
#define HDF4_FILE "ref_contiguous.hdf4"

/* Determine how many formats are available, and what they are. */
void
determine_test_formats(int *num_formats, int *format)
{
   int ind = 0;
   int num;

   /* Check inputs. */
   assert(num_formats && format);

   /* We always have classic and 64-bit offset */
   num = 2;
   format[ind++] = NC_FORMAT_CLASSIC;
   format[ind++] = NC_FORMAT_64BIT_OFFSET;

   /* Do we have netCDF-4 and netCDF-4 classic? */
#ifdef USE_NETCDF4
   num += 2;
   format[ind++] = NC_FORMAT_NETCDF4;
   format[ind++] = NC_FORMAT_NETCDF4_CLASSIC;
#endif /* USE_NETCDF4 */

   /* Do we have CDF5? */
#ifdef ENABLE_CDF5
   num++;
   format[ind++] = NC_FORMAT_CDF5;
#endif /* ENABLE_CDF5 */

   *num_formats = num;
}

/* Function to test nc_inq_format(). */
int
check_inq_format(int ncid, int expected_format, int expected_extended_format, int expected_mode)
{
   int format;
   int extended_format;
   int mode;
   
   if (nc_inq_format(ncid + 66000, NULL) != NC_EBADID) ERR;
   if (nc_inq_format(ncid, NULL)) ERR;
   if (nc_inq_format(ncid, &format)) ERR;
   if (format != expected_format) {
      printf("format %d expected_format %d\n", format, expected_format);      
      ERR;
   }
   if (nc_inq_format_extended(ncid + 66000, &extended_format, &mode) != NC_EBADID) ERR;
   {
      int mode;
      if (nc_inq_format_extended(ncid, NULL, &mode)) ERR;
      if (mode != expected_mode) {
         printf("expected_mode %x mode %x\n", expected_mode, mode);
         //ERR;
      }
   }
   {
      int extended_format;
      if (nc_inq_format_extended(ncid, &extended_format, NULL)) ERR;
      if (extended_format != expected_extended_format) ERR;
   }

   if (nc_inq_format_extended(ncid, &extended_format, &mode)) ERR;
   if (mode != expected_mode) ERR;
   if (extended_format != expected_extended_format) ERR;

   /* Nothing to do with inq_format, but let's check the base_pe
    * functions. */
   if (expected_format == NC_FORMAT_CLASSIC || expected_format == NC_FORMAT_64BIT_OFFSET ||
       expected_format == NC_FORMAT_CDF5) {
      if (nc_set_base_pe(ncid, 0)) ERR;
      if (nc_inq_base_pe(ncid, NULL)) ERR;
   } else {
      if (nc_set_base_pe(ncid, 0) != NC_ENOTNC3) ERR;
      if (nc_inq_base_pe(ncid, NULL) != NC_ENOTNC3) ERR;
   }

   return 0;
}

int
main(int argc, char **argv)
{
   printf("\n*** Testing netcdf format functions.\n");
   {
      int ncid;
      int expected_mode;
      int expected_extended_format;
      char file_name[NC_MAX_NAME + 1];
      int f;
      int format[MAX_NUM_FORMATS];
      int num_formats;

      /* How many formats to be tested? */
      determine_test_formats(&num_formats, format);

      for (f = 0; f < num_formats; f++)
      {
         printf("*** testing nc_inq_format() and nc_inq_format_extended() with format %d...", format[f]);
         sprintf(file_name, "%s_%d.nc", FILE_NAME_BASE, format[f]);

         /* Set up test. */
         switch (format[f]) {
         case NC_FORMAT_CLASSIC:
            expected_extended_format = NC_FORMATX_NC3;
            expected_mode = 0;
            break;
         case NC_FORMAT_64BIT_OFFSET:
            expected_extended_format = NC_FORMATX_NC3;
            expected_mode = NC_64BIT_OFFSET;            
            break;
         case NC_FORMAT_CDF5:
            expected_extended_format = NC_FORMATX_NC3;
            expected_mode = NC_CDF5;            
            break;
         case NC_FORMAT_NETCDF4:
            expected_extended_format = NC_FORMATX_NC4;
            expected_mode = NC_NETCDF4;            
            break;
         case NC_FORMAT_NETCDF4_CLASSIC:
            expected_extended_format = NC_FORMATX_NC4;
            expected_mode = NC_NETCDF4|NC_CLASSIC_MODEL;            
            break;
         }
         if (nc_set_default_format(format[f], NULL)) ERR;

         /* Create a file. */
         if (nc_create(file_name, 0, &ncid)) ERR;
         if (check_inq_format(ncid, format[f], expected_extended_format, expected_mode)) ERR;
         if (nc_close(ncid)) ERR;

         /* Re-open the file and check it again. */
         if (nc_open(file_name, 0, &ncid)) ERR;
         /* Classic flag is not set on mode in nc_open(). Not sure if
          * this is a bug or not. */
         if (format[f] == NC_FORMAT_NETCDF4_CLASSIC)
            expected_mode = NC_NETCDF4;
         if (check_inq_format(ncid, format[f], expected_extended_format, expected_mode)) ERR;
         if (nc_close(ncid)) ERR;
         SUMMARIZE_ERR;
      } /* next format */
   }
   FINAL_RESULTS;
}