Changeset 7901

Timestamp:

Jul 13, 2006, 4:26:25 PM (20 years ago)

Author:

drobbin

Message:

Added str check test for error handling of psString fxns, namely stringSubstitute. Edited memory and type to include MemCheck's for string, line, and region. Added is_psType function to check for NULLs and native types first. <-will have to update all fxns next wrt to this change. Added psStringAlloc, stringFree, regionFree. Added doxygen comments.

Location:

trunk/psLib

Files:

• src/math/psRegion.c (modified) (3 diffs)
• src/math/psRegion.h (modified) (2 diffs)
• src/sys/psLine.c (modified) (2 diffs)
• src/sys/psLine.h (modified) (3 diffs)
• src/sys/psMemory.c (modified) (6 diffs)
• src/sys/psMemory.h (modified) (2 diffs)
• src/sys/psString.c (modified) (3 diffs)
• src/sys/psString.h (modified) (3 diffs)
• src/sys/psType.h (modified) (2 diffs)
• test/sys/Makefile.am (modified) (2 diffs)
• test/sys/tst_psLine.c (added)
• test/sys/tst_psString.c (modified) (4 diffs)
• test/sys/verified/tst_psString.stderr (modified) (1 diff)
• test/types/verified/tst_psMetadata_06.stdout (modified) (1 diff)

trunk/psLib/src/math/psRegion.c

@@ -6 +6 @@
 #include "psRegion.h"
 
+static void regionFree(psRegion *region)
+{
+    // There are non dynamic allocated items
+}
+
 psRegion *psRegionAlloc(float x0,
                         float x1,
@@ -12 +17 @@
 {
     psRegion *region = psAlloc(sizeof(psRegion)); // New region, to be returned
+    psMemSetDeallocator(region, (psFreeFunc)regionFree);
     // No complex structures, so no special deallocator
     *region = psRegionSet(x0, x1, y0, y1);
@@ -101 +107 @@
 }
 
+bool psMemCheckRegion(psPtr ptr)
+{
+    if (!is_psType(ptr)) {
+        return false;
+    }
+    return ( psMemGetDeallocator(ptr) == (psFreeFunc)regionFree );
+}
+
+

trunk/psLib/src/math/psRegion.h

@@ -27 +27 @@
                         float y1        ///< the last row of the region + 1.
                        );
+
+/** Checks the type of a particular pointer.
+ *
+ *  Uses the appropriate deallocation function in psMemBlock to check the ptr datatype.
+ *
+ *  @return bool:       True if the pointer matches a psRegion structure, false otherwise.
+ */
+bool psMemCheckRegion(
+    psPtr ptr                          ///< the pointer whose type to check
+);
 
 /** Create a psRegion with the specified attributes.
@@ -70 +80 @@
 );
 
-// Test if any element of the region is NaN
-bool psRegionIsNaN(psRegion region// Region to check
-                  );
+/** Test if any element of the region is NaN
+ *
+ * @return bool:        True if an element is NaN, otherwise false.
+ */
+bool psRegionIsNaN(
+    psRegion region                    ///< Region to check
+);
 
 #endif

trunk/psLib/src/sys/psLine.c

@@ -39 +39 @@
 }
 
-bool psLineAdd(psLine *line, const char *format, ...)
+bool psLineAdd(psLine *line,
+               const char *format,
+               ...)
 {
     if (!line) {
@@ -58 +60 @@
     return true;
 }
+
+bool psMemCheckLine(psPtr ptr)
+{
+    if (!is_psType(ptr)) {
+        return false;
+    }
+    return ( psMemGetDeallocator(ptr) == (psFreeFunc)lineFree );
+}
+

trunk/psLib/src/sys/psLine.h

@@ -1 +1 @@
 /** @file  psLine.h
  *
- * the psLine functions allow manipulation of fixed-length lines
+ *
+ *  @brief Contains the declarations of line utility functions
+ *
+ *  @ingroup SysUtils
+ *
+ *  The psLine functions allow manipulation of fixed-length lines.
+ *
+ *  @author Paul Price, IFA
+ *  @author David Robbins, MHPCC
+ *
+ *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-07-14 02:26:25 $
+ *
+ *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
  */
 
 #ifndef PS_LINE_H
 #define PS_LINE_H
+
+/** @addtogroup SysUtils
+ *  @{
+ */
 
 /** Structure to carry a dynamic string */
@@ -16 +33 @@
 psLine;
 
-/** Allocates a line object of length Nline
+/** Allocates a line object of length Nline.
  *
  *  @return psLine*:        the newly allocated line object.
 */
 psLine *psLineAlloc(
-    long Nline                         ///<
+    long Nline                         ///< length of line object to allocate
+);
+
+/** Checks the type of a particular pointer.
+ *
+ *  Uses the appropriate deallocation function in psMemBlock to check the ptr datatype.
+ *
+ *  @return bool:       True if the pointer matches a psLine structure, false otherwise.
+ */
+bool psMemCheckLine(
+    psPtr ptr                          ///< the pointer whose type to check
 );
 
@@ -32 +59 @@
 */
 bool psLineInit(
-    psLine *line                       ///<
+    psLine *line                       ///< line to (re-)initialize
 );
 

trunk/psLib/src/sys/psMemory.c

@@ -8 +8 @@
 *  @author Robert Lupton, Princeton University
 *
-*  @version $Revision: 1.73 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2006-06-21 21:40:12 $
+*  @version $Revision: 1.74 $ $Name: not supported by cvs2svn $
+*  @date $Date: 2006-07-14 02:26:25 $
 *
 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -24 +24 @@
 #include "psAbort.h"
 #include "psLogMsg.h"
-
 #include "psBitSet.h"
-//#include "psArray.h"
-//#include "psImage.h"
-//#include "psList.h"
-//#include "psLookupTable.h"
-//#include "psHash.h"
-
-//#include "psMetadata.h"
 #include "psFits.h"
 #include "psPixels.h"
-//#include "psScalar.h"
-//#include "psVector.h"
-//#include "psTime.h"
-//#include "psCoord.h"
 #include "psSphereOps.h"
-//#include "psStats.h"
 #include "psMinimizeLMM.h"
 #include "psImageConvolve.h"
 #include "psTime.h"
-
+#include "psLine.h"
+#include "psRegion.h"
 #include "psErrorText.h"
 
@@ -837 +825 @@
 }
 
+bool is_psType(psPtr ptr)
+{
+    if (ptr == NULL) {
+        return false;
+    }
+    psMemBlock* m = ((psMemBlock* ) ptr) - 1;
+    if (m->startblock != P_PS_MEMMAGIC || m->endblock != P_PS_MEMMAGIC) {
+        return false; //Probably not a psAllocated-Type
+    } else {
+        return true;
+    }
+}
+
 bool psMemCheckType(psDataType type,
                     psPtr ptr)
 {
+    if (!is_psType(ptr)) {
+        return false;
+    }
+
     switch(type) {
     case PS_DATA_ARRAY:
@@ -905 +910 @@
             break;
         }
+    case PS_DATA_LINE:
+        if ( psMemCheckLine(ptr) )
+            return true;
+        else {
+            psError(PS_ERR_BAD_PARAMETER_VALUE, false,
+                    "Incorrect pointer.  Datatypes do not match.\n");
+            break;
+        }
     case PS_DATA_LIST:
         if ( psMemCheckList(ptr) )
@@ -1017 +1030 @@
             break;
         }
+    case PS_DATA_REGION:
+        if ( psMemCheckRegion(ptr) )
+            return true;
+        else {
+            psError(PS_ERR_BAD_PARAMETER_VALUE, false,
+                    "Incorrect pointer.  Datatypes do not match.\n");
+            break;
+        }
     case PS_DATA_SCALAR:
         if ( psMemCheckScalar(ptr) )
@@ -1051 +1072 @@
     case PS_DATA_STATS:
         if ( psMemCheckStats(ptr) )
+            return true;
+        else {
+            psError(PS_ERR_BAD_PARAMETER_VALUE, false,
+                    "Incorrect pointer.  Datatypes do not match.\n");
+            break;
+        }
+    case PS_DATA_STRING:
+        if ( psMemCheckString(ptr) )
             return true;
         else {

trunk/psLib/src/sys/psMemory.h

@@ -12 +12 @@
  *  @ingroup MemoryManagement
  *
- *  @version $Revision: 1.56 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2006-06-21 21:40:12 $
+ *  @version $Revision: 1.57 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-07-14 02:26:25 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -172 +172 @@
 );
 
+bool is_psType(
+    psPtr ptr
+);
+
 /** Checks the deallocator to see if the pointer matches the desired datatype.
  *

trunk/psLib/src/sys/psString.c

@@ -13 +13 @@
  *  @author David Robbins, MHPCC
  *
- *  @version $Revision: 1.36 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2006-07-12 21:17:51 $
+ *  @version $Revision: 1.37 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-07-14 02:26:25 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -30 +30 @@
 #include "psErrorText.h"
 
+static void stringFree(psString string)
+{
+    // There is non dynamic allocated item
+}
+
+psString psStringAlloc(long nChar)
+{
+    if (nChar < 1) {
+        return NULL;
+    }
+    psString string = psAlloc(nChar + 1);
+    psMemSetDeallocator(string, (psFreeFunc)stringFree);
+    return string;
+}
+
+bool psMemCheckString(psPtr ptr)
+{
+    if (!is_psType(ptr)) {
+        return false;
+    }
+    return ( psMemGetDeallocator(ptr) == (psFreeFunc)stringFree );
+}
+
 psString psStringCopy(const char *string)
 {
@@ -231 +254 @@
         return input;
     }
+    if (!psMemCheckString(input)) {
+        return input;
+    }
+
 
     // replace == NULL is valid: it just means that we strip out the key

trunk/psLib/src/sys/psString.h

@@ -14 +14 @@
  *  @author David Robbins, MHPCC
  *
- *  @version $Revision: 1.25 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2006-07-10 20:15:43 $
+ *  @version $Revision: 1.26 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-07-14 02:26:25 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -39 +39 @@
  *  @{
  */
+
+/** Allocates a new psString.
+ *
+ *  @return psString:       Newly allocated string of length n.
+ */
+psString psStringAlloc(
+    long nChar                         ///< Size of psString to allocate.
+);
+
+/** Checks the type of a particular pointer.
+ *
+ *  Uses the appropriate deallocation function in psMemBlock to check the ptr datatype.
+ *
+ *  @return bool:       True if the pointer matches a psString structure, false otherwise.
+ */
+bool psMemCheckString(
+    psPtr ptr                          ///< the pointer whose type to check
+);
 
 /** Copies the input string
@@ -145 +163 @@
 );
 
-
 /** @} */// Doxygen - End of SystemGroup Functions
 

trunk/psLib/src/sys/psType.h

@@ -10 +10 @@
 *  @author Ross Harman, MHPCC
 *
-*  @version $Revision: 1.50 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2006-06-10 02:28:17 $
+*  @version $Revision: 1.51 $ $Name: not supported by cvs2svn $
+*  @date $Date: 2006-07-14 02:26:25 $
 *
 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -118 +118 @@
     PS_DATA_IMAGE,                     ///< psImage
     PS_DATA_KERNEL,                    ///< psKernel
+    PS_DATA_LINE,                      ///< psLine
     PS_DATA_LIST,                      ///< psList
     PS_DATA_LOOKUPTABLE,               ///< psLookupTable

trunk/psLib/test/sys/Makefile.am

@@ -12 +12 @@
         tst_psString \
         tst_psTrace \
-        tap_psStringSubstitute
+        tap_psStringSubstitute \
+        tst_psLine
 
 tst_psAbort_SOURCES =  tst_psAbort.c
@@ -21 +22 @@
 tst_psString_SOURCES =  tst_psString.c
 tst_psTrace_SOURCES =  tst_psTrace.c
+tst_psLine_SOURCES =  tst_psLine.c
 
 tap_psStringSubstitute_CPPFLAGS = $(AM_CPPFLAGS) -I$(top_srcdir)/test/tap/src

trunk/psLib/test/sys/tst_psString.c

@@ -20 +20 @@
  *  @author  Eric Van Alst, MHPCC
  *
- *  @version $Revision: 1.10 $  $Name: not supported by cvs2svn $
- *  @date  $Date: 2006-07-12 21:25:39 $
+ *  @version $Revision: 1.11 $  $Name: not supported by cvs2svn $
+ *  @date  $Date: 2006-07-14 02:26:25 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -53 +53 @@
 static psS32 testStrSplit00(void);
 static psS32 testNULLStrings(void);
+static psS32 testStrCheck(void);
 
 testDescription tests[] = {
@@ -74 +75 @@
                               {testStrSplit00,15, "Test String Splitting", 0, false},
                               {testNULLStrings,666, "Test NULL String Error Handling", 0, false},
+                              {testStrCheck,16, "Test String Allocation and MemCheck", 0, false},
                               {NULL}
                           };
@@ -709 +711 @@
     return 0;
 }
+
+psS32 testStrCheck(void)
+{
+    psString str = NULL;
+    str = psStringAlloc(10);
+    strcpy(str, "Hello");
+    if (!psMemCheckString(str)) {
+        psError(PS_ERR_BAD_PARAMETER_VALUE, true,
+                "psString wasn't properly allocated!\n");
+        return 1;
+    }
+    if (!psMemCheckType(PS_DATA_STRING, str)) {
+        psError(PS_ERR_BAD_PARAMETER_VALUE, true,
+                "psString wasn't properly allocated!\n");
+        return 2;
+    }
+    psFree(str);
+
+    char charStr[10];
+    if (psMemCheckType(PS_DATA_STRING, charStr)) {
+        psError(PS_ERR_BAD_PARAMETER_VALUE, true,
+                "Input string is not a psDataType!!!  (Should have returned false)\n");
+        return 3;
+    }
+
+    return 0;
+}
+

trunk/psLib/test/sys/verified/tst_psString.stderr

@@ -175 +175 @@
 ---> TESTPOINT PASSED (psString{Test NULL String Error Handling} | tst_psString.c)
 
+/***************************** TESTPOINT ******************************************\
+*             TestFile: tst_psString.c                                             *
+*            TestPoint: psString{Test String Allocation and MemCheck}              *
+*             TestType: Positive                                                   *
+\**********************************************************************************/
+
+
+---> TESTPOINT PASSED (psString{Test String Allocation and MemCheck} | tst_psString.c)
+

trunk/psLib/test/types/verified/tst_psMetadata_06.stdout

@@ -9 +9 @@
 Key Name:  myItem1  Key mdType: 0x00000104  Key Value:             222  Key Comment: I am a signed integer
 Key Name:  myItem2  Key mdType: 0x00000104  Key Value:             333  Key Comment: I am a signed integer
-Key Name:  myItem2  Key mdType: 0x00010009  Key Value:          psList  Key Comment: I am a list
+Key Name:  myItem2  Key mdType: 0x0001000a  Key Value:          psList  Key Comment: I am a list
 
 ---> TESTPOINT PASSED (psMetadata{Test A - Allocate metadata and items} | tst_psMetadata_06.c)