Changeset 6201 for trunk/psLib/src/sys/psString.h

Timestamp:

Jan 25, 2006, 7:31:54 PM (20 years ago)

Author:

drobbin

Message:

added psStringSplit from bug 657.

File:

• trunk/psLib/src/sys/psString.h (modified) (7 diffs)

trunk/psLib/src/sys/psString.h

@@ -12 +12 @@
  *
  *  @author Eric Van Alst, MHPCC
+ *  @author David Robbins, MHPCC
  *
- *  @version $Revision: 1.16 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-09-13 01:09:58 $
+ *  @version $Revision: 1.17 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-01-26 05:31:54 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -24 +25 @@
 #include <sys/types.h>
 #include "psType.h"
+#include "psList.h"
 
 /** This macro will convert the argument to a quoted string */
@@ -40 +42 @@
  *
  *  @return psString:      Copy of input string
- *
  */
 psString psStringCopy(
@@ -57 +58 @@
  *
  *  @return  psString:   Copy of input string
- *
  */
-
-/*@null@*/
-
 psString psStringNCopy(
     const char *string,                ///< Input string of characters to copy
@@ -72 +69 @@
  * automatically extended to the size of the new string.
  *
- * @return The length of the new string (excluding '\0')
+ * @return ssize_t:     The length of the new string (excluding '\0')
  */
-
 ssize_t psStringAppend(
     char **dest,                        ///< existing string
@@ -86 +82 @@
  * automatically extended to the size of the new string.
  *
- * @return The length of the new string (excluding '\0')
+ * @return ssize_t:     The length of the new string (excluding '\0')
  */
-
 ssize_t psStringPrepend(
     char **dest,                        ///< existing string
@@ -95 +90 @@
 );
 
+/** Procedure to split the input string into a psList of psStrings.
+ *
+ *  The string is split at any one of the characters in splitters.  Split
+ *  strings of zero length should not be included in the output list.
+ *
+ *  @return psList*:    The list of (split) psStrings.
+ */
+psList *psStringSplit(
+    const char *string,
+    const char *splitters
+);
+
 /** @} */// Doxygen - End of SystemGroup Functions