[perl5.git] / lib / CGI / Pretty.pm

package CGI::Pretty;

# See the bottom of this file for the POD documentation.  Search for the
# string '=head'.

# You can run this file through either pod2man or pod2html to produce pretty
# documentation in manual or html file format (these utilities are part of the
# Perl 5 distribution).

use strict;
use CGI ();

$CGI::Pretty::VERSION = '1.08';
$CGI::DefaultClass = __PACKAGE__;
$CGI::Pretty::AutoloadClass = 'CGI';
@CGI::Pretty::ISA = qw( CGI );

initialize_globals();

sub _prettyPrint {
    my $input = shift;
    return if !$$input;
    return if !$CGI::Pretty::LINEBREAK || !$CGI::Pretty::INDENT;

#    print STDERR "'", $$input, "'\n";

    foreach my $i ( @CGI::Pretty::AS_IS ) {
	if ( $$input =~ m{</$i>}si ) {
	    my ( $a, $b, $c ) = $$input =~ m{(.*)(<$i[\s/>].*?</$i>)(.*)}si;
	    next if !$b;
	    $a ||= "";
	    $c ||= "";

	    _prettyPrint( \$a ) if $a;
	    _prettyPrint( \$c ) if $c;
	    
	    $b ||= "";
	    $$input = "$a$b$c";
	    return;
	}
    }
    $$input =~ s/$CGI::Pretty::LINEBREAK/$CGI::Pretty::LINEBREAK$CGI::Pretty::INDENT/g;
}

sub comment {
    my($self,@p) = CGI::self_or_CGI(@_);

    my $s = "@p";
    $s =~ s/$CGI::Pretty::LINEBREAK/$CGI::Pretty::LINEBREAK$CGI::Pretty::INDENT/g if $CGI::Pretty::LINEBREAK; 
    
    return $self->SUPER::comment( "$CGI::Pretty::LINEBREAK$CGI::Pretty::INDENT$s$CGI::Pretty::LINEBREAK" ) . $CGI::Pretty::LINEBREAK;
}

sub _make_tag_func {
    my ($self,$tagname) = @_;

    # As Lincoln as noted, the last else clause is VERY hairy, and it
    # took me a while to figure out what I was trying to do.
    # What it does is look for tags that shouldn't be indented (e.g. PRE)
    # and makes sure that when we nest tags, those tags don't get
    # indented.
    # For an example, try print td( pre( "hello\nworld" ) );
    # If we didn't care about stuff like that, the code would be
    # MUCH simpler.  BTW: I won't claim to be a regular expression
    # guru, so if anybody wants to contribute something that would
    # be quicker, easier to read, etc, I would be more than
    # willing to put it in - Brian

    my $func = qq"
	sub $tagname {";

    $func .= q'
            shift if $_[0] && 
                    (ref($_[0]) &&
                     (substr(ref($_[0]),0,3) eq "CGI" ||
                    UNIVERSAL::isa($_[0],"CGI")));
	    my($attr) = "";
	    if (ref($_[0]) && ref($_[0]) eq "HASH") {
		my(@attr) = make_attributes(shift()||undef,1);
		$attr = " @attr" if @attr;
	    }';

    if ($tagname=~/start_(\w+)/i) {
	$func .= qq! 
            return "<\L$1\E\$attr>\$CGI::Pretty::LINEBREAK";} !;
    } elsif ($tagname=~/end_(\w+)/i) {
	$func .= qq! 
            return "<\L/$1\E>\$CGI::Pretty::LINEBREAK"; } !;
    } else {
	$func .= qq#
	    return ( \$CGI::XHTML ? "<\L$tagname\E\$attr />" : "<\L$tagname\E\$attr>" ) .
                   \$CGI::Pretty::LINEBREAK unless \@_;
	    my(\$tag,\$untag) = ("<\L$tagname\E\$attr>","</\L$tagname>\E");

            my \%ASIS = map { lc("\$_") => 1 } \@CGI::Pretty::AS_IS;
            my \@args;
            if ( \$CGI::Pretty::LINEBREAK || \$CGI::Pretty::INDENT ) {
   	      if(ref(\$_[0]) eq 'ARRAY') {
                 \@args = \@{\$_[0]}
              } else {
                  foreach (\@_) {
		      \$args[0] .= \$_;
                      \$args[0] .= \$CGI::Pretty::LINEBREAK if \$args[0] !~ /\$CGI::Pretty::LINEBREAK\$/ && 0;
                      chomp \$args[0] if exists \$ASIS{ "\L$tagname\E" };
                      
  	              \$args[0] .= \$" if \$args[0] !~ /\$CGI::Pretty::LINEBREAK\$/ && 1;
		  }
                  chop \$args[0];
	      }
            }
            else {
              \@args = ref(\$_[0]) eq 'ARRAY' ? \@{\$_[0]} : "\@_";
            }

            my \@result;
            if ( exists \$ASIS{ "\L$tagname\E" } ) {
		\@result = map { "\$tag\$_\$untag\$CGI::Pretty::LINEBREAK" } 
		 \@args;
	    }
	    else {
		\@result = map { 
		    chomp; 
		    my \$tmp = \$_;
		    CGI::Pretty::_prettyPrint( \\\$tmp );
                    \$tag . \$CGI::Pretty::LINEBREAK .
                    \$CGI::Pretty::INDENT . \$tmp . \$CGI::Pretty::LINEBREAK . 
                    \$untag . \$CGI::Pretty::LINEBREAK
                } \@args;
	    }
	    local \$" = "" if \$CGI::Pretty::LINEBREAK || \$CGI::Pretty::INDENT;
	    return "\@result";
	}#;
    }    

    return $func;
}

sub start_html {
    return CGI::start_html( @_ ) . $CGI::Pretty::LINEBREAK;
}

sub end_html {
    return CGI::end_html( @_ ) . $CGI::Pretty::LINEBREAK;
}

sub new {
    my $class = shift;
    my $this = $class->SUPER::new( @_ );

    if ($CGI::MOD_PERL) {
        if ($CGI::MOD_PERL == 1) {
            my $r = Apache->request;
            $r->register_cleanup(\&CGI::Pretty::_reset_globals);
        }
        else {
            my $r = Apache2::RequestUtil->request;
            $r->pool->cleanup_register(\&CGI::Pretty::_reset_globals);
        }
    }
    $class->_reset_globals if $CGI::PERLEX;

    return bless $this, $class;
}

sub initialize_globals {
    # This is the string used for indentation of tags
    $CGI::Pretty::INDENT = "\t";
    
    # This is the string used for seperation between tags
    $CGI::Pretty::LINEBREAK = $/;

    # These tags are not prettify'd.
    @CGI::Pretty::AS_IS = qw( a pre code script textarea td );

    1;
}
sub _reset_globals { initialize_globals(); }

# ugly, but quick fix
sub import {
    my $self = shift;
    no strict 'refs';
    ${ "$self\::AutoloadClass" } = 'CGI';

    # This causes modules to clash.
    undef %CGI::EXPORT;
    undef %CGI::EXPORT;

    $self->_setup_symbols(@_);
    my ($callpack, $callfile, $callline) = caller;

    # To allow overriding, search through the packages
    # Till we find one in which the correct subroutine is defined.
    my @packages = ($self,@{"$self\:\:ISA"});
    foreach my $sym (keys %CGI::EXPORT) {
	my $pck;
	my $def = ${"$self\:\:AutoloadClass"} || $CGI::DefaultClass;
	foreach $pck (@packages) {
	    if (defined(&{"$pck\:\:$sym"})) {
		$def = $pck;
		last;
	    }
	}
	*{"${callpack}::$sym"} = \&{"$def\:\:$sym"};
    }
}

1;

=head1 NAME

CGI::Pretty - module to produce nicely formatted HTML code

=head1 SYNOPSIS

    use CGI::Pretty qw( :html3 );

    # Print a table with a single data element
    print table( TR( td( "foo" ) ) );

=head1 DESCRIPTION

CGI::Pretty is a module that derives from CGI.  It's sole function is to
allow users of CGI to output nicely formatted HTML code.

When using the CGI module, the following code:
    print table( TR( td( "foo" ) ) );

produces the following output:
    <TABLE><TR><TD>foo</TD></TR></TABLE>

If a user were to create a table consisting of many rows and many columns,
the resultant HTML code would be quite difficult to read since it has no
carriage returns or indentation.

CGI::Pretty fixes this problem.  What it does is add a carriage
return and indentation to the HTML code so that one can easily read
it.

    print table( TR( td( "foo" ) ) );

now produces the following output:
    <TABLE>
       <TR>
          <TD>
             foo
          </TD>
       </TR>
    </TABLE>


=head2 Tags that won't be formatted

The <A> and <PRE> tags are not formatted.  If these tags were formatted, the
user would see the extra indentation on the web browser causing the page to
look different than what would be expected.  If you wish to add more tags to
the list of tags that are not to be touched, push them onto the C<@AS_IS> array:

    push @CGI::Pretty::AS_IS,qw(CODE XMP);

=head2 Customizing the Indenting

If you wish to have your own personal style of indenting, you can change the
C<$INDENT> variable:

    $CGI::Pretty::INDENT = "\t\t";

would cause the indents to be two tabs.

Similarly, if you wish to have more space between lines, you may change the
C<$LINEBREAK> variable:

    $CGI::Pretty::LINEBREAK = "\n\n";

would create two carriage returns between lines.

If you decide you want to use the regular CGI indenting, you can easily do 
the following:

    $CGI::Pretty::INDENT = $CGI::Pretty::LINEBREAK = "";

=head1 BUGS

This section intentionally left blank.

=head1 AUTHOR

Brian Paulsen <Brian@ThePaulsens.com>, with minor modifications by
Lincoln Stein <lstein@cshl.org> for incorporation into the CGI.pm
distribution.

Copyright 1999, Brian Paulsen.  All rights reserved.

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

Bug reports and comments to Brian@ThePaulsens.com.  You can also write
to lstein@cshl.org, but this code looks pretty hairy to me and I'm not
sure I understand it!

=head1 SEE ALSO

L<CGI>

=cut
Commit	Line	Data
3538e1d5 GS	1	package CGI::Pretty;
	2
	3	# See the bottom of this file for the POD documentation. Search for the
	4	# string '=head'.
	5
	6	# You can run this file through either pod2man or pod2html to produce pretty
	7	# documentation in manual or html file format (these utilities are part of the
	8	# Perl 5 distribution).
	9
ffd2dff2	10	use strict;
3538e1d5 GS	11	use CGI ();
3538e1d5 GS	12
2ed511ec	13	$CGI::Pretty::VERSION = '1.08';
3538e1d5	14	$CGI::DefaultClass = __PACKAGE__;
ffd2dff2 GS	15	$CGI::Pretty::AutoloadClass = 'CGI';
ffd2dff2 GS	16	@CGI::Pretty::ISA = qw( CGI );
3538e1d5	17
ffd2dff2 GS	18	initialize_globals();
	19
	20	sub _prettyPrint {
	21	my $input = shift;
188ba755 JH	22	return if !$$input;
	23	return if !$CGI::Pretty::LINEBREAK \|\| !$CGI::Pretty::INDENT;
	24
	25	# print STDERR "'", $$input, "'\n";
ffd2dff2 GS	26
ffd2dff2 GS	27	foreach my $i ( @CGI::Pretty::AS_IS ) {
188ba755 JH	28	if ( $$input =~ m{</$i>}si ) {
	29	my ( $a, $b, $c ) = $$input =~ m{(.)(<$i[\s/>].?</$i>)(.*)}si;
	30	next if !$b;
	31	$a \|\|= "";
	32	$c \|\|= "";
	33
	34	_prettyPrint( \$a ) if $a;
	35	_prettyPrint( \$c ) if $c;
ffd2dff2	36
188ba755 JH	37	$b \|\|= "";
188ba755 JH	38	$$input = "$a$b$c";
ffd2dff2 GS	39	return;
	40	}
	41	}
188ba755	42	$$input =~ s/$CGI::Pretty::LINEBREAK/$CGI::Pretty::LINEBREAK$CGI::Pretty::INDENT/g;
ffd2dff2 GS	43	}
	44
	45	sub comment {
	46	my($self,@p) = CGI::self_or_CGI(@_);
	47
	48	my $s = "@p";
ba056755	49	$s =~ s/$CGI::Pretty::LINEBREAK/$CGI::Pretty::LINEBREAK$CGI::Pretty::INDENT/g if $CGI::Pretty::LINEBREAK;
ffd2dff2 GS	50
	51	return $self->SUPER::comment( "$CGI::Pretty::LINEBREAK$CGI::Pretty::INDENT$s$CGI::Pretty::LINEBREAK" ) . $CGI::Pretty::LINEBREAK;
	52	}
3538e1d5 GS	53
	54	sub _make_tag_func {
	55	my ($self,$tagname) = @_;
3538e1d5	56
ffd2dff2 GS	57	# As Lincoln as noted, the last else clause is VERY hairy, and it
	58	# took me a while to figure out what I was trying to do.
	59	# What it does is look for tags that shouldn't be indented (e.g. PRE)
	60	# and makes sure that when we nest tags, those tags don't get
	61	# indented.
	62	# For an example, try print td( pre( "hello\nworld" ) );
	63	# If we didn't care about stuff like that, the code would be
	64	# MUCH simpler. BTW: I won't claim to be a regular expression
	65	# guru, so if anybody wants to contribute something that would
	66	# be quicker, easier to read, etc, I would be more than
	67	# willing to put it in - Brian
3538e1d5	68
188ba755 JH	69	my $func = qq"
	70	sub $tagname {";
	71
	72	$func .= q'
	73	shift if $_[0] &&
	74	(ref($_[0]) &&
	75	(substr(ref($_[0]),0,3) eq "CGI" \|\|
	76	UNIVERSAL::isa($_[0],"CGI")));
	77	my($attr) = "";
	78	if (ref($_[0]) && ref($_[0]) eq "HASH") {
	79	my(@attr) = make_attributes(shift()\|\|undef,1);
	80	$attr = " @attr" if @attr;
	81	}';
	82
	83	if ($tagname=~/start_(\w+)/i) {
	84	$func .= qq!
	85	return "<\L$1\E\$attr>\$CGI::Pretty::LINEBREAK";} !;
	86	} elsif ($tagname=~/end_(\w+)/i) {
	87	$func .= qq!
	88	return "<\L/$1\E>\$CGI::Pretty::LINEBREAK"; } !;
	89	} else {
	90	$func .= qq#
	91	return ( \$CGI::XHTML ? "<\L$tagname\E\$attr />" : "<\L$tagname\E\$attr>" ) .
	92	\$CGI::Pretty::LINEBREAK unless \@_;
	93	my(\$tag,\$untag) = ("<\L$tagname\E\$attr>","</\L$tagname>\E");
	94
	95	my \%ASIS = map { lc("\$_") => 1 } \@CGI::Pretty::AS_IS;
	96	my \@args;
	97	if ( \$CGI::Pretty::LINEBREAK \|\| \$CGI::Pretty::INDENT ) {
	98	if(ref(\$_[0]) eq 'ARRAY') {
	99	\@args = \@{\$_[0]}
	100	} else {
	101	foreach (\@_) {
	102	\$args[0] .= \$_;
	103	\$args[0] .= \$CGI::Pretty::LINEBREAK if \$args[0] !~ /\$CGI::Pretty::LINEBREAK\$/ && 0;
	104	chomp \$args[0] if exists \$ASIS{ "\L$tagname\E" };
	105
	106	\$args[0] .= \$" if \$args[0] !~ /\$CGI::Pretty::LINEBREAK\$/ && 1;
	107	}
	108	chop \$args[0];
	109	}
	110	}
	111	else {
	112	\@args = ref(\$_[0]) eq 'ARRAY' ? \@{\$_[0]} : "\@_";
	113	}
	114
	115	my \@result;
	116	if ( exists \$ASIS{ "\L$tagname\E" } ) {
ffd2dff2	117	\@result = map { "\$tag\$_\$untag\$CGI::Pretty::LINEBREAK" }
188ba755	118	\@args;
3538e1d5 GS	119	}
	120	else {
	121	\@result = map {
	122	chomp;
188ba755 JH	123	my \$tmp = \$_;
	124	CGI::Pretty::_prettyPrint( \\\$tmp );
	125	\$tag . \$CGI::Pretty::LINEBREAK .
	126	\$CGI::Pretty::INDENT . \$tmp . \$CGI::Pretty::LINEBREAK .
	127	\$untag . \$CGI::Pretty::LINEBREAK
ac734d8b	128	} \@args;
3538e1d5	129	}
188ba755	130	local \$" = "" if \$CGI::Pretty::LINEBREAK \|\| \$CGI::Pretty::INDENT;
3538e1d5	131	return "\@result";
188ba755 JH	132	}#;
	133	}
	134
	135	return $func;
3538e1d5 GS	136	}
3538e1d5 GS	137
ffd2dff2 GS	138	sub start_html {
	139	return CGI::start_html( @_ ) . $CGI::Pretty::LINEBREAK;
	140	}
	141
	142	sub end_html {
	143	return CGI::end_html( @_ ) . $CGI::Pretty::LINEBREAK;
	144	}
	145
3538e1d5 GS	146	sub new {
	147	my $class = shift;
	148	my $this = $class->SUPER::new( @_ );
	149
8f3ccfa2	150	if ($CGI::MOD_PERL) {
8f3ccfa2	151	if ($CGI::MOD_PERL == 1) {
741ff09d	152	my $r = Apache->request;
8f3ccfa2 JH	153	$r->register_cleanup(\&CGI::Pretty::_reset_globals);
	154	}
	155	else {
741ff09d	156	my $r = Apache2::RequestUtil->request;
8f3ccfa2 JH	157	$r->pool->cleanup_register(\&CGI::Pretty::_reset_globals);
	158	}
	159	}
ffd2dff2 GS	160	$class->_reset_globals if $CGI::PERLEX;
ffd2dff2 GS	161
3538e1d5 GS	162	return bless $this, $class;
	163	}
	164
ffd2dff2 GS	165	sub initialize_globals {
	166	# This is the string used for indentation of tags
	167	$CGI::Pretty::INDENT = "\t";
	168
	169	# This is the string used for seperation between tags
188ba755	170	$CGI::Pretty::LINEBREAK = $/;
ffd2dff2 GS	171
ffd2dff2 GS	172	# These tags are not prettify'd.
188ba755	173	@CGI::Pretty::AS_IS = qw( a pre code script textarea td );
ffd2dff2 GS	174
	175	1;
	176	}
	177	sub _reset_globals { initialize_globals(); }
	178
f8a128a9 NC	179	# ugly, but quick fix
	180	sub import {
	181	my $self = shift;
	182	no strict 'refs';
	183	${ "$self\::AutoloadClass" } = 'CGI';
	184
	185	# This causes modules to clash.
	186	undef %CGI::EXPORT;
	187	undef %CGI::EXPORT;
	188
	189	$self->_setup_symbols(@_);
	190	my ($callpack, $callfile, $callline) = caller;
	191
	192	# To allow overriding, search through the packages
	193	# Till we find one in which the correct subroutine is defined.
	194	my @packages = ($self,@{"$self\:\:ISA"});
	195	foreach my $sym (keys %CGI::EXPORT) {
	196	my $pck;
	197	my $def = ${"$self\:\:AutoloadClass"} \|\| $CGI::DefaultClass;
	198	foreach $pck (@packages) {
	199	if (defined(&{"$pck\:\:$sym"})) {
	200	$def = $pck;
	201	last;
	202	}
	203	}
	204	*{"${callpack}::$sym"} = \&{"$def\:\:$sym"};
	205	}
	206	}
	207
3538e1d5 GS	208	1;
	209
	210	=head1 NAME
	211
	212	CGI::Pretty - module to produce nicely formatted HTML code
	213
	214	=head1 SYNOPSIS
	215
	216	use CGI::Pretty qw( :html3 );
	217
	218	# Print a table with a single data element
	219	print table( TR( td( "foo" ) ) );
	220
	221	=head1 DESCRIPTION
	222
	223	CGI::Pretty is a module that derives from CGI. It's sole function is to
	224	allow users of CGI to output nicely formatted HTML code.
	225
	226	When using the CGI module, the following code:
	227	print table( TR( td( "foo" ) ) );
	228
	229	produces the following output:
	230	<TABLE><TR><TD>foo</TD></TR></TABLE>
	231
	232	If a user were to create a table consisting of many rows and many columns,
	233	the resultant HTML code would be quite difficult to read since it has no
	234	carriage returns or indentation.
	235
	236	CGI::Pretty fixes this problem. What it does is add a carriage
	237	return and indentation to the HTML code so that one can easily read
	238	it.
	239
	240	print table( TR( td( "foo" ) ) );
	241
	242	now produces the following output:
	243	<TABLE>
	244	<TR>
	245	<TD>
	246	foo
	247	</TD>
	248	</TR>
	249	</TABLE>
	250
	251
	252	=head2 Tags that won't be formatted
	253
	254	The <A> and <PRE> tags are not formatted. If these tags were formatted, the
	255	user would see the extra indentation on the web browser causing the page to
	256	look different than what would be expected. If you wish to add more tags to
	257	the list of tags that are not to be touched, push them onto the C<@AS_IS> array:
	258
	259	push @CGI::Pretty::AS_IS,qw(CODE XMP);
	260
ffd2dff2 GS	261	=head2 Customizing the Indenting
	262
	263	If you wish to have your own personal style of indenting, you can change the
	264	C<$INDENT> variable:
	265
	266	$CGI::Pretty::INDENT = "\t\t";
	267
	268	would cause the indents to be two tabs.
	269
	270	Similarly, if you wish to have more space between lines, you may change the
	271	C<$LINEBREAK> variable:
	272
	273	$CGI::Pretty::LINEBREAK = "\n\n";
	274
	275	would create two carriage returns between lines.
	276
	277	If you decide you want to use the regular CGI indenting, you can easily do
	278	the following:
	279
	280	$CGI::Pretty::INDENT = $CGI::Pretty::LINEBREAK = "";
	281
3538e1d5 GS	282	=head1 BUGS
	283
	284	This section intentionally left blank.
	285
	286	=head1 AUTHOR
	287
ffd2dff2	288	Brian Paulsen <Brian@ThePaulsens.com>, with minor modifications by
3538e1d5 GS	289	Lincoln Stein <lstein@cshl.org> for incorporation into the CGI.pm
	290	distribution.
	291
ffd2dff2	292	Copyright 1999, Brian Paulsen. All rights reserved.
3538e1d5 GS	293
	294	This library is free software; you can redistribute it and/or modify
	295	it under the same terms as Perl itself.
	296
ffd2dff2	297	Bug reports and comments to Brian@ThePaulsens.com. You can also write
3538e1d5 GS	298	to lstein@cshl.org, but this code looks pretty hairy to me and I'm not
	299	sure I understand it!
	300
	301	=head1 SEE ALSO
	302
	303	L<CGI>
	304
	305	=cut