Changeset 13555

Timestamp:

May 30, 2007, 12:43:58 PM (19 years ago)

Author:

jhoblitt

Message:

add psArgumentHelpSimple()

Location:

trunk/psLib/src/types

Files:

• psArguments.c (modified) (2 diffs)
• psArguments.h (modified) (2 diffs)

trunk/psLib/src/types/psArguments.c

@@ -7 +7 @@
  *  @author David Robbins, MHPCC
  *
- *  @version $Revision: 1.26 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2007-05-25 04:15:46 $
+ *  @version $Revision: 1.27 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2007-05-30 22:43:58 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -506 +506 @@
 }
 
+void psArgumentHelpSimple(psMetadata *arguments)
+{
+    PS_ASSERT_PTR_NON_NULL(arguments, );
+
+    printf("Optional arguments:\n");
+    int maxName = 4;   // Maximum length of a name
+    int maxValue = 4;   // Maximum length of a value
+
+    // First pass to get the sizes
+    maxLength(&maxName, &maxValue, arguments);
+
+    // Second pass to print
+    psMetadataIterator *iter = psMetadataIteratorAlloc(arguments, PS_LIST_HEAD, NULL);
+    psMetadataItem *item = NULL; // Item from iterator
+    while ((item = psMetadataGetAndIncrement(iter))) {
+        // Initial indent + name + indent + comment
+        printf("%*s%*s%*s%s\n",
+                NUM_SPACES, " ",
+                maxName, argItem->name,
+                NUM_SPACES, " ",
+                argItem->comment);
+    }
+
+    psFree(iter);
+}
+

trunk/psLib/src/types/psArguments.h

@@ -5 +5 @@
  *  @author David Robbins, MHPCC
  *
- *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2007-01-23 22:47:23 $
+ *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2007-05-30 22:43:58 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -72 +72 @@
 );
 
+/** Prints to stdout a simplifed guide to the command-line arguments.      */
+void psArgumentHelpSimple(
+    psMetadata *arguments              ///< metadata container for arguments
+);
+
 /// @}
 #endif // #ifndef PS_ARGUMENTS_H