Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.6

Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

ExtensionNSHandler.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 #if !defined(XALAN_EXTENSIONNSHANDLER_HEADER_GUARD)
00058 #define XALAN_EXTENSIONNSHANDLER_HEADER_GUARD
00059 
00060 
00061 // Base include file.   Must be first.
00062 #include "XSLTDefinitions.hpp"
00063 
00064 
00065 
00066 // Base class
00067 #include "ExtensionFunctionHandler.hpp"
00068 
00069 
00070 
00071 #include <set>
00072 
00073 
00074 
00075 #include <xalanc/XalanDOM/XalanDOMString.hpp>
00076 
00077 
00078 
00079 XALAN_CPP_NAMESPACE_BEGIN
00080 
00081 
00082 
00083 class Stylesheet;
00084 class StylesheetExecutionContext;
00085 class XalanElement;
00086 class XalanNode;
00087 class XalanQName;
00088 
00089 
00090 
00091 class XALAN_XSLT_EXPORT ExtensionNSHandler : public ExtensionFunctionHandler
00092 {    
00093 public: 
00100     ExtensionNSHandler(const XalanDOMString&    namespaceUri);
00101 
00115     ExtensionNSHandler(
00116             const XalanDOMString&   namespaceUri,
00117             const XalanDOMString&   elemNames,
00118             const XalanDOMString&   funcNames,
00119             const XalanDOMString&   lang,
00120             const XalanDOMString&   srcURL,
00121             const XalanDOMString&   src);
00122 
00130     virtual void
00131     setFunctions(const XalanDOMString&  funcNames); 
00132 
00143     virtual void
00144     setScript(
00145             const XalanDOMString&   lang,
00146             const XalanDOMString&   srcURL,
00147             const XalanDOMString&   scriptSrc); 
00148 
00155     void
00156     setElements(const XalanDOMString&   elemNames); 
00157 
00164     bool
00165     isElementAvailable (const XalanDOMString&   element) const;
00166 
00185     void
00186     processElement (
00187             StylesheetExecutionContext&     executionContext,
00188             const XalanDOMString&           localPart,
00189             const XalanElement*             element,
00190             Stylesheet&                     stylesheetTree, 
00191             const XalanNode*                sourceTree,
00192             const XalanNode*                sourceNode,
00193             const XalanQName&               mode);
00194 
00195 protected:
00196 
00203     virtual void
00204     startupComponent();
00205 
00206 
00207 private:
00208 
00209 #if defined(XALAN_NO_STD_NAMESPACE)
00210     typedef set<XalanDOMString,
00211                 less<XalanDOMString> >  ExtensionSetType;
00212 #else
00213     typedef std::set<XalanDOMString>    ExtensionSetType;
00214 #endif
00215 
00216     // Extension elements of this namespace
00217     ExtensionSetType    m_elements;
00218 
00219     // True when info from the component description has been loaded. This gets
00220     // set as soon as any of the info has been specified. If this is false,
00221     // when processElement or processFunction is called it will use the
00222     // namespace URI as a URL and try to load that location as the component
00223     // description
00224     bool m_componentDescLoaded;
00225 
00230     void
00231     loadComponentDescription();
00232 
00244     static XalanDOMString
00245     getScriptString(const XalanElement&     elem);
00246 };
00247 
00248 
00249 
00250 XALAN_CPP_NAMESPACE_END
00251 
00252 
00253 
00254 #endif  // XALAN_EXTENSIONNSHANDLER_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.6
Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.