#
# $Id: Trace.pm,v 1.7 2003/03/02 11:12:09 dsw Exp $
#
# COPYRIGHT AND LICENSE
# Copyright (c) 2001-2003, Juniper Networks, Inc.  
# All rights reserved.  
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
# 	1.	Redistributions of source code must retain the above
# copyright notice, this list of conditions and the following
# disclaimer. 
# 	2.	Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following disclaimer
# in the documentation and/or other materials provided with the
# distribution. 
# 	3.	The name of the copyright owner may not be used to 
# endorse or promote products derived from this software without specific 
# prior written permission. 
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#

package JUNOS::Trace;

use strict;
use vars qw(@ISA @EXPORT %trace_dont %trace_do $trace_all);

require Exporter;
@ISA = qw(Exporter);
@EXPORT = qw(trace tracept);

%trace_dont = (Noise => 1);
%trace_do = (Always => 1);
$trace_all = 0;

sub set_trace
{
    foreach my $flag (@_) {
	$trace_do{$flag} = 1;
    }
}

sub set_dont_trace
{
    foreach my $flag (@_) {
	$trace_dont{$flag} = 1;
    }
}

sub init
{
    my($all, $do, $dont) = @_;
    $trace_all = $all;
    set_trace(@$do);
    set_dont_trace(@$dont);
}

sub trace
{
    my $token = shift;
    return if $trace_dont{$token};
    return unless $trace_all or $trace_do{$token};

    my $out = join("", @_);
    $out .= "\n" unless $out =~ /\n$/;
    print $out;
}

sub tracept
{
    my $token = shift;
    return if $trace_dont{$token};
    return unless $trace_all or $trace_do{$token};

    $DB::single = 1;
}

1;

__END__

=head1 NAME

JUNOS::Trace - Outputs trace messages.

=head1 SYNOPSIS

This example enables all trace categories so all trace messages will be displayed on STDOUT.

    use JUNOS::Trace;