## Xalan-C++ API Documentation

### The Xalan C++ XSLT Processor Version 1.5

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-2002 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 XALAN_CPP_NAMESPACE_BEGIN
    00085
    00086
    00087
    00088 class XObjectPtr;
    00089
    00090
    00091
    00098 class XALAN_XSLT_EXPORT ExtensionFunctionHandler
    00099 {
    00100
    00101 public:
    00102
    00109     ExtensionFunctionHandler(const XalanDOMString&  namespaceUri);
    00110
    00123     ExtensionFunctionHandler(
    00124             const XalanDOMString&   namespaceUri,
    00125             const XalanDOMString&   funcNames,
    00126             const XalanDOMString&   lang,
    00127             const XalanDOMString&   srcURL,
    00128             const XalanDOMString&   scriptSrc);
    00129
    00130
    00131     virtual
    00132     ~ExtensionFunctionHandler();
    00133
    00140     virtual void
    00141     setFunctions(const XalanDOMString&  funcNames);
    00142
    00156     virtual void
    00157     setScript(
    00158             const XalanDOMString&   lang,
    00159             const XalanDOMString&   srcURL,
    00160             const XalanDOMString&   scriptSrc);
    00161
    00168     virtual bool
    00169     isFunctionAvailable(const XalanDOMString&   function) const;
    00170
    00172 #if defined(XALAN_NO_STD_NAMESPACE)
    00173     typedef vector<void*>                               ArgVectorType;
    00174     typedef set<XalanDOMString, less<XalanDOMString> >  StringSetType;
    00175 #else
    00176     typedef std::vector<void*>          ArgVectorType;
    00177     typedef std::set<XalanDOMString>    StringSetType;
    00178 #endif
    00179
    00196     virtual XObjectPtr
    00197     callFunction(
    00198             const XalanDOMString&   funcName,
    00199             const ArgVectorType&    args);
    00200
    00201 protected:
    00202
    00203     XalanDOMString  m_namespaceUri;  // uri of the extension namespace
    00204     XalanDOMString  m_scriptLang;    // scripting language of implementation
    00205     XalanDOMString  m_scriptSrc;     // script source to run (if any)
    00206     XalanDOMString  m_scriptSrcURL;  // URL of source of script (if any)
    00207
    00208     void* m_javaObject;         // object for javaclass engine
    00209
    00210     StringSetType   m_functions; // functions of namespace
    00211
    00212     //  BSFManager mgr = new BSFManager (); // mgr used to run scripts
    00213
    00214     bool            m_componentStarted; // true when the scripts in a
    00215
    00216     // component description (if any) have been run
    00217
    00225     virtual void
    00226     startupComponent();
    00227
    00228     static const XalanDOMChar   s_tokenDelimiterCharacters[];
    00229 };
    00230
    00231
    00232
    00233 XALAN_CPP_NAMESPACE_END
    00234
    00235
    00236
    00237 #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++ XSLT Processor Version 1.5 Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.