git.sesse.net Git - xml-template/blob - perl-sax/XML/TemplateSAX.pm

   1 #! /usr/bin/perl
   2
   3 #
   4 # SAX version of XML::Template. Advantages over DOM: Doesn't have to load
   5 # the entire thing into memory, and you can chain filters. Disadvantages:
   6 # Slightly kludgier interface, and you won't get a DOM tree out.
   7 #
   8 # Differences from the DOM version:
   9 #
  10 # - There is no process(). Instead, it works as a SAX filter, so you put it
  11 #   in the stream, usually between a parser and a writer (ie.
  12 #   parser -> XML::TemplateSAX::Handler -> writer). process_file works as
  13 #   before, but it returns a _string_, not a DOM tree.
  14 # - You can no longer insert a DOM tree, naturally. Instead, you can set up
  15 #   an XML::TemplateSAX::Buffer, let it gobble up your data, and send it
  16 #   in the way you'd insert a DOM tree. process_file_to_buffer does this
  17 #   transparently for you, returning a buffer you can give in.
  18 #
  19
  20 use strict;
  21 use warnings;
  22 use XML::SAX::Expat;
  23 use XML::SAX::Writer;
  24 use XML::TemplateSAX::Buffer;
  25 use XML::TemplateSAX::Cleaner;
  26 use XML::TemplateSAX::Handler;
  27
  28 package XML::TemplateSAX;
  29
  30 sub process_file_to_handler {
  31         my ($filename, $handler, $obj, $clean) = @_;
  32         $clean = 1 unless (defined($clean));
  33
  34         my ($cleaner, $filter, $parser);
  35         my $str = '';
  36
  37         if ($clean) {
  38                 $cleaner = XML::TemplateSAX::Cleaner->new(Handler => $handler);
  39                 $filter = XML::TemplateSAX::Handler->new(Handler => $cleaner, Content => $obj);
  40         } else {
  41                 $filter = XML::TemplateSAX::Handler->new(Handler => $handler, Content => $obj);
  42         }
  43
  44         # FIXME: hardcoding expat = not good?
  45         $parser = XML::SAX::Expat->new(Handler => $filter);
  46         $parser->parse_file($filename);
  47
  48         return $str;
  49 }
  50
  51 sub process_file {
  52         my ($filename, $obj, $clean) = @_;
  53
  54         my $str = '';
  55         my $writer = XML::SAX::Writer->new(Output => \$str);
  56
  57         process_file_to_handler($filename, $writer, $obj, $clean);
  58
  59         return $str;
  60 }
  61
  62 sub process_file_to_buffer {
  63         my ($filename, $obj, $clean) = @_;
  64
  65         my $buffer = XML::TemplateSAX::Buffer->new;
  66         process_file_to_handler($filename, $buffer, $obj, $clean);
  67
  68         return $buffer;
  69 }
  70
  71 sub alternate {
  72         my ($tag, $array, @elems) = @_;
  73
  74         my $i = 0;
  75         my $num = scalar @elems;
  76
  77         for my $ref (@$array) {
  78                 if (defined($ref)) {
  79                         $ref->{$tag} = $elems[$i++ % $num];
  80                 }
  81         }
  82
  83         return $array;
  84 }
  85
  86 1;