Added vlist_var_key.c.

src/Makefile.am

@@ -139,6 +139,7 @@ libcdi_la_SOURCES = 	 \
 	vlist_var.c 	 \
 	vlist_var.h	 \
 	vlist_var_pack.c \
+	vlist_var_key.c  \
 	zaxis.c		 \
 	zaxis.h		 \
 	stream.c         \

src/make_cdilib

@@ -163,6 +163,7 @@ files="async_worker.c \
    cdi_att.c \
    vlist_var.c \
    vlist_var_pack.c \
+   vlist_var_key.c \
    zaxis.c"
 
 car () {

src/vlist_var.c

-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
-
 #include "dmemory.h"
 #include "cdi.h"
 #include "cdi_int.h"
@@ -1576,7 +1572,7 @@ void vlistDecodeXyz(int xyz, int (*outDimorder)[3])
 }
 
 
-void  vlistDefVarXYZ(int vlistID, int varID, int xyz)
+void vlistDefVarXYZ(int vlistID, int varID, int xyz)
 {
   vlistCheckVarID(__func__, vlistID, varID);
 
@@ -1632,228 +1628,6 @@ int vlistInqVarXYZ(int vlistID, int varID)
   return vlistptr->vars[varID].xyz;
 }
 
-/* vlistDefVarIntKey: Set an arbitrary keyword/integer value pair for GRIB API */
-void vlistDefVarIntKey(int vlistID, int varID, const char *name, int value)
-{
-#ifdef HAVE_LIBGRIB_API
-  vlist_t *vlistptr = vlist_to_pointer(vlistID);
-  if (vlistptr == NULL)  Error("Internal error!");
-  int idx;
-
-  if ( vlistptr->immutable )
-    Error("vlistDefVarIntKey() was called on an immutable vlist object (vlistID = %d)\n"
-          "Either call vlistDefVarIntKey() before passing the vlist object to streamDefVlist(),\n"
-          "or use the stream-internal vlist by calling streamInqVlist().", vlistID);
-
-  for ( idx=0; idx<vlistptr->vars[varID].opt_grib_nentries; idx++)
-    if ( (strcmp(name, vlistptr->vars[varID].opt_grib_kvpair[idx].keyword) == 0 ) &&
-         (vlistptr->vars[varID].opt_grib_kvpair[idx].data_type == t_int) )  break;
-
-  if ( idx < vlistptr->vars[varID].opt_grib_nentries )
-    {
-      vlistptr->vars[varID].opt_grib_kvpair[idx].int_val = value;
-      vlistptr->vars[varID].opt_grib_kvpair[idx].update  = true;
-    }
-  else
-    {
-      resize_opt_grib_entries(&vlistptr->vars[varID], vlistptr->vars[varID].opt_grib_nentries+1);
-      vlistptr->vars[varID].opt_grib_nentries += 1;
-      idx = vlistptr->vars[varID].opt_grib_nentries -1;
-      vlistptr->vars[varID].opt_grib_kvpair[idx].data_type   = t_int;
-      vlistptr->vars[varID].opt_grib_kvpair[idx].int_val     = value;
-      vlistptr->vars[varID].opt_grib_kvpair[idx].update      = true;
-      if ( name )
-        vlistptr->vars[varID].opt_grib_kvpair[idx].keyword = strdupx(name);
-      else
-        Error("Internal error, name undefined!");
-    }
-
-  if ( CDI_Debug )
-    {
-      Message("define additional GRIB2 key \"%s\" (integer): %d", name, value);
-      Message("total list of registered, additional GRIB2 keys (total: %d):",
-              vlistptr->vars[varID].opt_grib_nentries);
-      for ( idx=0; idx<vlistptr->vars[varID].opt_grib_nentries; idx++)
-        if (vlistptr->vars[varID].opt_grib_kvpair[idx].data_type == t_int)
-          Message("%s -> integer %d",
-                  vlistptr->vars[varID].opt_grib_kvpair[idx].keyword,
-                  vlistptr->vars[varID].opt_grib_kvpair[idx].int_val);
-        else if (vlistptr->vars[varID].opt_grib_kvpair[idx].data_type == t_double)
-          Message("%s -> double %d",
-                  vlistptr->vars[varID].opt_grib_kvpair[idx].keyword,
-                  vlistptr->vars[varID].opt_grib_kvpair[idx].dbl_val);
-        else
-          Message("%s -> unknown", vlistptr->vars[varID].opt_grib_kvpair[idx].keyword);
-    }
-
-  reshSetStatus(vlistID, &vlistOps, RESH_DESYNC_IN_USE);
-#else
-  (void)vlistID;
-  (void)varID;
-  (void)name;
-  (void)value;
-#endif
-}
-
-/* vlistDefVarDblKey: Set an arbitrary keyword/double value pair for GRIB API */
-void vlistDefVarDblKey(int vlistID, int varID, const char *name, double value)
-{
-#ifdef HAVE_LIBGRIB_API
-  vlist_t *vlistptr = vlist_to_pointer(vlistID);
-  if (vlistptr == NULL)  Error("Internal error!");
-  int idx;
-
-  if ( vlistptr->immutable )
-    Error("vlistDefVarDblKey() was called on an immutable vlist object (vlistID = %d)\n"
-          "Either call vlistDefVarIntKey() before passing the vlist object to streamDefVlist(),\n"
-          "or use the stream-internal vlist by calling streamInqVlist().", vlistID);
-
-  for ( idx=0; idx<vlistptr->vars[varID].opt_grib_nentries; idx++)
-    if ( (strcmp(name, vlistptr->vars[varID].opt_grib_kvpair[idx].keyword) == 0 ) &&
-         (vlistptr->vars[varID].opt_grib_kvpair[idx].data_type == t_double) )  break;
-
-  if ( idx < vlistptr->vars[varID].opt_grib_nentries )
-    {
-      vlistptr->vars[varID].opt_grib_kvpair[idx].dbl_val = value;
-      vlistptr->vars[varID].opt_grib_kvpair[idx].update  = true;
-    }
-  else
-    {
-      resize_opt_grib_entries(&vlistptr->vars[varID], vlistptr->vars[varID].opt_grib_nentries+1);
-      vlistptr->vars[varID].opt_grib_nentries += 1;
-      idx = vlistptr->vars[varID].opt_grib_nentries - 1;
-      vlistptr->vars[varID].opt_grib_kvpair[idx].data_type = t_double;
-      vlistptr->vars[varID].opt_grib_kvpair[idx].dbl_val   = value;
-      vlistptr->vars[varID].opt_grib_kvpair[idx].update    = true;
-      if ( name )
-        vlistptr->vars[varID].opt_grib_kvpair[idx].keyword = strdupx(name);
-      else
-        Error("Internal error, name undefined!");
-    }
-
-  if ( CDI_Debug )
-    {
-      Message("define additional GRIB2 key \"%s\" (double): %d", name, value);
-      Message("total list of registered, additional GRIB2 keys (total: %d):",
-              vlistptr->vars[varID].opt_grib_nentries);
-      for ( idx=0; idx<vlistptr->vars[varID].opt_grib_nentries; idx++)
-        if (vlistptr->vars[varID].opt_grib_kvpair[idx].data_type == t_int)
-          Message("%s -> integer %d",
-                  vlistptr->vars[varID].opt_grib_kvpair[idx].keyword,
-                  vlistptr->vars[varID].opt_grib_kvpair[idx].int_val);
-        else if (vlistptr->vars[varID].opt_grib_kvpair[idx].data_type == t_double)
-          Message("%s -> double %d",
-                  vlistptr->vars[varID].opt_grib_kvpair[idx].keyword,
-                  vlistptr->vars[varID].opt_grib_kvpair[idx].dbl_val);
-        else
-          Message("%s -> unknown", vlistptr->vars[varID].opt_grib_kvpair[idx].keyword);
-    }
-
-  reshSetStatus(vlistID, &vlistOps, RESH_DESYNC_IN_USE);
-#else
-  (void)vlistID;
-  (void)varID;
-  (void)name;
-  (void)value;
-#endif
-}
-
-
-/* cdiClearAdditionalKeys: Clears the list of additional GRIB keys. */
-void cdiClearAdditionalKeys()
-{
-#ifdef HAVE_LIBGRIB_API
-  for (int i = 0; i < cdiNAdditionalGRIBKeys; i++)  Free(cdiAdditionalGRIBKeys[i]);
-  cdiNAdditionalGRIBKeys = 0;
-#endif
-}
-
-/* cdiDefAdditionalKey: Register an additional GRIB key which is read when file is opened. */
-void cdiDefAdditionalKey(const char *name)
-{
-#ifdef HAVE_LIBGRIB_API
-  int idx = cdiNAdditionalGRIBKeys;
-  cdiNAdditionalGRIBKeys++;
-  if ( idx >= MAX_OPT_GRIB_ENTRIES ) Error("Too many additional keywords!");
-  if ( name )
-    cdiAdditionalGRIBKeys[idx] = strdupx(name);
-  else
-    Error("Internal error!");
-#else
-  (void)name;
-#endif
-}
-
-/* vlistHasVarKey: returns 1 if meta-data key was read, 0 otherwise. */
-int vlistHasVarKey(int vlistID, int varID, const char* name)
-{
-#ifdef HAVE_LIBGRIB_API
-  /* check if the GRIB key was previously read and is stored */
-  vlist_t *vlistptr = vlist_to_pointer(vlistID);
-
-  for (int i=0; i<vlistptr->vars[varID].opt_grib_nentries; i++)
-    {
-      if ( strcmp(name, vlistptr->vars[varID].opt_grib_kvpair[i].keyword) == 0 )
-	return 1;
-    }
-#else
-  (void)vlistID;
-  (void)varID;
-  (void)name;
-#endif
-  return 0;
-}
-
-/* vlistInqVarDblKey: raw access to GRIB meta-data */
-double vlistInqVarDblKey(int vlistID, int varID, const char* name)
-{
-  double value = 0;
-#ifdef HAVE_LIBGRIB_API
-  /* check if the GRIB key was previously read and is stored in "opt_grib_dbl_val" */
-  vlist_t *vlistptr = vlist_to_pointer(vlistID);
-
-  for (int i=0; i<vlistptr->vars[varID].opt_grib_nentries; i++)
-    {
-      int isub = subtypeInqActiveIndex(vlistptr->vars[varID].subtypeID);
-      if ( (strcmp(name, vlistptr->vars[varID].opt_grib_kvpair[i].keyword) == 0 ) &&
-           (vlistptr->vars[varID].opt_grib_kvpair[i].data_type == t_double)       &&
-           (vlistptr->vars[varID].opt_grib_kvpair[i].subtype_index == isub) )
-        return vlistptr->vars[varID].opt_grib_kvpair[i].dbl_val;
-    }
-#else
-  (void)vlistID;
-  (void)varID;
-  (void)name;
-#endif
-  return value;
-}
-
-
-/* vlistInqVarIntKey: raw access to GRIB meta-data */
-int vlistInqVarIntKey(int vlistID, int varID, const char* name)
-{
-  long value = 0;
-#ifdef HAVE_LIBGRIB_API
-  /* check if the GRIB key was previously read and is stored in "opt_grib_int_val" */
-  vlist_t *vlistptr = vlist_to_pointer(vlistID);
-
-  for (int i=0; i<vlistptr->vars[varID].opt_grib_nentries; i++)
-    {
-      int isub = subtypeInqActiveIndex(vlistptr->vars[varID].subtypeID);
-      if ( (strcmp(name, vlistptr->vars[varID].opt_grib_kvpair[i].keyword) == 0 ) &&
-           (vlistptr->vars[varID].opt_grib_kvpair[i].data_type == t_int)          &&
-           (vlistptr->vars[varID].opt_grib_kvpair[i].subtype_index == isub) )
-        return vlistptr->vars[varID].opt_grib_kvpair[i].int_val;
-    }
-
-#else
-  (void)vlistID;
-  (void)varID;
-  (void)name;
-#endif
-  return (int) value;
-}
-
 
 void vlistDefVarIOrank(int vlistID, int varID, int iorank)
 {

src/vlist_var_key.c

+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include "cdi.h"
+#include "cdi_int.h"
+#include "vlist.h"
+
+/* vlistDefVarIntKey: Set an arbitrary keyword/integer value pair for GRIB API */
+void vlistDefVarIntKey(int vlistID, int varID, const char *name, int value)
+{
+#ifdef HAVE_LIBGRIB_API
+  vlist_t *vlistptr = vlist_to_pointer(vlistID);
+  if (vlistptr == NULL)  Error("Internal error!");
+  int idx;
+
+  if ( vlistptr->immutable )
+    Error("vlistDefVarIntKey() was called on an immutable vlist object (vlistID = %d)\n"
+          "Either call vlistDefVarIntKey() before passing the vlist object to streamDefVlist(),\n"
+          "or use the stream-internal vlist by calling streamInqVlist().", vlistID);
+
+  for ( idx=0; idx<vlistptr->vars[varID].opt_grib_nentries; idx++)
+    if ( (strcmp(name, vlistptr->vars[varID].opt_grib_kvpair[idx].keyword) == 0 ) &&
+         (vlistptr->vars[varID].opt_grib_kvpair[idx].data_type == t_int) )  break;
+
+  if ( idx < vlistptr->vars[varID].opt_grib_nentries )
+    {
+      vlistptr->vars[varID].opt_grib_kvpair[idx].int_val = value;
+      vlistptr->vars[varID].opt_grib_kvpair[idx].update  = true;
+    }
+  else
+    {
+      resize_opt_grib_entries(&vlistptr->vars[varID], vlistptr->vars[varID].opt_grib_nentries+1);
+      vlistptr->vars[varID].opt_grib_nentries += 1;
+      idx = vlistptr->vars[varID].opt_grib_nentries -1;
+      vlistptr->vars[varID].opt_grib_kvpair[idx].data_type   = t_int;
+      vlistptr->vars[varID].opt_grib_kvpair[idx].int_val     = value;
+      vlistptr->vars[varID].opt_grib_kvpair[idx].update      = true;
+      if ( name )
+        vlistptr->vars[varID].opt_grib_kvpair[idx].keyword = strdupx(name);
+      else
+        Error("Internal error, name undefined!");
+    }
+
+  if ( CDI_Debug )
+    {
+      Message("define additional GRIB2 key \"%s\" (integer): %d", name, value);
+      Message("total list of registered, additional GRIB2 keys (total: %d):",
+              vlistptr->vars[varID].opt_grib_nentries);
+      for ( idx=0; idx<vlistptr->vars[varID].opt_grib_nentries; idx++)
+        if (vlistptr->vars[varID].opt_grib_kvpair[idx].data_type == t_int)
+          Message("%s -> integer %d",
+                  vlistptr->vars[varID].opt_grib_kvpair[idx].keyword,
+                  vlistptr->vars[varID].opt_grib_kvpair[idx].int_val);
+        else if (vlistptr->vars[varID].opt_grib_kvpair[idx].data_type == t_double)
+          Message("%s -> double %d",
+                  vlistptr->vars[varID].opt_grib_kvpair[idx].keyword,
+                  vlistptr->vars[varID].opt_grib_kvpair[idx].dbl_val);
+        else
+          Message("%s -> unknown", vlistptr->vars[varID].opt_grib_kvpair[idx].keyword);
+    }
+
+  reshSetStatus(vlistID, &vlistOps, RESH_DESYNC_IN_USE);
+#else
+  (void)vlistID;
+  (void)varID;
+  (void)name;
+  (void)value;
+#endif
+}
+
+/* vlistDefVarDblKey: Set an arbitrary keyword/double value pair for GRIB API */
+void vlistDefVarDblKey(int vlistID, int varID, const char *name, double value)
+{
+#ifdef HAVE_LIBGRIB_API
+  vlist_t *vlistptr = vlist_to_pointer(vlistID);
+  if (vlistptr == NULL)  Error("Internal error!");
+  int idx;
+
+  if ( vlistptr->immutable )
+    Error("vlistDefVarDblKey() was called on an immutable vlist object (vlistID = %d)\n"
+          "Either call vlistDefVarIntKey() before passing the vlist object to streamDefVlist(),\n"
+          "or use the stream-internal vlist by calling streamInqVlist().", vlistID);
+
+  for ( idx=0; idx<vlistptr->vars[varID].opt_grib_nentries; idx++)
+    if ( (strcmp(name, vlistptr->vars[varID].opt_grib_kvpair[idx].keyword) == 0 ) &&
+         (vlistptr->vars[varID].opt_grib_kvpair[idx].data_type == t_double) )  break;
+
+  if ( idx < vlistptr->vars[varID].opt_grib_nentries )
+    {
+      vlistptr->vars[varID].opt_grib_kvpair[idx].dbl_val = value;
+      vlistptr->vars[varID].opt_grib_kvpair[idx].update  = true;
+    }
+  else
+    {
+      resize_opt_grib_entries(&vlistptr->vars[varID], vlistptr->vars[varID].opt_grib_nentries+1);
+      vlistptr->vars[varID].opt_grib_nentries += 1;
+      idx = vlistptr->vars[varID].opt_grib_nentries - 1;
+      vlistptr->vars[varID].opt_grib_kvpair[idx].data_type = t_double;
+      vlistptr->vars[varID].opt_grib_kvpair[idx].dbl_val   = value;
+      vlistptr->vars[varID].opt_grib_kvpair[idx].update    = true;
+      if ( name )
+        vlistptr->vars[varID].opt_grib_kvpair[idx].keyword = strdupx(name);
+      else
+        Error("Internal error, name undefined!");
+    }
+
+  if ( CDI_Debug )
+    {
+      Message("define additional GRIB2 key \"%s\" (double): %d", name, value);
+      Message("total list of registered, additional GRIB2 keys (total: %d):",
+              vlistptr->vars[varID].opt_grib_nentries);
+      for ( idx=0; idx<vlistptr->vars[varID].opt_grib_nentries; idx++)
+        if (vlistptr->vars[varID].opt_grib_kvpair[idx].data_type == t_int)
+          Message("%s -> integer %d",
+                  vlistptr->vars[varID].opt_grib_kvpair[idx].keyword,
+                  vlistptr->vars[varID].opt_grib_kvpair[idx].int_val);
+        else if (vlistptr->vars[varID].opt_grib_kvpair[idx].data_type == t_double)
+          Message("%s -> double %d",
+                  vlistptr->vars[varID].opt_grib_kvpair[idx].keyword,
+                  vlistptr->vars[varID].opt_grib_kvpair[idx].dbl_val);
+        else
+          Message("%s -> unknown", vlistptr->vars[varID].opt_grib_kvpair[idx].keyword);
+    }
+
+  reshSetStatus(vlistID, &vlistOps, RESH_DESYNC_IN_USE);
+#else
+  (void)vlistID;
+  (void)varID;
+  (void)name;
+  (void)value;
+#endif
+}
+
+
+/* cdiClearAdditionalKeys: Clears the list of additional GRIB keys. */
+void cdiClearAdditionalKeys()
+{
+#ifdef HAVE_LIBGRIB_API
+  for (int i = 0; i < cdiNAdditionalGRIBKeys; i++)  free(cdiAdditionalGRIBKeys[i]);
+  cdiNAdditionalGRIBKeys = 0;
+#endif
+}
+
+/* cdiDefAdditionalKey: Register an additional GRIB key which is read when file is opened. */
+void cdiDefAdditionalKey(const char *name)
+{
+#ifdef HAVE_LIBGRIB_API
+  int idx = cdiNAdditionalGRIBKeys;
+  cdiNAdditionalGRIBKeys++;
+  if ( idx >= MAX_OPT_GRIB_ENTRIES ) Error("Too many additional keywords!");
+  if ( name )
+    cdiAdditionalGRIBKeys[idx] = strdupx(name);
+  else
+    Error("Internal error!");
+#else
+  (void)name;
+#endif
+}
+
+/* vlistHasVarKey: returns 1 if meta-data key was read, 0 otherwise. */
+int vlistHasVarKey(int vlistID, int varID, const char* name)
+{
+#ifdef HAVE_LIBGRIB_API
+  /* check if the GRIB key was previously read and is stored */
+  vlist_t *vlistptr = vlist_to_pointer(vlistID);
+
+  for (int i=0; i<vlistptr->vars[varID].opt_grib_nentries; i++)
+    {
+      if ( strcmp(name, vlistptr->vars[varID].opt_grib_kvpair[i].keyword) == 0 )
+	return 1;
+    }
+#else
+  (void)vlistID;
+  (void)varID;
+  (void)name;
+#endif
+  return 0;
+}
+
+/* vlistInqVarDblKey: raw access to GRIB meta-data */
+double vlistInqVarDblKey(int vlistID, int varID, const char* name)
+{
+  double value = 0;
+#ifdef HAVE_LIBGRIB_API
+  /* check if the GRIB key was previously read and is stored in "opt_grib_dbl_val" */
+  vlist_t *vlistptr = vlist_to_pointer(vlistID);
+
+  for (int i=0; i<vlistptr->vars[varID].opt_grib_nentries; i++)
+    {
+      int isub = subtypeInqActiveIndex(vlistptr->vars[varID].subtypeID);
+      if ( (strcmp(name, vlistptr->vars[varID].opt_grib_kvpair[i].keyword) == 0 ) &&
+           (vlistptr->vars[varID].opt_grib_kvpair[i].data_type == t_double)       &&
+           (vlistptr->vars[varID].opt_grib_kvpair[i].subtype_index == isub) )
+        return vlistptr->vars[varID].opt_grib_kvpair[i].dbl_val;
+    }
+#else
+  (void)vlistID;
+  (void)varID;
+  (void)name;
+#endif
+  return value;
+}
+
+
+/* vlistInqVarIntKey: raw access to GRIB meta-data */
+int vlistInqVarIntKey(int vlistID, int varID, const char* name)
+{
+  long value = 0;
+#ifdef HAVE_LIBGRIB_API
+  /* check if the GRIB key was previously read and is stored in "opt_grib_int_val" */
+  vlist_t *vlistptr = vlist_to_pointer(vlistID);
+
+  for (int i=0; i<vlistptr->vars[varID].opt_grib_nentries; i++)
+    {
+      int isub = subtypeInqActiveIndex(vlistptr->vars[varID].subtypeID);
+      if ( (strcmp(name, vlistptr->vars[varID].opt_grib_kvpair[i].keyword) == 0 ) &&
+           (vlistptr->vars[varID].opt_grib_kvpair[i].data_type == t_int)          &&
+           (vlistptr->vars[varID].opt_grib_kvpair[i].subtype_index == isub) )
+        return vlistptr->vars[varID].opt_grib_kvpair[i].int_val;
+    }
+
+#else
+  (void)vlistID;
+  (void)varID;
+  (void)name;
+#endif
+  return (int) value;
+}
+
+/*
+ * Local Variables:
+ * c-file-style: "Java"
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * show-trailing-whitespace: t
+ * require-trailing-newline: t
+ * End:
+ */