Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

ExtensionFunctionHandler.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999 The Apache Software Foundation.  All rights 
00006  * reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. The end-user documentation included with the redistribution,
00021  *    if any, must include the following acknowledgment:  
00022  *       "This product includes software developed by the
00023  *        Apache Software Foundation (http://www.apache.org/)."
00024  *    Alternately, this acknowledgment may appear in the software itself,
00025  *    if and wherever such third-party acknowledgments normally appear.
00026  *
00027  * 4. The names "Xalan" and "Apache Software Foundation" must
00028  *    not be used to endorse or promote products derived from this
00029  *    software without prior written permission. For written 
00030  *    permission, please contact apache@apache.org.
00031  *
00032  * 5. Products derived from this software may not be called "Apache",
00033  *    nor may "Apache" appear in their name, without prior written
00034  *    permission of the Apache Software Foundation.
00035  *
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047  * SUCH DAMAGE.
00048  * ====================================================================
00049  *
00050  * This software consists of voluntary contributions made by many
00051  * individuals on behalf of the Apache Software Foundation and was
00052  * originally based on software copyright (c) 1999, International
00053  * Business Machines, Inc., http://www.ibm.com.  For more
00054  * information on the Apache Software Foundation, please see
00055  * <http://www.apache.org/>.
00056  *
00057  * $ Id: $
00058  *
00059  */
00060 
00061 #if !defined(XALAN_EXTENSIONFUNCTIONHANDLER_HEADER_GUARD)
00062 #define XALAN_EXTENSIONFUNCTIONHANDLER_HEADER_GUARD
00063 
00064 
00065 
00066 // Base include file.   Must be first.
00067 #include <XSLT/XSLTDefinitions.hpp>
00068 
00069 
00070 
00071 #include <set>
00072 #include <vector>
00073 
00074 
00075 
00076 #include <PlatformSupport/DOMStringHelper.hpp>
00077 
00078 
00079 
00080 #include <XPath/XObject.hpp>
00081 
00082 
00083 
00084 class XObjectPtr;
00085 
00086 
00087 
00094 class XALAN_XSLT_EXPORT ExtensionFunctionHandler 
00095 {
00096 
00097 public:
00098 
00105     ExtensionFunctionHandler(const XalanDOMString&  namespaceUri);
00106 
00119     ExtensionFunctionHandler(
00120             const XalanDOMString&   namespaceUri,
00121             const XalanDOMString&   funcNames,
00122             const XalanDOMString&   lang,
00123             const XalanDOMString&   srcURL,
00124             const XalanDOMString&   scriptSrc);
00125 
00126 
00127     virtual
00128     ~ExtensionFunctionHandler();
00129 
00136     virtual void
00137     setFunctions(const XalanDOMString&  funcNames);
00138 
00152     virtual void
00153     setScript(
00154             const XalanDOMString&   lang,
00155             const XalanDOMString&   srcURL,
00156             const XalanDOMString&   scriptSrc);
00157 
00164     virtual bool
00165     isFunctionAvailable(const XalanDOMString&   function) const;
00166 
00168 #if defined(XALAN_NO_NAMESPACES)
00169     typedef vector<void*>                               ArgVectorType;
00170     typedef set<XalanDOMString, less<XalanDOMString> >  StringSetType;
00171 #else
00172     typedef std::vector<void*>          ArgVectorType;
00173     typedef std::set<XalanDOMString>    StringSetType;
00174 #endif
00175 
00191 
00192     virtual XObjectPtr
00193     callFunction(
00194             const XalanDOMString&   funcName,
00195             const ArgVectorType&    args);
00196 
00197 protected:
00198 
00199     XalanDOMString  m_namespaceUri;  // uri of the extension namespace
00200     XalanDOMString  m_scriptLang;    // scripting language of implementation
00201     XalanDOMString  m_scriptSrc;     // script source to run (if any)
00202     XalanDOMString  m_scriptSrcURL;  // URL of source of script (if any)
00203 
00204     void* m_javaObject;         // object for javaclass engine
00205 
00206     StringSetType   m_functions; // functions of namespace
00207 
00208     //  BSFManager mgr = new BSFManager (); // mgr used to run scripts
00209 
00210     bool            m_componentStarted; // true when the scripts in a
00211 
00212     // component description (if any) have been run
00213 
00221     virtual void
00222     startupComponent();
00223 
00224     static const XalanDOMChar   s_tokenDelimiterCharacters[];
00225 };
00226  
00227 
00228 
00229 #endif  // XALAN_EXTENSIONFUNCTIONHANDLER_HEADER_GUARD

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.