NAME

Parrot::Ops2c::Auxiliary - Non-method subroutines holding functionality for tools/build/ops2c.pl.

SYNOPSIS

    use Parrot::Ops2c::Auxiliary qw( Usage getoptions );

    Usage();

    $flagref = getoptions();

DESCRIPTION

Parrot::Ops2c::Auxiliary provides subroutines called by tools/build/ops2c.pl, a program which is called at various points in the Parrot make process. This package is intended to hold subroutines used by that program other than the object-oriented methods provided by Parrot::Ops2c::Utils.

Extraction of the subroutines exported by this package from tools/build/ops2c.pl facilitates the testing of their functionality by the tests in t/tools/ops2cutils/*.t.

SUBROUTINES

Usage()

• Purpose

  Display a short description of how to use tools/build/ops2c.pl on standard output.

      usage: tools/build/ops2pm.pl [--help] [--no-lines] input.ops [input2.ops ...]

• Arguments

  None.

• Return Value

  Implicitly returns true upon successful printing.

getoptions

• Purpose

  Process arguments provided on command-line to tools/build/ops2c.pl.

• Arguments

  None.

• Return Value

  Hash reference where any of the following keys may or may not be defined.

     no-lines
     help
     renum

• Comment

  A wrapper around Getopt::Long::GetOptions() designed to assure testability.

AUTHOR

Jim Keenan (refactoring code originally found in tools/build/ops2c.pl).

SEE ALSO

• Parrot::Ops2c::Utils.

• tools/build/ops2c.pl.