cvsuser 03/12/11 06:09:24
Modified: examples/assembly getopt_demo.imc
runtime/parrot/include Getopt_Long.imc
Log:
This patch mostly improves the embedded POD in Getopt_Long.imc and
getopt_demo.imc.
There are also some code beautifications, including a s/.pcc_sub/.sub/.
Courtesy of Bernhard Schmalhofer
Revision Changes Path
1.2 +111 -89 parrot/examples/assembly/getopt_demo.imc
Index: getopt_demo.imc
===================================================================
RCS file: /cvs/public/parrot/examples/assembly/getopt_demo.imc,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -w -r1.1 -r1.2
--- getopt_demo.imc 1 Nov 2003 17:28:24 -0000 1.1
+++ getopt_demo.imc 11 Dec 2003 14:09:22 -0000 1.2
@@ -1,28 +1,35 @@
-#
-# getopt_demo.imc
-#
-# Copyright (C) 2003 The Perl Foundation. All rights reserved.
-# This program is free software. It is subject to the same
-# license as The Parrot Interpreter.
-#
-# $Id: getopt_demo.imc,v 1.1 2003/11/01 17:28:24 leo Exp $
-#
-# Example of how to handle command line arguments with 'Getopt_Long.imc'.
-# 'Getopt_Long.imc' is a library file that needs to be present in your
-# library search path. Right now the parrot library search path consists of
-# '.' and './runtime/parrot/include'.
-#
-# Usage:
-# ./parrot examples/assembly/getopt_demo.imc --help
-# ./parrot examples/assembly/getopt_demo.imc --version
-# ./parrot examples/assembly/getopt_demo.imc --string=asdf --bool \
-# --integer=42 some thing
+# $Id: getopt_demo.imc,v 1.2 2003/12/11 14:09:22 leo Exp $
-.pcc_sub _main prototyped
+=head1 NAME
+
+getopt_demo.imc - demonstrating Getopt_Long.imc
+
+=head1 DESCRIPTION
+
+This demo program shows how to handle command line arguments
+with the PIR library 'Getopt_Long.imc'.
+'Getopt_Long.imc' is a library file that needs to be present in your
+library search path. Right now the parrot library search path consists of
+'.' and './runtime/parrot/include'.
+
+=head1 SYNOPSIS
+
+ ./parrot examples/assembly/getopt_demo.imc --help
+ ./parrot examples/assembly/getopt_demo.imc --version
+ ./parrot examples/assembly/getopt_demo.imc --string=asdf --bool --integer=42 some
thing
+
+=head1 SUBROUTINES
+
+=head2 _main
+
+This is executed when you call getopt_demo.imc
+
+=cut
+.sub _main prototyped
.param PerlArray argv
- # Assemble specification for get_options.
- # This should work somewhat like Getopt::Long.
+ # Assemble specification for get_options
+ # in an array of format specifiers
.sym PerlArray opt_spec
opt_spec = new PerlArray
# --version, boolean
@@ -36,32 +43,33 @@
# --integer, integer
push opt_spec, "integer=i"
- # name of the interpreter and of the program
+ # the program name is the first element in argv
.sym string program_name
shift program_name, argv
- # Make a copy of argv, because this can easier be handled in get_options
+ # Make a copy of argv, because this can easier be handled in get_options()
+ # TODO: remove need for cloning
.sym PerlArray argv_clone
argv_clone = clone argv
+ .sym PerlUndef opt
.sym Sub get_options
get_options = newsub _get_options
.pcc_begin prototyped
.arg argv_clone
.arg opt_spec
.pcc_call get_options
- ret2:
- .sym PerlUndef opt
+ ret_get_options_1:
.result opt
.pcc_end
-HANDLE_OPTIONS:
+ # Now we do what the passed options tell
.sym int is_defined
# Was '--version' passed ?
is_defined = defined opt["version"]
unless is_defined goto NO_VERSION_FLAG
- print "getopt_demo.imc Halloween release\n"
+ print "getopt_demo.imc version 0.01\n"
end
NO_VERSION_FLAG:
@@ -71,19 +79,20 @@
.sym Sub usage
usage = newsub _usage
.pcc_begin prototyped
+ .arg program_name
.pcc_call usage
- ret1:
+ ret_usage_1:
.pcc_end
end
NO_HELP_FLAG:
# Say Hi
- print "Hi, I am "
+ print "Hi, I am '"
print program_name
- print "\n\n"
+ print "'.\n"
+ print "\n"
# handle the bool option
-CHECK_BOOL_OPTION:
is_defined = defined opt["bool"]
unless is_defined goto NO_BOOL_OPTION
print "You have passed the option '--bool'.\n"
@@ -93,7 +102,6 @@
END_BOOL_OPTION:
# handle the string option
-CHECK_STRING_OPTION:
is_defined = defined opt["string"]
unless is_defined goto NO_STRING_OPTION
.sym string string_option
@@ -107,7 +115,6 @@
END_STRING_OPTION:
# handle the integer option
-CHECK_INTEGER_OPTION:
is_defined = defined opt["integer"]
unless is_defined goto NO_INTEGER_OPTION
.sym string integer_option
@@ -120,7 +127,7 @@
print "You haven't passed the option '--integer'. This is fine with me.\n"
END_INTEGER_OPTION:
- # For some reason I cna't shift from argv_clone
+ # For some reason I can't shift from argv_clone
.sym string other_arg
.sym int cnt_other_args
cnt_other_args = 0
@@ -139,24 +146,23 @@
# Do a lot of useful stuff here
-FINISH_PROGRAM:
end
.end
-#
-# Subroutines
-#
-
-=head1 usage( )
+=head2 _usage
-Print the help message.
+Print the usage message.
TODO: Pass a flag for EXIT_FAILURE and EXIT_SUCCESS
=cut
-.pcc_sub _usage prototyped
- print "Usage: %s [OPTION]... [STRING]...\n"
+.sub _usage prototyped
+ .param string program_name
+
+ print "Usage: ./parrot "
+ print program_name
+ print " [OPTION]... [STRING]...\n"
print "\n"
print "Currently only long options are available.\n"
print "\n"
@@ -174,3 +180,19 @@
# A dummy implementation of Getopt::Long
.include "Getopt_Long.imc"
+
+=head1 AUTHOR
+
+Bernhard Schmalhofer <[EMAIL PROTECTED]>
+
+=head1 SEE ALSO
+
+L<Getopt_Long.imc>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2003 The Perl Foundation. All rights reserved.
+This program is free software. It is subject to the same
+license as The Parrot Interpreter.
+
+
1.2 +115 -96 parrot/runtime/parrot/include/Getopt_Long.imc
Index: Getopt_Long.imc
===================================================================
RCS file: /cvs/public/parrot/runtime/parrot/include/Getopt_Long.imc,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -w -r1.1 -r1.2
--- Getopt_Long.imc 1 Nov 2003 17:28:31 -0000 1.1
+++ Getopt_Long.imc 11 Dec 2003 14:09:24 -0000 1.2
@@ -1,32 +1,32 @@
-# Getopt_Long.imc
-#
-# Copyright (C) 2003 The Perl Foundation. All rights reserved.
-# This program is free software. It is subject to the same
-# license as The Parrot Interpreter.
-#
-# CVS Info: $Id: Getopt_Long.imc,v 1.1 2003/11/01 17:28:31 leo Exp $
-# Overview:
-# Parsing command line options.
-# History:
-# Ported from GNU m4 1.4
-# Notes:
-# References:
-# http://www.gnu.org/software/m4/m4.html
+# $Id: Getopt_Long.imc,v 1.2 2003/12/11 14:09:24 leo Exp $
-=head2 void get_options( PerlArray argv, PerlArray spec )
+=head1 NAME
+
+Getopt_Long.imc - parse command line options
+
+=head1 SYNOPSIS
+
+See examples/assembly/getopt_demo.imc
+
+=head1 DESCRIPTION
+
+This PIR library can be used for parsing command line options.
+A single subroutine, get_options(), is provided.
+
+=head1 SUBROUTINES
+
+=head2 _get_options
This should work like the Perl5 module Getopt::Long.
-TODO: make it work for all cases, short options, long options and bundling
-TODO: regogise type of return value: string, integer, binary, array, hash
-TODO: error reporting, more options
+Takes a format specifier and an argument vector.
Returns a PerlHash
=cut
-.pcc_sub _get_options prototyped
+.sub _get_options prototyped
.param PerlArray argv
.param PerlArray spec
-INIT_PARSE_SPEC: # Loop over the array spec and build up two
simple hashes
+ # Loop over the array spec and build up two simple hashes
.sym PerlHash type # the type of the option: binary, string,
integer
type = new PerlHash
.sym int cnt_spec # a counter for looping over the array 'spec'
@@ -54,29 +54,26 @@
CHECK_PARSE_SPEC: # check wether loop over 'spec' is complete
if cnt_spec < len_spec goto NEXT_PARSE_SPEC
-=head1 commented out
-
- goto NO_DEBUG
- $S31 = type['version']
+ # uncomment this if you want debug output
+ goto SKIP_DEBUG_OUTPUT
+ .sym string debug_var
+ debug_var = type['version']
print "version: "
- print $S31
+ print debug_var
print "\n"
- $S31 = type['help']
+ debug_var = type['help']
print "help: "
- print $S31
+ print debug_var
print "\n"
- $S31 = type['freeze-state']
+ debug_var = type['freeze-state']
print "freeze-state: "
- print $S31
+ print debug_var
print "\n"
- $S31 = type['reload-state']
+ debug_var = type['reload-state']
print "reload-state: "
- print $S31
+ print debug_var
print "\n"
-
-=cut
-
-INIT_PARSE_ARGV:
+ SKIP_DEBUG_OUTPUT:
# Now that we know about the allowed options,
# we actually parse the argument vector
@@ -91,7 +88,7 @@
.sym int is_known_option # flag wether the option is known
goto CHECK_PARSE_ARGV
NEXT_PARSE_ARGV:
- # fitst we take a peek at the first remaining element
+ # first we take a peek at the first remaining element
arg = argv[0]
# Is arg a option string like '--help'
index arg_index, arg, '--'
@@ -128,9 +125,9 @@
goto CHECK_PARSE_ARGV
UNKNOWN_OPTION:
# TODO: handle unknown options
- print 'unknown option: !'
- print arg
- print "!\n"
+ printerr 'unknown option: !'
+ printerr arg
+ printerr "!\n"
CHECK_PARSE_ARGV:
num_remaining_args = argv
@@ -142,3 +139,25 @@
.return opt
.pcc_end_return
.end
+
+=head1 TODO
+
+Make it work for all cases, short options, long options and bundling
+Recognise type of return value: string, integer, binary, array, hash
+error reporting, more options
+
+=head1 AUTHOR
+
+Bernhard Schmalhofer <[EMAIL PROTECTED]>
+
+=head1 SEE ALSO
+
+The Perl5 module L<Getopt::Long>.
+
+=head1 COPYRIGHT
+
+Copyright (C) 2003 The Perl Foundation. All rights reserved.
+This program is free software. It is subject to the same
+license as The Parrot Interpreter.
+
+=cut
