Index: trunk/psLib/src/types/psList.c =================================================================== --- trunk/psLib/src/types/psList.c (revision 11704) +++ trunk/psLib/src/types/psList.c (revision 11705) @@ -5,7 +5,8 @@ * @author Robert Lupton, Princeton University * @author Robert Daniel DeSonia, MHPCC + * @author Joshua Hoblitt, University of Hawaii * - * @version $Revision: 1.60 $ $Name: not supported by cvs2svn $ - * @date $Date: 2007-02-06 21:36:09 $ + * @version $Revision: 1.61 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-02-08 04:35:35 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -18,4 +19,5 @@ #include #include + #include "psError.h" #include "psAbort.h" @@ -121,7 +123,10 @@ } -psList* psListAlloc(psPtr data) -{ - psList* list = psAlloc(sizeof(psList)); +psList* p_psListAlloc(const char *file, + unsigned int lineno, + const char *func, + psPtr data) +{ + psList* list = p_psAlloc(file, lineno, func, sizeof(psList)); psMemSetDeallocator(list, (psFreeFunc) listFree); @@ -147,5 +152,8 @@ } -psListIterator* psListIteratorAlloc(psList* list, +psListIterator* p_psListIteratorAlloc(const char *file, + unsigned int lineno, + const char *func, + psList* list, long location, bool mutable) @@ -156,5 +164,5 @@ return false; } - psListIterator* iter = psAlloc(sizeof(psListIterator)); + psListIterator* iter = p_psAlloc(file, lineno, func, sizeof(psListIterator)); psMemSetDeallocator(iter, (psFreeFunc) listIteratorFree); Index: trunk/psLib/src/types/psList.h =================================================================== --- trunk/psLib/src/types/psList.h (revision 11704) +++ trunk/psLib/src/types/psList.h (revision 11705) @@ -5,6 +5,6 @@ * @author Robert Daniel DeSonia, MHPCC * - * @version $Revision: 1.39 $ $Name: not supported by cvs2svn $ - * @date $Date: 2007-01-23 22:47:23 $ + * @version $Revision: 1.40 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-02-08 04:35:35 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -22,6 +22,7 @@ /** Special values of index into list * - * This list of possible list position values should be contiguous non-positive values ending with - * PS_LIST_UNKNOWN. Any value less-than-or-equal-to PS_LIST_UNKNOWN is considered a undefined position. + * This list of possible list position values should be contiguous + * non-positive values ending with PS_LIST_UNKNOWN. Any value + * less-than-or-equal-to PS_LIST_UNKNOWN is considered a undefined position. * */ @@ -30,4 +31,5 @@ PS_LIST_TAIL = -1, ///< at tail }; + /** Doubly-linked list element */ @@ -39,4 +41,5 @@ } psListElem; + /** The psList Linked list structure. User should not allocate this struct @@ -58,4 +61,5 @@ psList; + /** The psList iterator structure. This should be allocated via * psListIteratorAlloc and not directly. @@ -79,5 +83,6 @@ /** Checks the type of a particular pointer. * - * Uses the appropriate deallocation function in psMemBlock to check the ptr datatype. + * Uses the appropriate deallocation function in psMemBlock to check the ptr + * datatype. * * @return bool: True if the pointer matches a psList structure, false otherwise. @@ -85,6 +90,6 @@ bool psMemCheckList( psPtr ptr ///< the pointer whose type to check -) -; +); + /** Creates a psList linked list object. @@ -92,7 +97,19 @@ * @return psList* A new psList object. */ +#ifdef DOXYGEN psList* psListAlloc( psPtr data ///< initial data item; may be NULL if an empty psList is desired ); +#else // ifdef DOXYGEN +psList* p_psListAlloc( + const char *file, ///< File of caller + unsigned int lineno, ///< Line number of caller + const char *func, ///< Function name of caller + psPtr data ///< initial data item; may be NULL if an empty psList is desired +); +#define psListAlloc(data) \ + p_psListAlloc(__FILE__, __LINE__, __func__, data) +#endif // ifdef DOXYGEN + /** Creates a psListIterator object and associates it with a psList. @@ -100,4 +117,5 @@ * @return psListIterator* A new psListIterator object. */ +#ifdef DOXYGEN psListIterator* psListIteratorAlloc( psList* list, ///< the psList to iterate with @@ -106,4 +124,18 @@ bool mutable ///< Is it permissible to modify list? ); +#else // ifdef DOXYGEN +psListIterator* p_psListIteratorAlloc( + const char *file, ///< File of caller + unsigned int lineno, ///< Line number of caller + const char *func, ///< Function name of caller + psList* list, ///< the psList to iterate with + long location, ///< the initial starting point. + ///< This can be a numeric index, PS_LIST_HEAD, or PS_LIST_TAIL. + bool mutable ///< Is it permissible to modify list? +); +#define psListIteratorAlloc(list, location, mutable) \ + p_psListIteratorAlloc(__FILE__, __LINE__, __func__, list, location, mutable) +#endif // ifdef DOXYGEN + /** Set the iterator of the list to a given position. If location is invalid the @@ -116,4 +148,5 @@ long location ///< index number, PS_LIST_HEAD, or PS_LIST_TAIL ); + /** Adds an element to a psList at position given. @@ -127,4 +160,5 @@ ); + /** Adds an data item to a psList at position just after the list position given * @@ -136,4 +170,5 @@ ); + /** Adds a data item to a psList at position just before the list position given * @@ -154,4 +189,5 @@ ); + /** Remove an item from a list. * @@ -162,4 +198,5 @@ psPtr data ///< data item to find and remove ); + /** Retrieve an item from a list. @@ -175,4 +212,5 @@ ); + /** Position the specified iterator to the next item in list. * @@ -184,4 +222,5 @@ ); + /** Position the specified iterator to the previous item in list. * @@ -193,4 +232,5 @@ ); + /** Convert a linked list to an array * @@ -202,4 +242,5 @@ ); + /** Convert array to a doubly-linked list * @@ -210,4 +251,5 @@ const psArray* array ///< vector to convert ); + /** Sort a list via a comparison function. @@ -227,4 +269,5 @@ ); + /** Get the number of elements in use from a specified psList. (list.n) * @@ -235,4 +278,5 @@ ); + /// @} End of DataContainer Functions #endif // #ifndef PS_LIST_H