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