| 1 | package Lab::Connection::Trace; | ||
| 2 | #ABSTRACT: Trace communication with instruments | ||
| 3 | $Lab::Connection::Trace::VERSION = '3.899'; | ||
| 4 | use v5.20; | ||
| 5 | |||
| 6 | use warnings; | ||
| 7 | use strict; | ||
| 8 | |||
| 9 | use Role::Tiny; | ||
| 10 | |||
| 11 | use YAML::XS; | ||
| 12 | use Data::Dumper; | ||
| 13 | use autodie; | ||
| 14 | use Carp; | ||
| 15 | use IO::File; | ||
| 16 | use Exporter 'import'; | ||
| 17 | |||
| 18 | our @EXPORT = qw( OpenTraceFile Comment SetRun StartRun StopRun | ||
| 19 | NextRun NextEvent MuteTrace ); | ||
| 20 | |||
| 21 | our $TraceChannels = 0; | ||
| 22 | our $TraceFH; | ||
| 23 | our $TraceRun = 0; | ||
| 24 | our $TraceEvent = 0; | ||
| 25 | our $TraceMute = 0; # global mute | ||
| 26 | |||
| 27 | #our $TraceFile; | ||
| 28 | |||
| 29 | |||
| 30 | sub OpenTraceFile { | ||
| 31 | my $file = shift; | ||
| 32 | $file = shift | ||
| 33 | if ( ref($file) ne '' ); # in case called $self->OpenTraceFile | ||
| 34 | |||
| 35 | $Lab::Connection::Trace::TraceChannels = 0; | ||
| 36 | $Lab::Connection::Trace::TraceFH = IO::File->new("> $file"); | ||
| 37 | |||
| 38 | # $Trace::TraceFile = $file; | ||
| 39 | } | ||
| 40 | |||
| 41 | |||
| 42 | around 'new' => sub { | ||
| 43 | my $orig = shift; | ||
| 44 | my $proto = shift; | ||
| 45 | my $class = ref($proto) || $proto; | ||
| 46 | my $twin = undef; | ||
| 47 | |||
| 48 | # getting fields and _permitted from parent class | ||
| 49 | my $self = $class->$orig(@_); | ||
| 50 | |||
| 51 | $self->_construct($class); | ||
| 52 | |||
| 53 | if ( defined($Lab::Connection::Trace::TraceFH) ) { | ||
| 54 | $Lab::Connection::Trace::TraceChannels++; | ||
| 55 | $self->{TraceChan} = $Lab::Connection::Trace::TraceChannels; | ||
| 56 | $self->{TraceMute} = 0; # per-channel mute | ||
| 57 | |||
| 58 | # this is where the info about what instrument is | ||
| 59 | # using which connection is written. | ||
| 60 | |||
| 61 | my $parent = $class; | ||
| 62 | $parent =~ s/::Trace$//; | ||
| 63 | local $Data::Dumper::Terse = 1; | ||
| 64 | local $Data::Dumper::Indent = 0; | ||
| 65 | local $Data::Dumper::Useqq = 1; | ||
| 66 | |||
| 67 | #$self->_trace('*',"new $parent (".Dumper(@_).")"); | ||
| 68 | |||
| 69 | for ( my $i = 0; $i < 10; $i++ ) { | ||
| 70 | my ( $pack, $file, $line, $subr ) = caller($i); | ||
| 71 | next unless $subr =~ /^Lab::Instrument::(\w+)::new$/i; | ||
| 72 | $self->_trace( '*', "$subr (" . Dumper(@_) . ")" ); | ||
| 73 | last; | ||
| 74 | } | ||
| 75 | |||
| 76 | } | ||
| 77 | |||
| 78 | return $self; | ||
| 79 | |||
| 80 | }; | ||
| 81 | |||
| 82 | around Write => sub { | ||
| 83 | my $orig = shift; | ||
| 84 | my $self = shift; | ||
| 85 | my $options = undef; | ||
| 86 | if ( ref $_[0] eq 'HASH' ) { $options = shift } | ||
| 87 | else { $options = {@_} } | ||
| 88 | $self->_trace( '>', $options->{command} ); | ||
| 89 | return $self->$orig($options); | ||
| 90 | }; | ||
| 91 | |||
| 92 | around Read => sub { | ||
| 93 | my $orig = shift; | ||
| 94 | my $self = shift; | ||
| 95 | my $options = undef; | ||
| 96 | if ( ref $_[0] eq 'HASH' ) { $options = shift } | ||
| 97 | else { $options = {@_} } | ||
| 98 | my $retval = $self->$orig($options); | ||
| 99 | $self->_trace( '<', $retval ); | ||
| 100 | return $retval; | ||
| 101 | }; | ||
| 102 | |||
| 103 | around BrutalRead => sub { | ||
| 104 | my $orig = shift; | ||
| 105 | my $self = shift; | ||
| 106 | my $options = undef; | ||
| 107 | if ( ref $_[0] eq 'HASH' ) { $options = shift } | ||
| 108 | else { $options = {@_} } | ||
| 109 | |||
| 110 | my $retval = $self->$orig($options); | ||
| 111 | $self->_trace( '<', $retval ); | ||
| 112 | return $retval; | ||
| 113 | |||
| 114 | }; | ||
| 115 | |||
| 116 | around Clear => sub { | ||
| 117 | my $orig = shift; | ||
| 118 | my $self = shift; | ||
| 119 | $self->_trace( '*', 'CLEAR' ); | ||
| 120 | |||
| 121 | return $self->$orig(@_); | ||
| 122 | }; | ||
| 123 | |||
| 124 | sub _trace { | ||
| 125 | my $self = shift; | ||
| 126 | my $direction = shift; | ||
| 127 | my $text = shift; | ||
| 128 | return | ||
| 129 | unless defined($Lab::Connection::Trace::TraceFH) | ||
| 130 | && defined( $self->{TraceChan} ); | ||
| 131 | return unless defined($text); | ||
| 132 | return if $self->{TraceMute}; | ||
| 133 | return if $Lab::Connection::Trace::TraceMute; | ||
| 134 | |||
| 135 | # text could be binary, encapsulate if needed | ||
| 136 | local $Data::Dumper::Terse = 1; | ||
| 137 | local $Data::Dumper::Indent = 0; | ||
| 138 | local $Data::Dumper::Useqq = 1; | ||
| 139 | |||
| 140 | print $Lab::Connection::Trace::TraceFH sprintf( | ||
| 141 | '%02d%s%s' . "\n", $self->{TraceChan}, $direction, | ||
| 142 | Dumper($text) | ||
| 143 | ); | ||
| 144 | } | ||
| 145 | |||
| 146 | |||
| 147 | sub Comment { | ||
| 148 | my $self = shift; | ||
| 149 | my $text; | ||
| 150 | my $chan = 0; | ||
| 151 | |||
| 152 | # fail quietly if trace not set up | ||
| 153 | |||
| 154 | if ( ref($self) ne '' ) { | ||
| 155 | $chan = $self->{TraceChan}; | ||
| 156 | return unless defined $chan; | ||
| 157 | $text = shift; | ||
| 158 | } | ||
| 159 | else { | ||
| 160 | $text = $self; | ||
| 161 | } | ||
| 162 | return unless defined $text; | ||
| 163 | |||
| 164 | return unless defined $Lab::Connection::Trace::TraceFH; | ||
| 165 | |||
| 166 | chomp($text); | ||
| 167 | local $Data::Dumper::Terse = 1; | ||
| 168 | local $Data::Dumper::Indent = 0; | ||
| 169 | local $Data::Dumper::Useqq = 1; | ||
| 170 | print $Lab::Connection::Trace::TraceFH | ||
| 171 | sprintf( '%02d%s%s' . "\n", $chan, '|', Dumper($text) ); | ||
| 172 | } | ||
| 173 | |||
| 174 | |||
| 175 | |||
| 176 | sub SetRun { | ||
| 177 | my $run = shift; | ||
| 178 | $run = shift if ref($run) ne ''; # in case of $self->SetRun($run); | ||
| 179 | |||
| 180 | $Lab::Connection::Trace::TraceRun = $run - 1; # increment when started | ||
| 181 | $Lab::Connection::Trace::TraceEvent = 0; | ||
| 182 | } | ||
| 183 | |||
| 184 | |||
| 185 | sub StartRun { | ||
| 186 | return unless defined $Lab::Connection::Trace::TraceFH; | ||
| 187 | |||
| 188 | my $text = shift; | ||
| 189 | $text = '' unless defined($text); | ||
| 190 | $text = shift if ( ref($text) ne '' ); # $self->RunStart($text) | ||
| 191 | my $run = shift; | ||
| 192 | if ( !defined($run) ) { | ||
| 193 | $run = ++$Lab::Connection::Trace::TraceRun; | ||
| 194 | } | ||
| 195 | $Lab::Connection::Trace::TraceEvent = 0; | ||
| 196 | local $Data::Dumper::Terse = 1; | ||
| 197 | local $Data::Dumper::Indent = 0; | ||
| 198 | local $Data::Dumper::Useqq = 1; | ||
| 199 | |||
| 200 | $text = sprintf( | ||
| 201 | 'START RUN%04d @%d %s', | ||
| 202 | $run, time(), $text | ||
| 203 | ); | ||
| 204 | print $Lab::Connection::Trace::TraceFH | ||
| 205 | sprintf( '%02d%s%s' . "\n", 0, '*', Dumper($text) ); | ||
| 206 | } | ||
| 207 | |||
| 208 | |||
| 209 | sub StopRun { | ||
| 210 | return unless defined $Lab::Connection::Trace::TraceFH; | ||
| 211 | |||
| 212 | my $run = $Lab::Connection::Trace::TraceRun; | ||
| 213 | my $event = $Lab::Connection::Trace::TraceEvent; | ||
| 214 | local $Data::Dumper::Terse = 1; | ||
| 215 | local $Data::Dumper::Indent = 0; | ||
| 216 | local $Data::Dumper::Useqq = 1; | ||
| 217 | |||
| 218 | my $text = sprintf( | ||
| 219 | 'STOP RUN%04d after %d events @%d', | ||
| 220 | $run, $event, time() | ||
| 221 | ); | ||
| 222 | print $Lab::Connection::Trace::TraceFH | ||
| 223 | sprintf( '%02d%s%s' . "\n", 0, '*', Dumper($text) ); | ||
| 224 | } | ||
| 225 | |||
| 226 | |||
| 227 | sub NextRun { | ||
| 228 | my $comment = shift; | ||
| 229 | $comment = '' unless defined $comment; | ||
| 230 | $comment = shift unless ref($comment) eq ''; | ||
| 231 | |||
| 232 | return unless defined $Lab::Connection::Trace::TraceFH; | ||
| 233 | StopRun(); | ||
| 234 | StartRun($comment); | ||
| 235 | } | ||
| 236 | |||
| 237 | |||
| 238 | sub NextEvent { | ||
| 239 | return unless defined $Lab::Connection::Trace::TraceFH; | ||
| 240 | |||
| 241 | my $ev = ++$Lab::Connection::Trace::TraceEvent; | ||
| 242 | my $run = $Lab::Connection::Trace::TraceRun; | ||
| 243 | |||
| 244 | local $Data::Dumper::Terse = 1; | ||
| 245 | local $Data::Dumper::Indent = 0; | ||
| 246 | local $Data::Dumper::Useqq = 1; | ||
| 247 | my $text = sprintf( | ||
| 248 | 'EVENT %04d RUN%04d @%d', | ||
| 249 | $ev, $run, time() | ||
| 250 | ); | ||
| 251 | print $Lab::Connection::Trace::TraceFH | ||
| 252 | sprintf( '%02d%s%s' . "\n", 0, '*', Dumper($text) ); | ||
| 253 | return $ev; | ||
| 254 | } | ||
| 255 | |||
| 256 | |||
| 257 | sub MuteTrace { | ||
| 258 | my $self = shift; | ||
| 259 | my $in = $self; | ||
| 260 | $in = shift if ref($self) ne ''; | ||
| 261 | |||
| 262 | my $mute; | ||
| 263 | if ( $in =~ /^\s*(T|Y|ON|[1-9])/i ) { | ||
| 264 | $mute = 1; | ||
| 265 | } | ||
| 266 | elsif ( $in =~ /^\s*(F|N|0|OF)/i ) { | ||
| 267 | $mute = 0; | ||
| 268 | } | ||
| 269 | else { | ||
| 270 | carp("MuteTrace boolean '$in' invalid, ignored"); | ||
| 271 | return; | ||
| 272 | } | ||
| 273 | |||
| 274 | if ( ref($self) ne '' ) { | ||
| 275 | $self->{TraceMute} = $mute; | ||
| 276 | } | ||
| 277 | else { | ||
| 278 | $Lab::Connection::Trace::TraceMute = $mute; | ||
| 279 | } | ||
| 280 | } | ||
| 281 | |||
| 282 | 1; | ||
| 283 | |||
| 284 | __END__ |