1. /*

  2.  * The Apache Software License, Version 1.1

  3.  *

  4.  *

  5.  * Copyright (c) 1999 The Apache Software Foundation.  All rights 

  6.  * reserved.

  7.  *

  8.  * Redistribution and use in source and binary forms, with or without

  9.  * modification, are permitted provided that the following conditions

  10.  * are met:

  11.  *

  12.  * 1. Redistributions of source code must retain the above copyright

  13.  *    notice, this list of conditions and the following disclaimer. 

  14.  *

  15.  * 2. Redistributions in binary form must reproduce the above copyright

  16.  *    notice, this list of conditions and the following disclaimer in

  17.  *    the documentation and/or other materials provided with the

  18.  *    distribution.

  19.  *

  20.  * 3. The end-user documentation included with the redistribution,

  21.  *    if any, must include the following acknowledgment:  

  22.  *       "This product includes software developed by the

  23.  *        Apache Software Foundation (http://www.apache.org/)."

  24.  *    Alternately, this acknowledgment may appear in the software itself,

  25.  *    if and wherever such third-party acknowledgments normally appear.

  26.  *

  27.  * 4. The names "Xalan" and "Apache Software Foundation" must

  28.  *    not be used to endorse or promote products derived from this

  29.  *    software without prior written permission. For written 

  30.  *    permission, please contact apache@apache.org.

  31.  *

  32.  * 5. Products derived from this software may not be called "Apache",

  33.  *    nor may "Apache" appear in their name, without prior written

  34.  *    permission of the Apache Software Foundation.

  35.  *

  36.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED

  37.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES

  38.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

  39.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR

  40.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

  41.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

  42.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

  43.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

  44.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

  45.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT

  46.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

  47.  * SUCH DAMAGE.

  48.  * ====================================================================

  49.  *

  50.  * This software consists of voluntary contributions made by many

  51.  * individuals on behalf of the Apache Software Foundation and was

  52.  * originally based on software copyright (c) 1999, Lotus

  53.  * Development Corporation., http://www.lotus.com.  For more

  54.  * information on the Apache Software Foundation, please see

  55.  * <http://www.apache.org/>.

  56.  */

  57. package org.apache.xalan.processor;

  58. 

  59. import org.apache.xalan.templates.ElemLiteralResult;

  60. import org.apache.xalan.templates.ElemElement;

  61. import org.apache.xalan.templates.ElemTemplateElement;

  62. import org.apache.xalan.templates.Stylesheet;

  63. import org.apache.xalan.templates.ElemExtensionCall;

  64. import org.apache.xalan.templates.ElemTemplate;

  65. import org.apache.xalan.templates.ElemExsltFunction;

  66. import org.apache.xalan.templates.ElemExsltFuncResult;

  67. import org.apache.xalan.templates.ElemFallback;

  68. import org.apache.xalan.templates.ElemVariable;

  69. import org.apache.xalan.templates.ElemParam;

  70. import org.apache.xalan.templates.ElemValueOf;

  71. import org.apache.xalan.templates.ElemText;

  72. import org.apache.xalan.templates.ElemTextLiteral;

  73. import org.apache.xalan.templates.ElemApplyImport;

  74. import org.apache.xalan.templates.ElemApplyTemplates;

  75. import org.apache.xalan.templates.ElemAttribute;

  76. import org.apache.xalan.templates.ElemCallTemplate;

  77. import org.apache.xalan.templates.ElemComment;

  78. import org.apache.xalan.templates.ElemCopy;

  79. import org.apache.xalan.templates.ElemCopyOf;

  80. import org.apache.xalan.templates.ElemNumber;

  81. import org.apache.xalan.templates.ElemPI;

  82. import org.apache.xalan.templates.Constants;

  83. import org.apache.xpath.XPath;

  84. import org.apache.xalan.templates.StylesheetRoot;

  85. 

  86. import javax.xml.transform.SourceLocator;

  87. import javax.xml.transform.TransformerException;

  88. import javax.xml.transform.TransformerConfigurationException;

  89. import org.xml.sax.Attributes;

  90. import org.xml.sax.SAXException;

  91. 

  92. import org.w3c.dom.Node;

  93. import org.w3c.dom.NodeList;

  94. 

  95. import org.apache.xalan.res.XSLTErrorResources;

  96. 

  97. 

  98. /**

  99.  * <meta name="usage" content="internal"/>

  100.  * This class processes parse events for an exslt func:function element.

  101.  */

  102. public class ProcessorExsltFunction extends ProcessorTemplateElem

  103. {

  104.   /**

  105.    * Start an ElemExsltFunction. Verify that it is top level and that it has a name attribute with a

  106.    * namespace.

  107.    */

  108.   public void startElement(

  109.           StylesheetHandler handler, String uri, String localName, String rawName, Attributes attributes)

  110.             throws SAXException

  111.   {

  112.     //System.out.println("ProcessorFunction.startElement()");

  113.     String msg = "";

  114.     if (!(handler.getElemTemplateElement() instanceof Stylesheet))

  115.     {

  116.       msg = "func:function element must be top level.";

  117.       handler.error(msg, new SAXException(msg));

  118.     }

  119.     super.startElement(handler, uri, localName, rawName, attributes);

  120.        

  121.     String val = attributes.getValue("name");

  122.     int indexOfColon = val.indexOf(":");

  123.     if (indexOfColon > 0)

  124.     {

  125.       String prefix = val.substring(0, indexOfColon);

  126.       String localVal = val.substring(indexOfColon + 1);

  127.       String ns = handler.getNamespaceSupport().getURI(prefix);

  128.       //if (ns.length() > 0)

  129.       //  System.out.println("fullfuncname " + ns + localVal);

  130.     }

  131.     else

  132.     {

  133.       msg = "func:function name must have namespace";

  134.       handler.error(msg, new SAXException(msg));

  135.     }

  136.   }

  137.   

  138.   /**

  139.    * Must include; super doesn't suffice!

  140.    */

  141.   protected void appendAndPush(

  142.           StylesheetHandler handler, ElemTemplateElement elem)

  143.             throws SAXException

  144.   {

  145.     //System.out.println("ProcessorFunction appendAndPush()" + elem);

  146.     super.appendAndPush(handler, elem);

  147.     //System.out.println("originating node " + handler.getOriginatingNode());

  148.     elem.setDOMBackPointer(handler.getOriginatingNode());

  149.     handler.getStylesheet().setTemplate((ElemTemplate) elem);

  150.   }

  151.     

  152.   /**

  153.    * End an ElemExsltFunction, and verify its validity.

  154.    */

  155.   public void endElement(

  156.           StylesheetHandler handler, String uri, String localName, String rawName)

  157.             throws SAXException

  158.   {

  159.    ElemTemplateElement function = handler.getElemTemplateElement();

  160.    SourceLocator locator = handler.getLocator();

  161.    validate(function, handler); // may throw exception

  162.    super.endElement(handler, uri, localName, rawName);   

  163.   }

  164.   

  165.   /**

  166.    * Non-recursive traversal of FunctionElement tree based on TreeWalker to verify that

  167.    * there are no literal result elements except within a func:result element and that

  168.    * the func:result element does not contain any following siblings except xsl:fallback.

  169.    */

  170.   public void validate(ElemTemplateElement elem, StylesheetHandler handler)

  171.     throws SAXException

  172.   {

  173.     String msg = "";

  174.     while (elem != null)

  175.     { 

  176.       //System.out.println("elem " + elem);

  177.       if (elem instanceof ElemExsltFuncResult 

  178.           && elem.getNextSiblingElem() != null 

  179.           && !(elem.getNextSiblingElem() instanceof ElemFallback))

  180.       {

  181.         msg = "func:result has an illegal following sibling (only xsl:fallback allowed)";

  182.         handler.error(msg, new SAXException(msg));

  183.       }

  184.       

  185.       if((elem instanceof ElemApplyImport

  186. 	 || elem instanceof ElemApplyTemplates

  187. 	 || elem instanceof ElemAttribute

  188. 	 || elem instanceof ElemCallTemplate

  189. 	 || elem instanceof ElemComment

  190. 	 || elem instanceof ElemCopy

  191. 	 || elem instanceof ElemCopyOf

  192. 	 || elem instanceof ElemElement

  193. 	 || elem instanceof ElemLiteralResult

  194. 	 || elem instanceof ElemNumber

  195. 	 || elem instanceof ElemPI

  196. 	 || elem instanceof ElemText

  197. 	 || elem instanceof ElemTextLiteral

  198. 	 || elem instanceof ElemValueOf)

  199. 	&& !(ancestorIsOk(elem)))

  200.       {

  201.         msg ="misplaced literal result in a func:function container.";

  202.         handler.error(msg, new SAXException(msg));

  203.       }

  204.       ElemTemplateElement nextElem = elem.getFirstChildElem();

  205.       while (nextElem == null)

  206.       {

  207.         nextElem = elem.getNextSiblingElem();

  208.         if (nextElem == null)

  209.           elem = elem.getParentElem();

  210.         if (elem == null || elem instanceof ElemExsltFunction)

  211.           return; // ok

  212.       }  

  213.       elem = nextElem;

  214.     }

  215.   }

  216.   

  217.   /**

  218.    * Verify that a literal result belongs to a result element, a variable, 

  219.    * or a parameter.

  220.    */

  221.   

  222.   boolean ancestorIsOk(ElemTemplateElement child)

  223.   {

  224.     while (child.getParentElem() != null && !(child.getParentElem() instanceof ElemExsltFunction))

  225.     {

  226.       ElemTemplateElement parent = child.getParentElem();

  227.       if (parent instanceof ElemExsltFuncResult 

  228.           || parent instanceof ElemVariable

  229.           || parent instanceof ElemParam)

  230.         return true;

  231.       child = parent;      

  232.     }

  233.     return false;

  234.   }

  235.   

  236. }