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  

XSLTProcessorEnvSupportDefault.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  * @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 <XSLT/XSLTDefinitions.hpp>
00066 
00067 
00068 
00069 // Base class header file...
00070 #include <XSLT/XSLTProcessorEnvSupport.hpp>
00071 
00072 
00073 
00074 #include <XPath/XPathEnvSupportDefault.hpp>
00075 
00076 
00077 
00078 class XSLTProcessor;
00079 
00080 
00081 
00082 class XALAN_XSLT_EXPORT XSLTProcessorEnvSupportDefault : public XSLTProcessorEnvSupport
00083 {
00084 public:
00085 
00086     XSLTProcessorEnvSupportDefault(XSLTProcessor*   theProcessor = 0);
00087 
00088     virtual
00089     ~XSLTProcessorEnvSupportDefault();
00090 
00096     void
00097     setProcessor(XSLTProcessor*     theProcessor)
00098     {
00099         m_processor = theProcessor;
00100     }
00101 
00102 
00110     static void
00111     installExternalFunctionGlobal(
00112             const XalanDOMString&   theNamespace,
00113             const XalanDOMString&   functionName,
00114             const Function&         function);
00115 
00122     static void
00123     uninstallExternalFunctionGlobal(
00124             const XalanDOMString&   theNamespace,
00125             const XalanDOMString&   functionName);
00126 
00127     // Interfaces to install and uninstall external functions in this instance.
00128 
00136     virtual void
00137     installExternalFunctionLocal(
00138             const XalanDOMString&   theNamespace,
00139             const XalanDOMString&   functionName,
00140             const Function&         function);
00141 
00148     virtual void
00149     uninstallExternalFunctionLocal(
00150             const XalanDOMString&   theNamespace,
00151             const XalanDOMString&   functionName);
00152 
00153     // These interfaces are inherited from XPathEnvSupport...
00154 
00155     virtual XalanDocument*
00156     parseXML(
00157             const XalanDOMString&   urlString,
00158             const XalanDOMString&   base);
00159 
00160     virtual XalanDocument*
00161     getSourceDocument(const XalanDOMString&     theURI) const;
00162 
00163     virtual void
00164     setSourceDocument(
00165             const XalanDOMString&   theURI,
00166             XalanDocument*          theDocument);
00167 
00168     virtual XalanDOMString
00169     findURIFromDoc(const XalanDocument*     owner) const;
00170 
00171     virtual XalanDocument*
00172     getDOMFactory() const;
00173 
00174     virtual bool
00175     elementAvailable(
00176             const XalanDOMString&   theNamespace, 
00177             const XalanDOMString&   elementName) const;
00178 
00179     virtual bool
00180     functionAvailable(
00181             const XalanDOMString&   theNamespace, 
00182             const XalanDOMString&   functionName) const;
00183 
00184     virtual XObjectPtr
00185     extFunction(
00186             XPathExecutionContext&          executionContext,
00187             const XalanDOMString&           theNamespace,
00188             const XalanDOMString&           functionName,
00189             XalanNode*                      context,
00190             const XObjectArgVectorType&     argVec) const;
00191 
00192     virtual bool
00193     problem(
00194             eSource                 where,
00195             eClassification         classification,
00196             const XalanNode*        styleNode,
00197             const XalanNode*        sourceNode,
00198             const XalanDOMString&   msg,
00199             const XalanDOMChar*     uri,
00200             int                     lineNo,
00201             int                     charOffset) const;
00202 
00203     virtual bool
00204     problem(
00205             eSource                 where,
00206             eClassification         classification,
00207             const PrefixResolver*   resolver,
00208             const XalanNode*        sourceNode,
00209             const XalanDOMString&   msg,
00210             const XalanDOMChar*     uri,
00211             int                     lineNo,
00212             int                     charOffset) const;
00213 
00214     // These interfaces are inherited from Resettable...
00215 
00216     virtual void
00217     reset();
00218 
00219 
00220     // These are not implemented...
00221     XSLTProcessorEnvSupportDefault(const XSLTProcessorEnvSupportDefault&);
00222 
00223     XSLTProcessorEnvSupportDefault&
00224     operator=(const XSLTProcessorEnvSupportDefault&);
00225 
00226     bool
00227     operator==(const XSLTProcessorEnvSupportDefault&) const;
00228 
00229 
00230     // Data members...
00231 
00232     XPathEnvSupportDefault      m_defaultSupport;
00233 
00234     XSLTProcessor*              m_processor;
00235 };
00236 
00237 
00238 
00239 #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++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.