Acme::Debug - A handy module to identify lines of code where bugs may be found.

Acme-Debug documentation Contained in the Acme-Debug distribution.

Index

Code Index:

Name

Top

Acme::Debug - A handy module to identify lines of code where bugs may be found.

Usage

Top

perl -d -MAcme::Debug program args

This will report only those lines of code which are buggy as the program actually executes.

Output goes to STDERR so if you program produces much output on STDOUT for instance, you might wish to put it somewhere else:

	perl -d -MAcme::Debug program args 1> /dev/null

Environment Variables

Top

These boolean variables may be set to divulge more information.

Acme_Debug_DUMP

Print the actual buggy lines.

AUTHOR

Top

Richard Foley, <acme.debug@rfi.net<gt>

COPYRIGHT AND LICENSE

Top

Copyright (C) 2004 by Richard Foley

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.2 or, at your option, any later version of Perl 5 you may have available.

Acme-Debug documentation Contained in the Acme-Debug distribution. 
#
# $Id: $
#

package Acme::Debug;

use 5.008000;
use Data::Dumper;
use File::Spec;
use strict;
use warnings;

use vars qw($VERSION);
$VERSION = do { my @r = (q$Revision: 1.47 $ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r };


require Exporter;
our @ISA = qw(Exporter);
our %EXPORT_TAGS = ( 'all' => [ qw( ) ] ); # use Acme::Debug ':all';
our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
our @EXPORT = qw( );
our $VERSION = '0.01';

my $debug   = $ENV{Acme_Debug_DEBUG}   || 0;
my $silent  = $ENV{Acme_Debug_SILENT}  || 0;
my $verbose = $ENV{Acme_Debug_VERBOSE} || 0;
my $bug     = $ENV{Acme_Debug_REGEX}   || 'b[^u]*u[^g]*g';

# sub acme_debug = \&DB::DB;


#=item perl -MAcme::Debug -e 'Acme::Debug->new("program")';

#This will parse every line of the files/s given.

#=cut

sub new { 
	my $proto = shift;
	my $class = ref($proto) ? ref($proto) : $proto;
	my $self  = {};
	bless($self, $class);
	foreach my $f (@_) {
		next unless -f $f;
		my $l = 0;
		if (open(FH, "< $f")) {
			map { DB::DB($f, $l, $_), $l++ } (<FH>);
		} else {
			die("unable to open file $f! $!\n");
		}
	}
	return $self;
}

1;

package DB;
no strict qw(refs);
no warnings;
my $i = my $i_bugs = 0;
my @bugs = ();

sub DB::DB {
	$i++;
	my ($p,$f,$l) = caller;
	if ($f =~ /Acme.Debug.pm/) {
		$f = shift;
		$l = shift;
	}
	my $line = @{"::_<$f"}[$l] || shift;
	my ($v, $d, $x) = File::Spec->splitpath($f);
	# if ($line =~ /b[^u]*u[^g]*g/mi) {
	if ($line =~ /$bug/mi) {
		$i_bugs++;
		unless ($f =~ /perl5db.pl/) {
			push(@bugs, ($debug?"[$i]":'')."  line $l of $x: $line");
		}
	}
}

sub END {
	use Data::Dumper;
	print STDERR "bug free lines:   ".($i-$i_bugs)."\n";
	print STDERR "BUGgy code lines: $i_bugs\n";
	print STDERR @bugs if $verbose;
}

1;