Changeset 139

Timestamp:

Mar 4, 2004, 4:57:24 PM (22 years ago)

Author:

rhl

Message:

Changed [Rr]efCntr to [Rr]efCounter

File:

• trunk/doc/draft/utils.tex (modified) (9 diffs)

trunk/doc/draft/utils.tex

@@ -359 +359 @@
 The API for this field is:
 \begin{verbatim}
-int psMemGetRefCntr(void *vptr);        // return refcntr
-void *psMemIncrRefCntr(void *vptr);     // increment refcntr and return vptr
-void *psMemDecrRefCntr(void *vptr);     // decrement refcntr and return vptr
-\end{verbatim}
-
-The functions \code{psMemIncrRefCntr} and \code{psMemDecrRefCntr} shall
+int psMemGetRefCounter(void *vptr);        // return refcounter
+void *psMemIncrRefCounter(void *vptr);     // increment refcounter and return vptr
+void *psMemDecrRefCounter(void *vptr);     // decrement refcounter and return vptr
+\end{verbatim}
+
+The functions \code{psMemIncrRefCounter} and \code{psMemDecrRefCounter} shall
 return \code{NULL} if passed a \code{NULL} pointer.
 
@@ -389 +389 @@
     if (simp == NULL) { return; }
 
-    if (psMemGetRefCntr(simp) > 1) {
-        (void)psMemDecrRefCntr(simp);
+    if (psMemGetRefCounter(simp) > 1) {
+        (void)psMemDecrRefCounter(simp);
         return;
     }
@@ -401 +401 @@
 \end{table}
 
-The \code{psMemBlock.refcntr} is clearly useful for detecting
+The \code{psMemBlock.refcounter} is clearly useful for detecting
 attempts to free memory that is already free.  A more complex
 application is for allowing pointers to complex data-objects (e.g.
@@ -407 +407 @@
 (see table \ref{tabReferenceCounting}).
 
-Because of the use of the \code{refcntr} field, we can safely put items of
+Because of the use of the \code{refcounter} field, we can safely put items of
 this type onto many lists:
 \goodbreak
 \begin{verbatim}
 simp = psSimpleNew("RHL", 0);
-psDlistAppend(list1, psMemIncrRefCntr(simp));
-psDlistAppend(list2, psMemIncrRefCntr(simp));
+psDlistAppend(list1, psMemIncrRefCounter(simp));
+psDlistAppend(list2, psMemIncrRefCounter(simp));
 psSimpleDel(simp);
 \end{verbatim}
@@ -695 +695 @@
 
 All data items placed onto lists (e.g. with \code{psDlistAdd})
-shall have their reference counters (section \ref{secMemRefcntr}) incremented.
+shall have their reference counters (section \ref{secMemRefcounter}) incremented.
 When elements
 are removed from a list with \code{psDlistRemove}, they shall
@@ -704 +704 @@
 If \code{psDlistDel}'s argument \code{elemDel} is NULL, the
 list should be deleted, but not the elements on it (although their
-\code{refcntr}'s should be decremented).
+\code{refcounter}'s should be decremented).
 
 The \code{psDlistGet} routine may be used to provide an iterator. The
@@ -801 +801 @@
 source file for a given type).
 
-The objects pointed to by these types have had their \code{refCntr}s
-incremented (see \ref{secMemRefcntr}); to remove an element from the array you
+The objects pointed to by these types have had their \code{refCounter}s
+incremented (see \ref{secMemRefcounter}); to remove an element from the array you
 need to say something like:
 \begin{verbatim}
   psTypePtrArray *pt = psTypePtrArrayNew(10, 10);
-  psType *xy = psMemDecrRefCntr(pt->arr[0]);
+  psType *xy = psMemDecrRefCounter(pt->arr[0]);
   pt->arr[0] = NULL;
 \end{verbatim}
@@ -832 +832 @@
 had their reference counters incremented
 when they were inserted onto the array.\footnote{%
-  \eg{} \code{va->arr[i] = psMemIncrRefCntr(ptr);}}
+  \eg{} \code{va->arr[i] = psMemIncrRefCounter(ptr);}}
 
 If \code{psVoidPtrArrayDel}'s argument \code{elemDel} is NULL, the
 list should be deleted, but not the elements on it (although their
-\code{refcntr}'s should be decremented).
+\code{refcounter}'s should be decremented).
 
 \subsection{Examples of Array Types}
@@ -885 +885 @@
     psXYArrayDel(t);
 
-    psXY *xy = psMemDecrRefCntr(pt->arr[0]);
+    psXY *xy = psMemDecrRefCounter(pt->arr[0]);
     pt->arr[0] = NULL;
     psXYDel(xy);