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

XSLTProcessorEnvSupportDefault.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  * @author <a href="mailto:david_n_bertoni@lotus.com">David N. Bertoni</a>
00058  */
00059 #if !defined(XSLTPROCESSORENVSUPPORTDEFAULT_HEADER_GUARD_1357924680)
00060 #define XSLTPROCESSORENVSUPPORTDEFAULT_HEADER_GUARD_1357924680
00061 
00062 
00063 
00064 // Base include file.  Must be first.
00065 #include <xalanc/XSLT/XSLTDefinitions.hpp>
00066 
00067 
00068 
00069 // Base class header file...
00070 #include <xalanc/XSLT/XSLTProcessorEnvSupport.hpp>
00071 
00072 
00073 
00074 #include <xalanc/XPath/XPathEnvSupportDefault.hpp>
00075 
00076 
00077 
00078 XALAN_CPP_NAMESPACE_BEGIN
00079 
00080 
00081 
00082 class XSLTProcessor;
00083 
00084 
00085 
00086 class XALAN_XSLT_EXPORT XSLTProcessorEnvSupportDefault : public XSLTProcessorEnvSupport
00087 {
00088 public:
00089 
00090     XSLTProcessorEnvSupportDefault(XSLTProcessor*   theProcessor = 0);
00091 
00092     virtual
00093     ~XSLTProcessorEnvSupportDefault();
00094 
00100     void
00101     setProcessor(XSLTProcessor*     theProcessor)
00102     {
00103         m_processor = theProcessor;
00104     }
00105 
00106 
00114     static void
00115     installExternalFunctionGlobal(
00116             const XalanDOMString&   theNamespace,
00117             const XalanDOMString&   functionName,
00118             const Function&         function);
00119 
00126     static void
00127     uninstallExternalFunctionGlobal(
00128             const XalanDOMString&   theNamespace,
00129             const XalanDOMString&   functionName);
00130 
00131     // Interfaces to install and uninstall external functions in this instance.
00132 
00140     virtual void
00141     installExternalFunctionLocal(
00142             const XalanDOMString&   theNamespace,
00143             const XalanDOMString&   functionName,
00144             const Function&         function);
00145 
00152     virtual void
00153     uninstallExternalFunctionLocal(
00154             const XalanDOMString&   theNamespace,
00155             const XalanDOMString&   functionName);
00156 
00157 
00158     // These interfaces are inherited from XSLTProcessorEnvSupport...
00159 
00160     virtual bool
00161     problem(
00162             eSource                     where,
00163             eClassification             classification,
00164             const XalanNode*            sourceNode,
00165             const ElemTemplateElement*  styleNode,
00166             const XalanDOMString&       msg,
00167             const XalanDOMChar*         uri,
00168             int                         lineNo,
00169             int                         charOffset) const;
00170 
00171     // These interfaces are inherited from XPathEnvSupport...
00172 
00173     virtual XalanDocument*
00174     parseXML(
00175             const XalanDOMString&   urlString,
00176             const XalanDOMString&   base);
00177 
00178     virtual XalanDocument*
00179     getSourceDocument(const XalanDOMString&     theURI) const;
00180 
00181     virtual void
00182     setSourceDocument(
00183             const XalanDOMString&   theURI,
00184             XalanDocument*          theDocument);
00185 
00186     virtual XalanDOMString
00187     findURIFromDoc(const XalanDocument*     owner) const;
00188 
00189     virtual bool
00190     elementAvailable(
00191             const XalanDOMString&   theNamespace, 
00192             const XalanDOMString&   elementName) const;
00193 
00194     virtual bool
00195     functionAvailable(
00196             const XalanDOMString&   theNamespace, 
00197             const XalanDOMString&   functionName) const;
00198 
00199     virtual XObjectPtr
00200     extFunction(
00201             XPathExecutionContext&          executionContext,
00202             const XalanDOMString&           theNamespace,
00203             const XalanDOMString&           functionName,
00204             XalanNode*                      context,
00205             const XObjectArgVectorType&     argVec,
00206             const LocatorType*              locator) const;
00207 
00208     virtual bool
00209     problem(
00210             eSource                 where,
00211             eClassification         classification,
00212             const PrefixResolver*   resolver,
00213             const XalanNode*        sourceNode,
00214             const XalanDOMString&   msg,
00215             const XalanDOMChar*     uri,
00216             int                     lineNo,
00217             int                     charOffset) const;
00218 
00219     // These interfaces are inherited from Resettable...
00220 
00221     virtual void
00222     reset();
00223 
00224 
00225     // These are not implemented...
00226     XSLTProcessorEnvSupportDefault(const XSLTProcessorEnvSupportDefault&);
00227 
00228     XSLTProcessorEnvSupportDefault&
00229     operator=(const XSLTProcessorEnvSupportDefault&);
00230 
00231     bool
00232     operator==(const XSLTProcessorEnvSupportDefault&) const;
00233 
00234 
00235     // Data members...
00236 
00237     XPathEnvSupportDefault      m_defaultSupport;
00238 
00239     XSLTProcessor*              m_processor;
00240 };
00241 
00242 
00243 
00244 XALAN_CPP_NAMESPACE_END
00245 
00246 
00247 
00248 #endif  // XSLTPROCESSORENVSUPPORTDEFAULT_HEADER_GUARD_1357924680

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.