home *** CD-ROM | disk | FTP | other *** search
/ PC Professionell 2004 December / PCpro_2004_12.ISO / files / webserver / tsw / TSW_3.4.0.exe / Apache2 / perl / Style.pm < prev    next >
Encoding:
Perl POD Document  |  2004-01-30  |  8.0 KB  |  358 lines
  1. #============================================================= -*-Perl-*-
  2. #
  3. # Template::Plugin::XML::Style
  4. #
  5. # DESCRIPTION
  6. #   Template Toolkit plugin which performs some basic munging of XML 
  7. #   to perform simple stylesheet like transformations.
  8. #
  9. # AUTHOR
  10. #   Andy Wardley   <abw@kfs.org>
  11. #
  12. # COPYRIGHT
  13. #   Copyright (C) 2001 Andy Wardley.  All Rights Reserved.
  14. #
  15. #   This module is free software; you can redistribute it and/or
  16. #   modify it under the same terms as Perl itself.
  17. #
  18. # REVISION
  19. #   $Id: Style.pm,v 2.34 2004/01/13 16:21:50 abw Exp $
  20. #
  21. #============================================================================
  22.  
  23. package Template::Plugin::XML::Style;
  24.  
  25. require 5.004;
  26.  
  27. use strict;
  28. use Template::Plugin::Filter;
  29.  
  30. use base qw( Template::Plugin::Filter );
  31. use vars qw( $VERSION $DYNAMIC $FILTER_NAME );
  32.  
  33. $VERSION = sprintf("%d.%02d", q$Revision: 2.34 $ =~ /(\d+)\.(\d+)/);
  34. $DYNAMIC = 1;
  35. $FILTER_NAME = 'xmlstyle';
  36.  
  37.  
  38. #------------------------------------------------------------------------
  39. # new($context, \%config)
  40. #------------------------------------------------------------------------
  41.  
  42. sub init {
  43.     my $self = shift;
  44.     my $name = $self->{ _ARGS }->[0] || $FILTER_NAME;
  45.     $self->install_filter($name);
  46.     return $self;
  47. }
  48.  
  49.  
  50. sub filter {
  51.     my ($self, $text, $args, $config) = @_;
  52.  
  53.     # munge start tags
  54.     $text =~ s/ < ([\w\.\:]+) ( \s+ [^>]+ )? > 
  55.           / $self->start_tag($1, $2, $config)
  56.           /gsex;
  57.  
  58.     # munge end tags
  59.     $text =~ s/ < \/ ([\w\.\:]+) > 
  60.           / $self->end_tag($1, $config)
  61.           /gsex;
  62.  
  63.     return $text;
  64.  
  65. }
  66.  
  67.  
  68. sub start_tag {
  69.     my ($self, $elem, $textattr, $config) = @_;
  70.     $textattr ||= '';
  71.     my ($pre, $post);
  72.  
  73.     # look for an element match in the stylesheet
  74.     my $match = $config->{ $elem } 
  75.     || $self->{ _CONFIG }->{ $elem }
  76.         || return "<$elem$textattr>";
  77.     
  78.     # merge element attributes into copy of stylesheet attributes
  79.     my $attr = { %{ $match->{ attributes } || { } } };
  80.     while ($textattr =~ / \s* ([\w\.\:]+) = " ([^"]+) " /gsx ) {
  81.     $attr->{ $1 } = $2;
  82.     }
  83.     $textattr = join(' ', map { "$_=\"$attr->{$_}\"" } keys %$attr);
  84.     $textattr = " $textattr" if $textattr;
  85.  
  86.     $elem = $match->{ element    } || $elem;
  87.     $pre  = $match->{ pre_start  } || '';
  88.     $post = $match->{ post_start } || '';
  89.  
  90.     return "$pre<$elem$textattr>$post";
  91. }
  92.  
  93.  
  94. sub end_tag {
  95.     my ($self, $elem, $config) = @_;
  96.     my ($pre, $post);
  97.  
  98.     # look for an element match in the stylesheet
  99.     my $match = $config->{ $elem } 
  100.     || $self->{ _CONFIG }->{ $elem }
  101.     || return "</$elem>";
  102.     
  103.     $elem = $match->{ element  } || $elem;
  104.     $pre  = $match->{ pre_end  } || '';
  105.     $post = $match->{ post_end } || '';
  106.     
  107.     return "$pre</$elem>$post";
  108. }
  109.  
  110.  
  111. 1;
  112.  
  113. __END__
  114.  
  115.  
  116. #------------------------------------------------------------------------
  117. # IMPORTANT NOTE
  118. #   This documentation is generated automatically from source
  119. #   templates.  Any changes you make here may be lost.
  120. # 
  121. #   The 'docsrc' documentation source bundle is available for download
  122. #   from http://www.template-toolkit.org/docs.html and contains all
  123. #   the source templates, XML files, scripts, etc., from which the
  124. #   documentation for the Template Toolkit is built.
  125. #------------------------------------------------------------------------
  126.  
  127. =head1 NAME
  128.  
  129. Template::Plugin::XML::Style - Simple XML stylesheet transfomations
  130.  
  131. =head1 SYNOPSIS
  132.  
  133.     [% USE xmlstyle 
  134.            table = { 
  135.                attributes = { 
  136.                    border      = 0
  137.                    cellpadding = 4
  138.                    cellspacing = 1
  139.                }
  140.            }
  141.     %]
  142.  
  143.     [% FILTER xmlstyle %]
  144.     <table>
  145.     <tr>
  146.       <td>Foo</td> <td>Bar</td> <td>Baz</td>
  147.     </tr>
  148.     </table>
  149.     [% END %]
  150.  
  151. =head1 DESCRIPTION
  152.  
  153. This plugin defines a filter for performing simple stylesheet based 
  154. transformations of XML text.  
  155.  
  156. Named parameters are used to define those XML elements which require
  157. transformation.  These may be specified with the USE directive when
  158. the plugin is loaded and/or with the FILTER directive when the plugin
  159. is used.
  160.  
  161. This example shows how the default attributes C<border="0"> and
  162. C<cellpadding="4"> can be added to E<lt>tableE<gt> elements.
  163.  
  164.     [% USE xmlstyle 
  165.            table = { 
  166.                attributes = { 
  167.                    border      = 0
  168.                    cellpadding = 4
  169.                }
  170.            }
  171.     %]
  172.  
  173.     [% FILTER xmlstyle %]
  174.     <table>
  175.        ...
  176.     </table>
  177.     [% END %]
  178.  
  179. This produces the output:
  180.  
  181.     <table border="0" cellpadding="4">
  182.        ...
  183.     </table>
  184.  
  185. Parameters specified within the USE directive are applied automatically each
  186. time the C<xmlstyle> FILTER is used.  Additional parameters passed to the 
  187. FILTER directive apply for only that block.
  188.  
  189.     [% USE xmlstyle 
  190.            table = { 
  191.                attributes = { 
  192.                    border      = 0
  193.                    cellpadding = 4
  194.                }
  195.            }
  196.     %]
  197.  
  198.     [% FILTER xmlstyle
  199.            tr = {
  200.                attributes = {
  201.                    valign="top"
  202.                }
  203.            }
  204.     %]
  205.     <table>
  206.        <tr>
  207.          ...
  208.        </tr>
  209.     </table>
  210.     [% END %]
  211.  
  212. Of course, you may prefer to define your stylesheet structures once and 
  213. simply reference them by name.  Passing a hash reference of named parameters
  214. is just the same as specifying the named parameters as far as the Template 
  215. Toolkit is concerned.
  216.  
  217.     [% style_one = {
  218.           table = { ... }
  219.           tr    = { ... }
  220.        }
  221.        style_two = {
  222.           table = { ... }
  223.           td    = { ... }
  224.        }
  225.        style_three = {
  226.           th = { ... }
  227.           tv = { ... }
  228.        }
  229.     %]
  230.  
  231.     [% USE xmlstyle style_one %]
  232.  
  233.     [% FILTER xmlstyle style_two %]
  234.        # style_one and style_two applied here 
  235.     [% END %]
  236.       
  237.     [% FILTER xmlstyle style_three %]
  238.        # style_one and style_three applied here 
  239.     [% END %]
  240.  
  241. Any attributes defined within the source tags will override those specified
  242. in the style sheet.
  243.  
  244.     [% USE xmlstyle 
  245.            div = { attributes = { align = 'left' } } 
  246.     %]
  247.  
  248.  
  249.     [% FILTER xmlstyle %]
  250.     <div>foo</div>
  251.     <div align="right">bar</div>
  252.     [% END %]
  253.  
  254. The output produced is:
  255.  
  256.     <div align="left">foo</div>
  257.     <div align="right">bar</div>
  258.  
  259. The filter can also be used to change the element from one type to another.
  260.  
  261.     [% FILTER xmlstyle 
  262.               th = { 
  263.                   element = 'td'
  264.                   attributes = { bgcolor='red' }
  265.               }
  266.     %]
  267.     <tr>
  268.       <th>Heading</th>
  269.     </tr>
  270.     <tr>
  271.       <td>Value</td>
  272.     </tr>
  273.     [% END %]
  274.  
  275. The output here is as follows.  Notice how the end tag C<E<lt>/thE<gt>> is
  276. changed to C<E<lt>/tdE<gt>> as well as the start tag.
  277.  
  278.     <tr>
  279.       <td bgcolor="red">Heading</td>
  280.     </tr>
  281.     <tr>
  282.       <td>Value</td>
  283.     </tr>
  284.  
  285. You can also define text to be added immediately before or after the 
  286. start or end tags.  For example:
  287.  
  288.     [% FILTER xmlstyle 
  289.               table = {
  290.                   pre_start = '<div align="center">'
  291.                   post_end  = '</div>'
  292.               }
  293.               th = { 
  294.                   element    = 'td'
  295.                   attributes = { bgcolor='red' }
  296.                   post_start = '<b>'
  297.                   pre_end    = '</b>'
  298.               }
  299.     %]
  300.     <table>
  301.     <tr>
  302.       <th>Heading</th>
  303.     </tr>
  304.     <tr>
  305.       <td>Value</td>
  306.     </tr>
  307.     </table>
  308.     [% END %]
  309.  
  310. The output produced is:
  311.  
  312.     <div align="center">
  313.     <table>
  314.     <tr>
  315.       <td bgcolor="red"><b>Heading</b></td>
  316.     </tr>
  317.     <tr>
  318.       <td>Value</td>
  319.     </tr>
  320.     </table>
  321.     </div>
  322.  
  323. =head1 AUTHOR
  324.  
  325. Andy Wardley E<lt>abw@andywardley.comE<gt>
  326.  
  327. L<http://www.andywardley.com/|http://www.andywardley.com/>
  328.  
  329.  
  330.  
  331.  
  332. =head1 VERSION
  333.  
  334. 2.34, distributed as part of the
  335. Template Toolkit version 2.13, released on 30 January 2004.
  336.  
  337. =head1 COPYRIGHT
  338.  
  339.   Copyright (C) 1996-2004 Andy Wardley.  All Rights Reserved.
  340.   Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.
  341.  
  342. This module is free software; you can redistribute it and/or
  343. modify it under the same terms as Perl itself.
  344.  
  345. =head1 SEE ALSO
  346.  
  347. L<Template::Plugin|Template::Plugin>
  348.  
  349. =cut
  350.  
  351. # Local Variables:
  352. # mode: perl
  353. # perl-indent-level: 4
  354. # indent-tabs-mode: nil
  355. # End:
  356. #
  357. # vim: expandtab shiftwidth=4:
  358.