SL/LXDebug.pm

   1 package LXDebug;
   2
   3 use constant NONE   => 0;
   4 use constant INFO   => 1;
   5 use constant DEBUG1 => 2;
   6 use constant DEBUG2 => 3;
   7 use constant QUERY  => 4;
   8
   9 use constant FILE_TARGET   => 0;
  10 use constant STDERR_TARGET => 1;
  11
  12 use POSIX qw(strftime);
  13
  14 my $data_dumper_available;
  15
  16 BEGIN {
  17   eval("use Data::Dumper");
  18   $data_dumper_available = $@ ? 0 : 1;
  19
  20   $global_level      = NONE;
  21   $global_trace_subs = 0;
  22 }
  23
  24 sub new {
  25   my $type = shift;
  26   my $self = {};
  27
  28   $self->{"calldepth"}  = 0;
  29   $self->{"file"}       = "/tmp/lx-office-debug.log";
  30   $self->{"target"}     = FILE_TARGET;
  31   $self->{"level"}      = 0;
  32   $self->{"trace_subs"} = 0;
  33
  34   while ($_[0]) {
  35     $self->{ $_[0] } = $_[1];
  36     shift;
  37     shift;
  38   }
  39
  40   bless($self, $type);
  41 }
  42
  43 sub set_target {
  44   my ($self, $target, $file) = @_;
  45
  46   if ((FILE_TARGET == $target) && $file) {
  47     $self->{"file"}   = $file;
  48     $self->{"target"} = FILE_TARGET;
  49
  50   } elsif (STDERR_TARGET == $target) {
  51     $self->{"target"} = STDERR_TARGET;
  52   }
  53 }
  54
  55 sub enter_sub {
  56   my ($self) = @_;
  57
  58   if (!$self->{"trace_subs"} && !$global_trace_subs) {
  59     return;
  60   }
  61
  62   my ($package, $filename, $line, $subroutine) = caller(1);
  63   my ($dummy1, $self_filename, $self_line) = caller(0);
  64
  65   my $indent = "  " x $self->{"calldepth"};
  66   $self->{"calldepth"} += 1;
  67
  68   if (!defined($package)) {
  69     $self->_write("enter_sub", $indent . "top-level?\n");
  70   } else {
  71     $self->_write("enter_sub",
  72                   $indent
  73                     . "${subroutine} in "
  74                     . "${self_filename}:${self_line} called from "
  75                     . "${filename}:${line}\n");
  76   }
  77 }
  78
  79 sub leave_sub {
  80   my ($self) = @_;
  81
  82   if (!$self->{"trace_subs"} && !$global_trace_subs) {
  83     return;
  84   }
  85
  86   my ($package, $filename, $line, $subroutine) = caller(1);
  87   my ($dummy1, $self_filename, $self_line) = caller(0);
  88
  89   $self->{"calldepth"} -= 1;
  90   my $indent = "  " x $self->{"calldepth"};
  91
  92   if (!defined($package)) {
  93     $self->_write("leave_sub", $indent . "top-level?\n");
  94   } else {
  95     $self->_write("leave_sub",
  96             $indent . "${subroutine} in " . "${self_filename}:${self_line}\n");
  97   }
  98 }
  99
 100 sub message {
 101   my ($self, $level, $message) = @_;
 102   my ($log_level) = $self->{"level"};
 103
 104   if ($global_level && ($global_level > $log_level)) {
 105     $log_level = $global_level;
 106   }
 107
 108   if ($log_level >= $level) {
 109     $self->_write(INFO   == $level ? "info"
 110                 : DEBUG1 == $level ? "debug1"
 111                 : DEBUG2 == $level ? "debug2"
 112                 : QUERY  == $level ? "query":"",
 113                 $message );
 114   }
 115 }
 116
 117 sub dump {
 118   my ($self, $level, $name, $variable) = @_;
 119
 120   if ($data_dumper_available) {
 121     $self->message($level, "dumping ${name}:\n" . Dumper($variable));
 122   } else {
 123     $self->message($level,
 124                    "dumping ${name}: Data::Dumper not available; "
 125                      . "variable cannot be dumped");
 126   }
 127 }
 128
 129 sub enable_sub_tracing {
 130   my ($self) = @_;
 131   $self->{"trace_subs"} = 1;
 132 }
 133
 134 sub disable_sub_tracing {
 135   my ($self) = @_;
 136   $self->{"trace_subs"} = 0;
 137 }
 138
 139 sub _write {
 140   my ($self, $prefix, $message) = @_;
 141   my $date = strftime("%Y-%m-%d %H:%M:%S $$ ${prefix}: ", localtime(time()));
 142   local *FILE;
 143
 144   chomp($message);
 145
 146   if ((FILE_TARGET == $self->{"target"})
 147       && open(FILE, ">>" . $self->{"file"})) {
 148     print(FILE "${date}${message}\n");
 149     close(FILE);
 150
 151       } elsif (STDERR_TARGET == $self->{"target"}) {
 152     print(STDERR "${date}${message}\n");
 153   }
 154 }
 155
 156 1;