NAME ^

lib/Parrot/BuildUtil.pm - Utilities for building Parrot

DESCRIPTION ^

This package holds three subroutines: parrot_version(), slurp_file, and generated_file_header. Subroutines are not exported--each must be requested by using a fully qualified name.

SUBROUTINES ^

parrot_version()

Determines the current version number for Parrot from the VERSION file and returns it in a context-appropriate manner.

    $parrot_version = Parrot::BuildUtil::parrot_version();
    # $parrot_version is '0.4.11'

    @parrot_version = Parrot::BuildUtil::parrot_version();
    # @parrot_version is (0, 4, 11)
slurp_file($filename)

Slurps up the filename and returns the content as one string. While doing so, it converts all DOS-style line endings to newlines.

generated_file_header($filename, $style)

Returns a comment to mark a generated file and detail how it was created. $filename is the name of the file on which the generated file is based, $style is the style of comment--'perl' and 'c' are permitted, other values produce an error.

AUTHOR ^

Gregor N. Purdy. Revised by James E Keenan.


 parrot