Changeset 12546 for trunk/gsdl/perllib/parse2.pm

Timestamp:

2006-08-24T16:19:13+12:00 (18 years ago)

Author:

kjdon

Message:

changed parse2::parse so that it returns -1 on error, 0 on success, or if allow_extra_options is specified, then on success returns the number of args left over.

File:

• trunk/gsdl/perllib/parse2.pm (modified) (6 diffs)

trunk/gsdl/perllib/parse2.pm

@@ -185 +185 @@
 # Parameters: 1.(Array pointer of the user given argument)
 #             2.(Array pointer of plugin pre-defined argument list)  
-#             3.(Self pointer, where we store all the argument value)
+#             3.(Hash pointer, where we store all the argument value)
 # Pre-condition: Plugin gives the parameters to parse function in parse2 
-# Post-condition: Store all the default or user given values to the $self->{$ArgumentName}.
-#                 Since $self is a pointer from plugin, plugin will have every values we set.
-# Return value: 1 is parsing successful, 0 is failed.
+# Post-condition: Store all the default or user given values to the hash->{$ArgumentName}.
+#                 Since hash may be a plugin $self, plugin will have every values we set.
+#             4. Optional "allow_extra_options" argument. If this is set, then
+#                its ok to have arguments that are not in the predefined list
+# Return value: -1 if parsing is unsuccessful
+#                other value for success. This will be 0 unless "allow_extra_options" is set, in which case it will be the number of extra arguments found. 
 #-----------------------------------------
 sub parse
@@ -239 +242 @@
         if(processArg($hashArg{$strOneArg},$aryptUserArguList,\%hashInputArg) == 0){ 
             print STDERR "<BadArgumentValue a=$strOneArg>\n";
-            return 0;}
+            return -1;}
         }
         
@@ -254 +257 @@
             print STDERR "<BadArgument a=$strOneArg>\n";
             print STDERR " Error: occur in parse2.pm::parse()\n Extra Arguments: $strOneArg\n";
-            return 0;
+            return -1;
         }
         }
@@ -271 +274 @@
         {
         print STDERR " Error: occur in parse2.pm::parse()\n Invalid Argument: $strOneArg\n";
-        return 0;
+        return -1;
         }
     }
@@ -294 +297 @@
         if(defined $hashOneArg->{"range"}) 
         {
-        if(checkRange($hashOneArg->{"range"},$hashInputArg{$strArgName},$strArgName) == 0){ return 0;}
+        if(checkRange($hashOneArg->{"range"},$hashInputArg{$strArgName},$strArgName) == 0){ return -1;}
         }
         if(defined $hashOneArg->{"char_length"})
         {
-        if(checkCharLength($hashOneArg->{"char_length"},$hashInputArg{$strArgName},$strArgName) == 0){ return 0;}
+        if(checkCharLength($hashOneArg->{"char_length"},$hashInputArg{$strArgName},$strArgName) == 0){ return -1;}
         }
         $self->{"$strArgName"} = $hashInputArg{"$strArgName"};
@@ -334 +337 @@
     else
     {
-    return 1;
+    return 0;
     }
 }