Mark Reynolds > IO-Capture-0.05 > IO::Capture::Stdout

Download:
IO-Capture-0.05.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  9
Open  0
View/Report Bugs
Source  

NAME ^

IO::Capture::Stdout - Capture any output sent to STDOUT

SYNOPSIS ^

    # Generic example (Just to give the overall view)
    use IO::Capture::Stdout;

    $capture = IO::Capture::Stdout->new();

    $capture->start();          # STDOUT Output captured
    print STDOUT "Test Line One\n";
    print STDOUT "Test Line Two\n";
    print STDOUT "Test Line Three\n";
    $capture->stop();           # STDOUT output sent to wherever it was before 'start'

    # In 'scalar context' returns next line
    $line = $capture->read;
    print "$line";         # prints "Test Line One"

    $line = $capture->read;
    print "$line";         # prints "Test Line Two"

    # move line pointer to line 1
    $capture->line_pointer(1);

    $line = $capture->read;
    print "$line";         # prints "Test Line One"

    # Find out current line number
    $current_line_position = $capture->line_pointer;

    # In 'List Context' return an array(list)
    @all_lines = $capture->read;

    # More useful example 1 - "Using in module tests"
    #  Note: If you don't want to make users install 
    #        the IO::Capture module just for your tests,
    #        you can just install in the t/lib directory
    #        of your module and use the lib pragma in  
    #        your tests. 

    use lib "t/lib";
    use IO::Capture::Stdout;

    use Test::More;

    my $capture =  IO::Capture::Stdout->new;
    $capture->start

    # execute with a bad parameter to make sure get
    # an error.

    ok( ! $test("Bad Parameter") );

    $capture->stop();

DESCRIPTION ^

The module IO::Capture::Stdout, is derived from the abstract class IO::Capture. See IO::Capture. The purpose of the module (as the name suggests) is to capture any output sent to STDOUT. After the capture is stopped, the STDOUT filehandle will be reset to the previous location. E.g., If previously redirected to a file, when IO::Capture->stop is called, output will start going into that file again.

Note: This module won't work with the perl function, system(), or any other operation involving a fork(). If you want to capture the output from a system command, it is faster to use open() or back-ticks.

       my $output = `/usr/sbin/ls -l 2>&1`;

METHODS ^

new

start

stop

read

line_pointer

SUB-CLASSING ^

Adding Features

If you would like to sub-class this module to add a feature (method) or two, here is a couple of easy steps. Also see IO::Capture::Overview.

  1. Give your package a name
        package MyPackage;
  2. Use this IO::Capture::Stdout as your base class like this:
        package MyPackage;
    
        use base qw/IO::Capture::Stdout/;
  3. Add your new method like this
        package MyPackage;
    
        use base qw/IO::Capture::Stdout/;
    
        sub grep {
            my $self = shift;
    
            for $line (
        }

See Also ^

IO::Capture::Overview

IO::Capture

IO::Capture::Stderr

AUTHORS ^

Mark Reynolds reynolds@sgi.com

Jon Morgan jmorgan@sgi.com

COPYRIGHT ^

Copyright (c) 2003, Mark Reynolds. All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.

syntax highlighting: