getopt-declare 1.09.7

data/samples/cmdline_array.rb

@@ -0,0 +1,25 @@
+#! /usr/bin/ruby
+
+require "Getopt/Declare"
+
+args = Getopt::Declare.new( %q{
+
+  		-v <value> [etc]	One or more values
+  		<infile>		Input file [required]
+  		-o <outfiles>...	Output files
+  	} )
+
+if args['-v']
+  print  "Using value: ", args['-v']['<value>']
+  print  " (etcetera)" if args['-v']['etc']
+  print  "\n"
+end
+
+infile = File.new( args['<infile>'] )
+data = infile
+
+for outfile in args['-o']
+  #outfile = File.new(outfile,'w')
+  print "processed ",outfile
+  #outfile.close
+end

data/samples/cmdline_basic.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby
+
+require "Getopt/Declare"
+
+args = Getopt::Declare.new(<<'EOPARAM')
+
+   ============================================================
+   Required parameter:
+
+   -in <infile>		Input file [required]
+
+   ------------------------------------------------------------
+
+   Optional parameters:
+
+   (The first two are mutually exclusive) [mutex: -r -p]
+
+   -r[and[om]]		Output in random order
+   -p[erm[ute]]		Output all permutations
+
+   ---------------------------------------------------
+
+   -out <outfile>	Optional output file
+
+   ------------------------------------------------------------
+   Note: this program is known to run very slowly of files with
+   long individual lines.
+   ============================================================
+EOPARAM
+
+print args.inspect

data/samples/cmdline_code.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby
+
+require "Getopt/Declare"
+
+args = Getopt::Declare.new(<<'EOPARAM', ['-BUILD'])
+
+   ============================================================
+   Required parameter:
+
+   -in <infile>		Input file [required]
+
+   ------------------------------------------------------------
+
+   Optional parameters:
+
+   (The first two are mutually exclusive) [mutex: -r -p]
+
+   -r[and[om]]		Output in random order
+   -p[erm[ute]]		Output all permutations
+
+   ---------------------------------------------------
+
+   -out <outfile>		Optional output file
+
+   ------------------------------------------------------------
+   Note: this program is known to run very slowly of files with
+   long individual lines.
+   ============================================================
+EOPARAM
+
+puts args.code()

data/samples/cmdline_defer.rb

@@ -0,0 +1,23 @@
+#! /usr/bin/ruby
+
+require "Getopt/Declare"
+
+
+#  With the next specification, the <tt>-rev</tt> and/or <tt>-rand</tt> flags
+#  can be specified _after_ the list of files, but still affect the processing
+#  of those files. Moreover, if the command-line parsing fails for some reason
+#  (perhaps due to an unrecognized argument), the deferred processing will
+#  not be performed.
+args = Getopt::Declare.new( %q{
+
+  	<files>...	Files to be processed
+  			    { defer { files.each { |i| 
+                                                   puts i, " ",$ordered } } }
+
+  	-rev[erse]	Process in reverse order
+  			    { $ordered = -1; }
+
+  	-rand[om]	Process in random order
+  			    { $ordered = 0; }
+  	} )
+

data/samples/cmdline_file.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/ruby
+
+require "Getopt/Declare"
+
+args = Getopt::Declare.new(<<'EOPARAM', ['-BUILD'])
+
+   ============================================================
+   Required parameter:
+
+   -in <infile>		Input file [required]
+
+   ------------------------------------------------------------
+
+   Optional parameters:
+
+   (The first two are mutually exclusive) [mutex: -r -p]
+
+   -r[and[om]]		Output in random order
+   -p[erm[ute]]		Output all permutations
+
+   ---------------------------------------------------
+
+   -out <outfile>		Optional output file
+
+   ------------------------------------------------------------
+   Note: this program is known to run very slowly of files with
+   long individual lines.
+   ============================================================
+EOPARAM
+
+
+# TRY STANDARD CONFIG FILES
+args.parse(['-CONFIG'])
+#args.parse('/usr/local/config/.demo_rc')
+
+#args.parse() or raise "cannot parse";
+
+print args.inspect

data/samples/cmdline_inlines.rb

@@ -0,0 +1,24 @@
+
+require "Getopt/Declare"
+
+def encode(t)
+    return Getopt::Declare.new(t,['-BUILD']).code
+end
+
+=begin
+Just type in something, like:
+
+=for Getopt::Declare
+
+               -a              Append mode
+=cut
+
+=end
+
+$/ = '=cut'
+if t = $stdin.readline
+  t.sub!( /^=for\s+Getopt::Declare\s*\n(.*?)\n=cut/esm ) { 
+    '(self,source) = []'+encode("#$1") }
+end
+
+print t

data/samples/cmdline_mid.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/ruby
+
+require "Getopt/Declare"
+
+def delold
+  print "would have deleted\n"
+end
+
+args = Getopt::Declare.new(<<EOF)
+
+		-a		Process all data
+
+		-b <n:n>	Set mean byte length threshold to <N>
+  					{ bytelen = n }
+
+		+c <FILE>	Create new file <FILE>
+
+		--del 		Delete old file
+  					{ delold(); }
+
+		delete 		[ditto]
+
+		e <w:i>x<h:i>	Expand image to height <h> and width <w>
+  					{ }
+
+		-F <file>...	Process named file(s)
+  					{ defer { file.each {|i| 
+                                                  process(i) } } }
+
+		=getrand [<n>]	Get a random number
+				(or, optionally, <n> of them)
+  					{ n = 1 unless !n.empty? }
+
+		--		Traditionally indicates end of arguments
+  					{ finish }
+
+EOF
+
+print args.inspect

data/samples/cmdline_noargv.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby
+
+require "Getopt/Declare"
+
+argv2 = '-in test'
+
+# Parse options from another string instead of ARGV
+args = Getopt::Declare.new(<<'EOPARAM', argv2 )
+
+   ============================================================
+   -in <infile>		Input file
+   -r[and[om]]		Output in random order
+   -p[erm[ute]]		Output all permutations
+   -out <outfile>	Optional output file
+   ============================================================
+EOPARAM
+
+puts args.inspect
+
+# Parse options from another string instead of ARGV
+argv3 = "-r -in argv3"
+args.parse(argv3)
+puts args.inspect
+
+# Parse options from another array instead of ARGV
+argv4 = [ '-in', 'opt with spaces' ]
+
+args.parse(['-ARGV', argv4])
+puts args.inspect

data/samples/cmdline_parameters.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby
+
+require "Getopt/Declare"
+
+specification = %q%
+        -list <l>...				ttt
+        -out <out>				ttt
+	in=<infile>				ttt
+	+range <from>..<to>			ttt
+	--lines <start> - <stop>		ttt
+	ignore bad lines			ttt
+	<outfile>				ttt
+	-copy <files>... <dir>			copy files to dir
+	-range <from:i> [[..] [<to:i>] ]	opt. range
+					{ to = 10 if to == "" } 
+	
+%
+
+
+args = Getopt::Declare.new(specification)
+
+
+puts args.inspect

data/samples/cmdline_pvtype.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/ruby
+
+require "Getopt/Declare"
+
+args = Getopt::Declare.new( <<'EOPARAM' )
+	[pvtype: type  /AB|[OAB]/	                                ]
+	[pvtype: Rh?   /Rh[+-]/					        ]
+	[pvtype: days  :+i  { 
+               reject( (_VAL_.to_i < 14)," #{_PARAM_} (too soon!)" ) 
+                            } 
+        ]
+
+	  -donated <d:days>		  Days since last donation
+	  -applied <a:days>		  Days since applied to donate
+
+	  -blood <type:type> [<rh:Rh?>]	  Specify blood type
+					  and (optionally) rhesus factor
+EOPARAM
+
+print args.inspect

data/samples/cmdline_pvtype2.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/ruby
+
+require "Getopt/Declare"
+
+specification = %q(
+     [strict]     
+     [pvtype: num      /\d+/    { reject if Time.new.localtime.day==3 }  ]
+     [pvtype: 'a num'  :n       { puts "a num!"  }               ]
+     [pvtype: %q{nbr}  :'a num' { reject $no_nbr }               ]
+
+		   -count1 <n:num>		  test
+		   -count2 <n:a num>		  test2
+		   -count3 <n:nbr>		  test3
+
+     )
+
+args = Getopt::Declare.new(specification)
+
+print args.inspect
+

data/samples/cmdline_regex.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby
+
+require "Getopt/Declare"
+
+specification = <<-'EOFPARAMS'
+-ar <r:n>	       		Set aspect ratio (will be clipped to [0..1] )
+  				{
+  				  r = 0 if r < 0
+  				  r = 1 if r > 1
+  				}
+-w <pixels:+i>			Specify width in pixels
+-h <pixels:+i>			Specify height in pixels
+-list  <all:i>...		list of numbers
+-range <from:i> [- [<to:i>] ]	opt. range
+					{ to = 10 if to.empty? }
+-parity <p:/even|odd|both/>	Set parity (<p> must be "even",
+				"odd" or "both")
+-file <name:/\w*\.[A-Z]{3}/>	File name must have a three-
+				capital-letter extension
+-find <what:/(%T.)+/> ;	        look ahead test
+
+EOFPARAMS
+
+
+args = Getopt::Declare.new(specification)
+
+print args.inspect

data/samples/cmdline_singles.rb

@@ -0,0 +1,28 @@
+#! /usr/bin/ruby
+
+require "Getopt/Declare"
+
+#  In the next example, only the <tt>-a</tt> and <tt>-b</tt> parameters may be clustered.
+#  The <tt>-bu</tt> parameter is excluded because it consists of more than one
+#  letter, whilst the <tt>-c</tt> and <tt>-d</tt> parameters are excluded because they
+#  take (or may take, in <tt>-d</tt>'s case) a variable. The <tt>-e[xec]</tt> parameter
+#  is excluded because it may take a trailing punctuator (<tt>[xec]</tt>).
+#
+#  By comparison, if the directive had been <tt>[cluster: flags]</tt>, then
+#  <tt>-bu</tt> _could_ be clustered, though <tt>-c</tt>, <tt>-d</tt> and <tt>-e[xec]</tt> would
+#  still be excluded since they are not "pure flags").
+#
+
+args = Getopt::Declare.new( <<-'EOSPEC' )
+
+  		-a		Append mode
+  		-b		Back-up mode
+  		-bu		[ditto]
+  		-c <file>	Copy mode
+  		-d [<file>]	Delete mode
+  		-e[xec]		Execute mode
+
+  		[cluster:singles]
+EOSPEC
+
+print args.inspect

data/samples/demo_cmdline.rb

@@ -0,0 +1,70 @@
+#! /usr/bin/ruby
+
+require "Getopt/Declare"
+
+$VERSION = "1.00b";
+
+config = Getopt::Declare.new( <<'EOCONFIG', ['-CONFIG']);
+	[strict]
+	min = <n>	Minimum value [required]
+	max = <n>	Maximum value
+
+EOCONFIG
+
+print "min: ", config['min'], "\n" if config['min']
+print "max: ", config['max'], "\n" if config['max']
+
+args = Getopt::Declare.new( <<'EOARGS' )
+General options:
+[tight]
+     -e <f:i>..<t:i>		Set expansion factor to specified range
+                        [requires: <file>]
+                                { puts "k = [#{f}..#{t}]" }
+
+     -e [<k:n>...]		Set expansion factor to <k> (or 2 by default)
+                        [required]
+                                { k = [2] unless k
+                                  print "k = [", k.join(','), "]\n"; }
+
+	-b <blen:i>		Use byte length of <blen> 
+                        [excludes: -a +c]
+                                { print "byte len: #{blen}\n"; }
+
+	<file>...		Process files [required] [implies: -a]
+                                { print "files: #{file}\n"; }
+
+	-a [<n:n>]		Process all data [except item <n>]
+                            { print "proc all\n"; print "except #{n}\n" if n }
+
+	-fab			The fabulous option (is always required :-)
+                        [required]
+                                { defer { print "fabulous!\n" } }
+
+File creation options:
+
+	+c <file>		Create file [mutex: +c -a]
+                                { print "create: file\n"; }
+
+	+d <file>		Duplicate file [implies: -a and -b 8]
+                        	This is a second line
+                                { print "dup (+d) $file\n"; }
+	--dup <file>		[ditto] (long form)
+
+	-how <n:i>		Set height to <n>       [repeatable]
+
+Garbling options:
+
+	-g [<seed:i>]		Garble output with optional seed [requires: +c]
+                                { print "garbling with $seed\n"; }
+	-i			Case insensitive garbling [required]
+                                { print "insensitive\n"; }
+	-s			Case sensitive garbling 
+	-w			WaReZ m0De 6aRBL1N6 
+
+	[mutex: -i -s -w]
+EOARGS
+
+print args.unused
+
+#args.usage();
+__END__