Changeset 4252

Timestamp:

Jun 14, 2005, 10:28:53 AM (21 years ago)

Author:

Paul Price

Message:

Changed void * to psPtr

Location:

trunk/doc/pslib

Files:

• ChangeLogSDRS.tex (modified) (2 diffs)
• psLibSDRS.tex (modified) (7 diffs)

trunk/doc/pslib/ChangeLogSDRS.tex

@@ -1 @@
-%%% $Id: ChangeLogSDRS.tex,v 1.138 2005-06-14 03:07:19 price Exp $
+%%% $Id: ChangeLogSDRS.tex,v 1.139 2005-06-14 20:28:53 price Exp $
 
 \subsection{Changes from version 00 to version 01}
@@ -706 +706 @@
   include most psLib structures.  \code{PS_META_MULTI} changed to
   \code{PS_DATA_METADATA_MULTI}.
-\item Changed some \code{char *} to \code{psString}, as appropriate.
-  Noted that metadata functions must copy strings in to a
-  \code{psMetadataItem}.
-\end{itemize}
+\item Added policy on \code{psPtr, psString}, Changed some \code{void
+  *} to \code{psPtr} and some \code{char *} to \code{psString}, as
+  appropriate.  Noted that metadata functions must copy strings in to
+  a \code{psMetadataItem}.
+\end{itemize}

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.280 2005-06-14 03:31:44 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.281 2005-06-14 20:28:53 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -956 +956 @@
 to pass around both the structure and a mutex, or wrap PSLib
 structures in their own thread-safe structures that contain a mutex.
+PSLib is not responsible for freeing the \code{lock} (it may not even
+be allocated using the PSLib memory management system) --- it is
+entirely the responsibility of the user and PSLib provides only a
+place to hang it.
 
 We also define the following conveniences:
@@ -1555 +1559 @@
     const long n;                       ///< size of array 
     const long nalloc;                  ///< allocated data block
-    void **data;                        ///< pointer to data block
+    psPtr *data;                        ///< pointer to data block
     void *lock;                         ///< Optional lock for thread safety
 }} psArray;
@@ -1660 +1664 @@
    struct psListElem *prev;            ///< previous link in list
    struct psListElem *next;            ///< next link in list
-   void *data;                         ///< real data item
+   psPtr data;                         ///< real data item
 } psListElem;
 \end{datatype}
@@ -1866 +1870 @@
 typedef struct psHashBucket {
     char *key;                          ///< key for this item of data
-    void *data;                         ///< the data itself
+    psPtr data;                         ///< the data itself
     struct psHashBucket *next;          ///< list of other possible keys
 } psHashBucket;
@@ -2910 +2914 @@
 } psMath;
 \end{datatype}
-
-\tbd{Why do we need this?  Can't we use psMathType instead?}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -3657 +3659 @@
 
 \begin{prototype}
-void *psFitsReadTableRowRaw(size_t *size, const psFits *fits, int row);
+psPtr psFitsReadTableRowRaw(size_t *size, const psFits *fits, int row);
 \end{prototype}
 This function reads a single row of the table in the extension pointed