libjava/classpath/gnu/xml/transform/TemplateNode.java

   1 /* TemplateNode.java --
   2    Copyright (C) 2004 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package gnu.xml.transform;
  39
  40 import java.io.PrintStream;
  41 import java.util.Comparator;
  42 import javax.xml.namespace.QName;
  43 import javax.xml.transform.TransformerException;
  44 import org.w3c.dom.Node;
  45 import gnu.xml.xpath.DocumentOrderComparator;
  46
  47 /**
  48  * Wrapper for a source node in a template.
  49  *
  50  * @author <a href='mailto:dog@gnu.org'>Chris Burdess</a>
  51  */
  52 abstract class TemplateNode
  53 {
  54
  55   static final Comparator<Node> documentOrderComparator =
  56     new DocumentOrderComparator();
  57
  58   TemplateNode children;
  59   TemplateNode next;
  60
  61   final void apply(Stylesheet stylesheet, QName mode,
  62                    Node context, int pos, int len,
  63                    Node parent, Node nextSibling)
  64     throws TransformerException
  65   {
  66     if (stylesheet.terminated)
  67       return;
  68     if (Thread.currentThread().isInterrupted())
  69       {
  70         // Try to head off any infinite loops at the pass
  71         return;
  72       }
  73     if (stylesheet.debug)
  74       {
  75         System.err.println("Applying " + toString());
  76         System.err.println("\twith context=" + context + ", pos=" + pos +
  77                            ", len=" + len);
  78       }
  79     doApply(stylesheet, mode, context, pos, len, parent, nextSibling);
  80   }
  81
  82   abstract void doApply(Stylesheet stylesheet, QName mode,
  83                         Node context, int pos, int len,
  84                         Node parent, Node nextSibling)
  85     throws TransformerException;
  86
  87   abstract TemplateNode clone(Stylesheet stylesheet);
  88
  89   public boolean references(QName var)
  90   {
  91     if (children != null && children.references(var))
  92       return true;
  93     if (next != null && next.references(var))
  94       return true;
  95     return false;
  96   }
  97
  98   /**
  99    * Debugging
 100    */
 101   void list(int depth, PrintStream out, boolean listNext)
 102   {
 103     for (int i = 0; i < depth; i++)
 104       out.print("  ");
 105     out.println(toString());
 106     if (children != null)
 107       children.list(depth + 1, out, true);
 108     if (listNext && next != null)
 109       next.list(depth, out, listNext);
 110   }
 111
 112   /**
 113    * Indicates whether the template for which this template node is the
 114    * first node specifies the given parameter.
 115    */
 116   boolean hasParam(QName name)
 117   {
 118     for (TemplateNode ctx = this; ctx != null; ctx = ctx.next)
 119       {
 120         if (ctx instanceof ParameterNode)
 121           {
 122             ParameterNode param = (ParameterNode) ctx;
 123             if (param.type == Bindings.PARAM && param.name.equals(name))
 124               return true;
 125           }
 126       }
 127     return false;
 128   }
 129
 130 }