lib/Parrot/Ops2pm/Auxiliary.pm

   1 # Copyright (C) 2007, The Perl Foundation.
   2 # $Id$
   3 package Parrot::Ops2pm::Auxiliary;
   4 use strict;
   5 use warnings;
   6 use vars qw(@ISA @EXPORT_OK);
   7 @ISA       = qw( Exporter );
   8 @EXPORT_OK = qw( Usage getoptions );
   9 use Getopt::Long;
  10
  11 sub Usage {
  12     print STDERR <<_EOF_;
  13 usage: tools/build/ops2pm.pl [--help] [--no-lines] input.ops [input2.ops ...]
  14 _EOF_
  15     return 1;
  16 }
  17
  18 sub getoptions {
  19     my %flags;
  20     GetOptions(
  21         "no-lines" => \$flags{nolines},
  22         "help"     => \$flags{help},
  23         "renum"    => \$flags{renum},
  24     );
  25     return \%flags;
  26 }
  27
  28 1;
  29
  30 #################### DOCUMENTATION ####################
  31
  32 =head1 NAME
  33
  34 Parrot::Ops2pm::Auxiliary - Non-method subroutines holding functionality for F<tools/build/ops2pm.pl>.
  35
  36 =head1 SYNOPSIS
  37
  38     use Parrot::Ops2pm::Auxiliary qw( Usage getoptions );
  39
  40     Usage();
  41
  42     $flagref = getoptions();
  43
  44 =cut
  45
  46 =head1 DESCRIPTION
  47
  48 Parrot::Ops2pm::Auxiliary provides subroutines called by F<tools/build/ops2pm.pl>, a
  49 program which is called at the very beginning of the Parrot F<make> process.
  50 This package is intended to hold subroutines used by that program I<other
  51 than> the object-oriented methods provided by Parrot::Ops2pm::Utils.
  52
  53 Extraction of the subroutines exported by this package from
  54 F<tools/build/ops2pm.pl> facilitates the testing of their functionality by the
  55 tests in F<t/tools/ops2pmutils/*.t>.
  56
  57 =head1 SUBROUTINES
  58
  59 =head2 C<Usage()>
  60
  61 =over 4
  62
  63 =item * Purpose
  64
  65 Display a short description of how to use F<tools/build/ops2pm.pl> on
  66 standard output.
  67
  68     usage: tools/build/ops2pm.pl [--help] [--no-lines] input.ops [input2.ops ...]
  69
  70 =item * Arguments
  71
  72 None.
  73
  74 =item * Return Value
  75
  76 Implicitly returns true upon successful printing.
  77
  78 =back
  79
  80 =head2 C<getoptions>
  81
  82 =over 4
  83
  84 =item * Purpose
  85
  86 Process arguments provided on command-line to F<tools/build/ops2pm.pl>.
  87
  88 =item * Arguments
  89
  90 None.
  91
  92 =item * Return Value
  93
  94 Hash reference where any of the following keys may or may not be defined.
  95
  96    no-lines
  97    help
  98    renum
  99
 100 =item * Comment
 101
 102 A wrapper around Getopt::Long::GetOptions() designed to assure testability.
 103
 104 =back
 105
 106 =head1 AUTHOR
 107
 108 Jim Keenan (refactoring code originally found in F<tools/build/ops2pm.pl>).
 109
 110 =head1 SEE ALSO
 111
 112 Parrot::Ops2pm::Utils.  F<tools/build/ops2pm.pl>.
 113
 114 =cut
 115
 116 # Local Variables:
 117 #   mode: cperl
 118 #   cperl-indent-level: 4
 119 #   fill-column: 100
 120 # End:
 121 # vim: expandtab shiftwidth=4: