| 1 | package TAPx::Base; | ||||||||||
| 2 | |||||||||||
| 3 | 13 | ▶ | use strict; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 4 | 13 | ▶ | use vars qw($VERSION); | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 5 | |||||||||||
| 6 | =head1 NAME | ||||||||||
| 7 | |||||||||||
| 8 | TAPx::Base - Base class that provides common functionality to L<TAPx::Parser> and L<TAPx::Harness> | ||||||||||
| 9 | |||||||||||
| 10 | =head1 VERSION | ||||||||||
| 11 | |||||||||||
| 12 | Version 0.50_07 | ||||||||||
| 13 | |||||||||||
| 14 | =cut | ||||||||||
| 15 | |||||||||||
| 16 | 13 | $VERSION = '0.50_07'; | |||||||||
| 17 | |||||||||||
| 18 | =head1 SYNOPSIS | ||||||||||
| 19 | |||||||||||
| 20 | package TAPx::Whatever; | ||||||||||
| 21 | |||||||||||
| 22 | use TAPx::Base; | ||||||||||
| 23 | |||||||||||
| 24 | use vars qw($VERSION @ISA); | ||||||||||
| 25 | @ISA = qw(TAPx::Base); | ||||||||||
| 26 | |||||||||||
| 27 | # ... later ... | ||||||||||
| 28 | |||||||||||
| 29 | my $thing = TAPx::Whatever->new(); | ||||||||||
| 30 | |||||||||||
| 31 | $thing->callback( event => sub { | ||||||||||
| 32 | # do something interesting | ||||||||||
| 33 | } ); | ||||||||||
| 34 | |||||||||||
| 35 | =head1 DESCRIPTION | ||||||||||
| 36 | |||||||||||
| 37 | C<TAPx::Base> provides callback management. | ||||||||||
| 38 | |||||||||||
| 39 | =head1 METHODS | ||||||||||
| 40 | |||||||||||
| 41 | =head2 Class methods | ||||||||||
| 42 | |||||||||||
| 43 | =head3 C<new> | ||||||||||
| 44 | |||||||||||
| 45 | =cut | ||||||||||
| 46 | |||||||||||
| 47 | 99 | ▶ | sub new { | ||||||||
|
Subroutine
new: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||
| 48 | 99 | my ( $class, $arg_for ) = @_; | |||||||||
| 49 | |||||||||||
| 50 | 99 | my $self = bless {}, $class; | |||||||||
| 51 | 99 | return $self->_initialize($arg_for); | |||||||||
| 52 | } | ||||||||||
| 53 | |||||||||||
| 54 | 99 | ▶ | sub _initialize { | ||||||||
|
Subroutine
_initialize: called CC=3 SCAR=11.0
| |||||||||||
| 55 | 99 | my ( $self, $arg_for, $ok_callback ) = @_; | |||||||||
| 56 | |||||||||||
| 57 | 99 | my %ok_map = map { $_ => 1 } @$ok_callback; | |||||||||
| 58 | |||||||||||
| 59 | 99 | $self->{ok_callbacks} = \%ok_map; | |||||||||
| 60 | |||||||||||
| 61 | 99 | ▶ | if ( exists $arg_for->{callbacks} ) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 62 | 5 | ▶ | while ( my ( $event, $callback ) = each %{ $arg_for->{callbacks} } ) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 63 | 10 | $self->callback( $event, $callback ); | |||||||||
| 64 | } | ||||||||||
| 65 | } | ||||||||||
| 66 | |||||||||||
| 67 | 97 | return $self; | |||||||||
| 68 | } | ||||||||||
| 69 | |||||||||||
| 70 | =head3 C<callback> | ||||||||||
| 71 | |||||||||||
| 72 | Install a callback for a named event. | ||||||||||
| 73 | |||||||||||
| 74 | =cut | ||||||||||
| 75 | |||||||||||
| 76 | 18 | ▶ | sub callback { | ||||||||
|
Subroutine
callback: called CC=3 SCAR=11.0
Pod
documented
| |||||||||||
| 77 | 18 | my ( $self, $event, $callback ) = @_; | |||||||||
| 78 | |||||||||||
| 79 | 18 | my %ok_map = %{ $self->{ok_callbacks} }; | |||||||||
| 80 | |||||||||||
| 81 | 18 | ▶ | $self->_croak('No callbacks may be installed') | ||||||||
|
Branch: 1 branch
| |||||||||||
| 82 | unless %ok_map; | ||||||||||
| 83 | |||||||||||
| 84 | $self->_croak( "Callback $event is not supported. Valid callbacks are " | ||||||||||
| 85 | . join( ', ', sort keys %ok_map ) ) | ||||||||||
| 86 | 16 | ▶ | unless exists $ok_map{$event}; | ||||||||
|
Branch: 1 branch
| |||||||||||
| 87 | |||||||||||
| 88 | 13 | $self->{code_for}{$event} = $callback; | |||||||||
| 89 | } | ||||||||||
| 90 | |||||||||||
| 91 | 1061 | ▶ | sub _callback_for { | ||||||||
|
Subroutine
_callback_for: called CC=1 SCAR=0.0
| |||||||||||
| 92 | 1061 | my ( $self, $event ) = @_; | |||||||||
| 93 | 1061 | return $self->{code_for}{$event}; | |||||||||
| 94 | } | ||||||||||
| 95 | |||||||||||
| 96 | 703 | ▶ | sub _make_callback { | ||||||||
|
Subroutine
_make_callback: called CC=2 SCAR=6.9
| |||||||||||
| 97 | 703 | my $self = shift; | |||||||||
| 98 | 703 | my $event = shift; | |||||||||
| 99 | |||||||||||
| 100 | 703 | my $cb = $self->_callback_for($event); | |||||||||
| 101 | 703 | ▶ | return unless defined $cb; | ||||||||
|
Branch: 1 branch
| |||||||||||
| 102 | 12 | return $cb->(@_); | |||||||||
| 103 | } | ||||||||||
| 104 | |||||||||||
| 105 | 13 | ▶ | sub _croak { | ||||||||
|
Subroutine
_croak: called CC=1 SCAR=0.0
| |||||||||||
| 106 | 13 | my ( $self, $message ) = @_; | |||||||||
| 107 | 13 | require Carp; | |||||||||
| 108 | 13 | Carp::croak($message); | |||||||||
| 109 | } | ||||||||||
| 110 | |||||||||||
| 111 | 13 | 1; | |||||||||