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, $level) = @_;
  56
  57   return 1 if $global_trace_subs < $level;
  58
  59   if (!$self->{"trace_subs"} && !$global_trace_subs) {
  60     return 1;
  61   }
  62
  63   my ($package, $filename, $line, $subroutine) = caller(1);
  64   my ($dummy1, $self_filename, $self_line) = caller(0);
  65
  66   my $indent = " " x $self->{"calldepth"};
  67   $self->{"calldepth"} += 1;
  68
  69   if (!defined($package)) {
  70     $self->_write('sub', $indent . "\\ top-level?\n");
  71   } else {
  72     $self->_write('sub', $indent
  73                     . "\\ ${subroutine} in "
  74                     . "${self_filename}:${self_line} called from "
  75                     . "${filename}:${line}\n");
  76   }
  77   return 1;
  78 }
  79
  80 sub leave_sub {
  81   my ($self, $level) = @_;
  82
  83   return 1 if $global_trace_subs < $level;
  84
  85   if (!$self->{"trace_subs"} && !$global_trace_subs) {
  86     return 1;
  87   }
  88
  89   my ($package, $filename, $line, $subroutine) = caller(1);
  90   my ($dummy1, $self_filename, $self_line) = caller(0);
  91
  92   $self->{"calldepth"} -= 1;
  93   my $indent = " " x $self->{"calldepth"};
  94
  95   if (!defined($package)) {
  96     $self->_write('sub', $indent . "/ top-level?\n");
  97   } else {
  98     $self->_write('sub', $indent . "/ ${subroutine} in " . "${self_filename}:${self_line}\n");
  99   }
 100   return 1;
 101 }
 102
 103 sub message {
 104   my ($self, $level, $message) = @_;
 105   my ($log_level) = $self->{"level"};
 106
 107   if ($global_level && ($global_level > $log_level)) {
 108     $log_level = $global_level;
 109   }
 110
 111   if ($log_level >= $level) {
 112     $self->_write(INFO == $level
 113                   ? "info"
 114                   : DEBUG1 == $level ? "debug1" : "debug2",
 115                   $message);
 116   }
 117 }
 118
 119 sub dump {
 120   my ($self, $level, $name, $variable) = @_;
 121
 122   if ($data_dumper_available) {
 123     $self->message($level, "dumping ${name}:\n" . Dumper($variable));
 124   } else {
 125     $self->message($level,
 126                    "dumping ${name}: Data::Dumper not available; "
 127                      . "variable cannot be dumped");
 128   }
 129 }
 130
 131 sub enable_sub_tracing {
 132   my ($self) = @_;
 133   $self->{"trace_subs"} = 1;
 134 }
 135
 136 sub disable_sub_tracing {
 137   my ($self) = @_;
 138   $self->{"trace_subs"} = 1;
 139 }
 140
 141 sub _write {
 142   my ($self, $prefix, $message) = @_;
 143   my $date = strftime("%Y-%m-%d %H:%M:%S $$ ${prefix}: ", localtime(time()));
 144   local *FILE;
 145
 146   chomp($message);
 147
 148   if ((FILE_TARGET == $self->{"target"})
 149       && open(FILE, ">>" . $self->{"file"})) {
 150     print(FILE "${date}${message}\n");
 151     close(FILE);
 152
 153       } elsif (STDERR_TARGET == $self->{"target"}) {
 154     print(STDERR "${date}${message}\n");
 155   }
 156 }
 157
 158 1;