3 # See the bottom of this file for the POD documentation. Search for the
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).
13 $CGI::Pretty::VERSION = '1.05_00';
14 $CGI::DefaultClass = __PACKAGE__;
15 $CGI::Pretty::AutoloadClass = 'CGI';
16 @CGI::Pretty::ISA = qw( CGI );
23 foreach my $i ( @CGI::Pretty::AS_IS ) {
24 if ( $$input =~ /<\/$i>/si ) {
25 my ( $a, $b, $c, $d, $e ) = $$input =~ /(.*)<$i(\s?)(.*?)>(.*?)<\/$i>(.*)/si;
29 $$input = "$a<$i$b$c>$d</$i>$e";
33 $$input =~ s/$CGI::Pretty::LINEBREAK/$CGI::Pretty::LINEBREAK$CGI::Pretty::INDENT/g if $CGI::Pretty::LINEBREAK;
37 my($self,@p) = CGI::self_or_CGI(@_);
40 $s =~ s/$CGI::Pretty::LINEBREAK/$CGI::Pretty::LINEBREAK$CGI::Pretty::INDENT/g if $CGI::Pretty::LINEBREAK;
42 return $self->SUPER::comment( "$CGI::Pretty::LINEBREAK$CGI::Pretty::INDENT$s$CGI::Pretty::LINEBREAK" ) . $CGI::Pretty::LINEBREAK;
46 my ($self,$tagname) = @_;
47 return $self->SUPER::_make_tag_func($tagname) if $tagname=~/^(start|end)_/;
49 # As Lincoln as noted, the last else clause is VERY hairy, and it
50 # took me a while to figure out what I was trying to do.
51 # What it does is look for tags that shouldn't be indented (e.g. PRE)
52 # and makes sure that when we nest tags, those tags don't get
54 # For an example, try print td( pre( "hello\nworld" ) );
55 # If we didn't care about stuff like that, the code would be
56 # MUCH simpler. BTW: I won't claim to be a regular expression
57 # guru, so if anybody wants to contribute something that would
58 # be quicker, easier to read, etc, I would be more than
59 # willing to put it in - Brian
63 # handle various cases in which we're called
64 # most of this bizarre stuff is to avoid -w errors
67 (substr(ref(\$_[0]),0,3) eq 'CGI' ||
68 UNIVERSAL::isa(\$_[0],'CGI')));
71 if (ref(\$_[0]) && ref(\$_[0]) eq 'HASH') {
72 my(\@attr) = make_attributes(shift);
73 \$attr = " \@attr" if \@attr;
76 my(\$tag,\$untag) = ("\L<$tagname\E\$attr>","\L</$tagname>\E");
77 return \$tag unless \@_;
80 my \$NON_PRETTIFY_ENDTAGS = join "", map { "</\$_>" } \@CGI::Pretty::AS_IS;
82 if ( \$NON_PRETTIFY_ENDTAGS =~ /\$untag/ ) {
83 \@result = map { "\$tag\$_\$untag\$CGI::Pretty::LINEBREAK" }
84 (ref(\$_[0]) eq 'ARRAY') ? \@{\$_[0]} : "\@_";
88 if(ref(\$_[0]) eq 'ARRAY') {
93 \$args[0] .= " " unless \$args[0] =~ /\\s\$/;
99 if ( \$_ !~ /<\\// ) {
100 s/\$CGI::Pretty::LINEBREAK/\$CGI::Pretty::LINEBREAK\$CGI::Pretty::INDENT/g if \$CGI::Pretty::LINEBREAK;
104 CGI::Pretty::_prettyPrint( \\\$tmp );
107 "\$tag\$CGI::Pretty::LINEBREAK\$CGI::Pretty::INDENT\$_\$CGI::Pretty::LINEBREAK\$untag\$CGI::Pretty::LINEBREAK"
117 return CGI::start_html( @_ ) . $CGI::Pretty::LINEBREAK;
121 return CGI::end_html( @_ ) . $CGI::Pretty::LINEBREAK;
126 my $this = $class->SUPER::new( @_ );
128 Apache->request->register_cleanup(\&CGI::Pretty::_reset_globals) if ($CGI::MOD_PERL);
129 $class->_reset_globals if $CGI::PERLEX;
131 return bless $this, $class;
134 sub initialize_globals {
135 # This is the string used for indentation of tags
136 $CGI::Pretty::INDENT = "\t";
138 # This is the string used for seperation between tags
139 $CGI::Pretty::LINEBREAK = "\n";
141 # These tags are not prettify'd.
142 @CGI::Pretty::AS_IS = qw( a pre code script textarea );
146 sub _reset_globals { initialize_globals(); }
152 CGI::Pretty - module to produce nicely formatted HTML code
156 use CGI::Pretty qw( :html3 );
158 # Print a table with a single data element
159 print table( TR( td( "foo" ) ) );
163 CGI::Pretty is a module that derives from CGI. It's sole function is to
164 allow users of CGI to output nicely formatted HTML code.
166 When using the CGI module, the following code:
167 print table( TR( td( "foo" ) ) );
169 produces the following output:
170 <TABLE><TR><TD>foo</TD></TR></TABLE>
172 If a user were to create a table consisting of many rows and many columns,
173 the resultant HTML code would be quite difficult to read since it has no
174 carriage returns or indentation.
176 CGI::Pretty fixes this problem. What it does is add a carriage
177 return and indentation to the HTML code so that one can easily read
180 print table( TR( td( "foo" ) ) );
182 now produces the following output:
192 =head2 Tags that won't be formatted
194 The <A> and <PRE> tags are not formatted. If these tags were formatted, the
195 user would see the extra indentation on the web browser causing the page to
196 look different than what would be expected. If you wish to add more tags to
197 the list of tags that are not to be touched, push them onto the C<@AS_IS> array:
199 push @CGI::Pretty::AS_IS,qw(CODE XMP);
201 =head2 Customizing the Indenting
203 If you wish to have your own personal style of indenting, you can change the
206 $CGI::Pretty::INDENT = "\t\t";
208 would cause the indents to be two tabs.
210 Similarly, if you wish to have more space between lines, you may change the
211 C<$LINEBREAK> variable:
213 $CGI::Pretty::LINEBREAK = "\n\n";
215 would create two carriage returns between lines.
217 If you decide you want to use the regular CGI indenting, you can easily do
220 $CGI::Pretty::INDENT = $CGI::Pretty::LINEBREAK = "";
224 This section intentionally left blank.
228 Brian Paulsen <Brian@ThePaulsens.com>, with minor modifications by
229 Lincoln Stein <lstein@cshl.org> for incorporation into the CGI.pm
232 Copyright 1999, Brian Paulsen. All rights reserved.
234 This library is free software; you can redistribute it and/or modify
235 it under the same terms as Perl itself.
237 Bug reports and comments to Brian@ThePaulsens.com. You can also write
238 to lstein@cshl.org, but this code looks pretty hairy to me and I'm not
239 sure I understand it!