Changeset 12532

Timestamp:

Mar 21, 2007, 3:14:52 PM (19 years ago)

Author:

magnier

Message:

adding psMetadataUpdate function and tests, additional PS_META_.. entries to match

Location:

trunk/psLib

Files:

• src/types/psMetadata.c (modified) (5 diffs)
• src/types/psMetadata.h (modified) (3 diffs)
• test/types (modified) (1 prop)
• test/types/.cvsignore (modified) (1 diff)
• test/types/Makefile.am (modified) (1 diff)
• test/types/tap_psMetadataUpdate.c (added)

trunk/psLib/src/types/psMetadata.c

@@ -12 +12 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.155 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2007-03-16 01:46:56 $
+ *  @version $Revision: 1.156 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2007-03-22 01:14:52 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -463 +463 @@
         psMetadataItem *newItem = psMetadataItemCopy(inItem); // Copied item
         if (!psMetadataAddItem(out, newItem, PS_LIST_TAIL, flag)) {
-            psErrorStackPrint(stderr, "Error copying %s (%s) in the metadata\n", inItem->name,
-                              inItem->comment);
+            psError(PS_ERR_UNKNOWN, false, "Error copying %s (%s) in the metadata\n", 
+                    inItem->name, inItem->comment);
             if (outAlloced) {
                 psFree(out);
@@ -483 +483 @@
 
     return out;
+}
+
+// this function copies the input metadata to the output, raising an error
+// if any entries in 'in' a) do not exist in 'out' or b) have a different type
+bool p_psMetadataUpdate(const char *file,
+                        unsigned int lineno,
+                        const char *func,
+                        psMetadata *out,
+                        const psMetadata *in)
+{
+    PS_ASSERT_METADATA_NON_NULL(in, NULL);
+    PS_ASSERT_METADATA_NON_NULL(out, NULL);
+
+    psMetadataIterator *iter = psMetadataIteratorAlloc(in, PS_LIST_HEAD, NULL);
+    psMetadataItem *inItem = NULL;
+    while ((inItem = psMetadataGetAndIncrement(iter))) {
+        // Need to look for MULTI, which won't be picked up using the iterator.
+        psMetadataItem *multiCheckItem = psMetadataLookup(in, inItem->name);
+        unsigned int flag = PS_META_REPLACE | PS_META_REQUIRE_ENTRY | PS_META_REQUIRE_TYPE; // Flag to indicate MULTI; otherwise, replace
+        if (multiCheckItem->type == PS_DATA_METADATA_MULTI) {
+            psTrace("psLib.types", 10, "MULTI: %s (%s)\n", inItem->name, inItem->comment);
+            flag = PS_META_DUPLICATE_OK | PS_META_REQUIRE_ENTRY | PS_META_REQUIRE_TYPE;
+        }
+        psTrace("psLib.types", 5, "Copying %s (%s)...\n", inItem->name, inItem->comment);
+
+        // Copy the item and add it on
+        psMetadataItem *newItem = psMetadataItemCopy(inItem); // Copied item
+        if (!psMetadataAddItem(out, newItem, PS_LIST_TAIL, flag)) {
+            psError(PS_ERR_UNKNOWN, false, "Error copying %s (%s) in the metadata\n", 
+                    inItem->name, inItem->comment);
+            psFree(newItem);
+            psFree(iter);
+            return false;
+        }
+        psFree(newItem);                // Drop reference
+    }
+    psFree(iter);
+    return true;
 }
 
@@ -572 +610 @@
         } else if ((flags & PS_META_REPLACE) != 0) {
             // replace entry instead of creating a duplicate entry.
+
+            if ((flags & PS_META_REQUIRE_TYPE) && (existingEntry->type != item->type)) {
+                psError (PS_ERR_UNKNOWN, true, _("existing item does not match type for item requiring matching type"));
+                return false;
+            }
 
             // remove the existing entry from metadata
@@ -601 +644 @@
     } else {
         // OK, this is a new item.
+        if (flags & PS_META_REQUIRE_ENTRY) {
+            psError (PS_ERR_UNKNOWN, true, _("no matching item found for item requiring existing entry"));
+            return false;
+        }
 
         // Node doesn't exist - Add new metadata item to metadata collection's hash

trunk/psLib/src/types/psMetadata.h

@@ -9 +9 @@
 *  @author Ross Harman, MHPCC
 *
-*  @version $Revision: 1.100 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2007-03-17 02:38:53 $
+*  @version $Revision: 1.101 $ $Name: not supported by cvs2svn $
+*  @date $Date: 2007-03-22 01:14:52 $
 *
 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -61 +61 @@
     PS_META_NO_REPLACE = 0x2000000,    ///< duplicate entry is silently skipped
     PS_META_DUPLICATE_OK = 0x4000000,  ///< allow duplicate entries
-    PS_META_NULL = 0x8000000           ///< psMetadataItem.data is a NULL value
+    PS_META_NULL = 0x8000000,           ///< psMetadataItem.data is a NULL value
+    PS_META_REQUIRE_ENTRY = 0x10000000, ///< require pre-existing entry with same name
+    PS_META_REQUIRE_TYPE = 0x20000000   ///< require pre-existing entry to have same type
 } psMetadataFlags;
 
@@ -480 +482 @@
 
 
+/** Updates an existing psMetadata collection with elements from a metadata collection
+ *
+ *  Creates a new copy of all the psMetadataItems in the psMetadata collection 'in' and places
+ *  them in out.  all items in 'in' must already be in 'out' and be of the same type.
+ *
+ *  @return psMetadata*:        the copy of the psMetadata container.
+ */
+#ifdef DOXYGEN
+bool psMetadataUpdate(
+    psMetadata *out,                   ///< output Metadata container for copying.
+    const psMetadata *in               ///< Metadata collection to be copied.
+    );
+#else // ifdef DOXYGEN
+bool p_psMetadataUpdate(
+    const char *file,                   ///< File of caller
+    unsigned int lineno,                ///< Line number of caller
+    const char *func,                   ///< Function name of caller
+    psMetadata *out,                    ///< output Metadata container for copying.
+    const psMetadata *in                ///< Metadata collection to be copied.
+    );
+#define psMetadataUpdate(out, in) \
+      p_psMetadataUpdate(__FILE__, __LINE__, __func__, out, in)
+#endif // ifdef DOXYGEN
+
+
 /** Supplements a metadata with an item from another metadata.
  *

trunk/psLib/test/types

@@ -72 +72 @@
 tap_psMetadata_printing
 tap_psPixels_all
+tap_psMetadataUpdate

@@ -72 +72 @@
 tap_psMetadata_printing
 tap_psPixels_all
+tap_psMetadataUpdate

trunk/psLib/test/types/.cvsignore

@@ -74 +74 @@
 tap_psMetadata_printing
 tap_psPixels_all
+
+tap_psMetadataUpdate

trunk/psLib/test/types/Makefile.am

@@ -18 +18 @@
         tap_psMetadataItemCompare \
         tap_psMetadataItemParse \
+        tap_psMetadataUpdate \
         tap_psMetadata_printing \
         tap_psMetadata_copying \

@@ -72 +72 @@
 tap_psMetadata_printing
 tap_psPixels_all
+tap_psMetadataUpdate