1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
|
/*
* Copyright 2022, University Corporation for Atmospheric Research
* See netcdf/COPYRIGHT file for copying and redistribution conditions.
*/
/**
* @file
* @internal
*
* This file contains functions that work with the NC struct. There is
* an NC struct for every open netCDF file.
*
* @author Glenn Davis
*/
#include "config.h"
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#include "ncdispatch.h"
#ifndef nulldup
#define nulldup(x) ((x)?strdup(x):(x))
#endif
/** This is the default create format for nc_create and nc__create. */
static int default_create_format = NC_FORMAT_CLASSIC;
/**
* Find the NC struct for an open file, using the ncid.
*
* @param ncid The ncid to find.
* @param ncpp Pointer that gets a pointer to the NC.
*
* @return ::NC_NOERR No error.
* @return ::NC_EBADID ncid not found.
* @author Glenn Davis, Dennis Heimbigner
*/
int
NC_check_id(int ncid, NC** ncpp)
{
NC* nc = find_in_NCList(ncid);
if(nc == NULL) return NC_EBADID;
if(ncpp) *ncpp = nc;
return NC_NOERR;
}
/**
* Free an NC struct and its related resources. Before this is done,
* be sure to remove the NC from the open file list with
* del_from_NCList().
*
* @param ncp Pointer to the NC struct to be freed.
*
* @author Glenn Davis, Dennis Heimbigner
*/
void
free_NC(NC *ncp)
{
if(ncp == NULL)
return;
if(ncp->path)
free(ncp->path);
/* We assume caller has already cleaned up ncp->dispatchdata */
free(ncp);
}
/**
* Create and initialize a new NC struct. The ncid is assigned later.
*
* @param dispatcher An pointer to the NC_Dispatch table that should
* be used by this NC.
* @param path The name of the file.
* @param mode The open or create mode.
* @param model An NCmodel instance, provided by NC_infermodel().
* @param ncpp A pointer that gets a pointer to the newlly allocacted
* and initialized NC struct.
*
* @return ::NC_NOERR No error.
* @return ::NC_ENOMEM Out of memory.
* @author Glenn Davis, Dennis Heimbigner
*/
int
new_NC(const NC_Dispatch* dispatcher, const char* path, int mode, NC** ncpp)
{
NC *ncp = (NC*)calloc(1,sizeof(NC));
if(ncp == NULL) return NC_ENOMEM;
ncp->dispatch = dispatcher;
ncp->path = nulldup(path);
ncp->mode = mode;
if(ncp->path == NULL) { /* fail */
free_NC(ncp);
return NC_ENOMEM;
}
if(ncpp) {
*ncpp = ncp;
} else {
free_NC(ncp);
}
return NC_NOERR;
}
/**
* This function sets a default create flag that will be logically
* or'd to whatever flags are passed into nc_create for all future
* calls to nc_create.
*
* @param format The format that should become the default.
* @param old_formatp Pointer that gets the previous default. Ignored
* if NULL.
*
* @return ::NC_NOERR No error.
* @return ::NC_ENOTBUILD Requested format not built with this install.
* @return ::NC_EINVAL Invalid input.
* @author Ed Hartnett, Dennis Heimbigner
*/
int
nc_set_default_format(int format, int *old_formatp)
{
/* Return existing format if desired. */
if (old_formatp)
*old_formatp = default_create_format;
/* Make sure only valid format is set. */
#ifndef ENABLE_CDF5
if (format == NC_FORMAT_CDF5)
return NC_ENOTBUILT;
#endif
#ifdef USE_HDF5
if (format != NC_FORMAT_CLASSIC && format != NC_FORMAT_64BIT_OFFSET &&
format != NC_FORMAT_NETCDF4 && format != NC_FORMAT_NETCDF4_CLASSIC &&
format != NC_FORMAT_CDF5)
return NC_EINVAL;
#else
if (format == NC_FORMAT_NETCDF4 || format == NC_FORMAT_NETCDF4_CLASSIC)
return NC_ENOTBUILT;
if (format != NC_FORMAT_CLASSIC && format != NC_FORMAT_64BIT_OFFSET &&
format != NC_FORMAT_CDF5)
return NC_EINVAL;
#endif
default_create_format = format;
return NC_NOERR;
}
/**
* Get the current default format.
*
* @return the default format.
* @author Ed Hartnett
*/
int
nc_get_default_format(void)
{
return default_create_format;
}
|