Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.7

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

XSLTProcessorEnvSupport.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2004 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(XSLTPROCESSORENVSUPPORT_HEADER_GUARD_1357924680)
00060 #define XSLTPROCESSORENVSUPPORT_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/XPath/XPathEnvSupport.hpp>
00071 
00072 
00073 
00074 XALAN_CPP_NAMESPACE_BEGIN
00075 
00076 
00077 
00078 class ElemTemplateElement;
00079 class XSLTProcessor;
00080 
00081 
00082 
00083 class XALAN_XSLT_EXPORT XSLTProcessorEnvSupport : public XPathEnvSupport
00084 {
00085 public:
00086 
00087     XSLTProcessorEnvSupport();
00088 
00089     virtual
00090     ~XSLTProcessorEnvSupport();
00091 
00092 
00093     // These interfaces are new...
00094 
00113     virtual bool
00114     problem(
00115             eSource                     where,
00116             eClassification             classification,
00117             const XalanNode*            sourceNode,
00118             const ElemTemplateElement*  styleNode,
00119             const XalanDOMString&       msg,
00120             const XalanDOMChar*         uri,
00121             int                         lineNo,
00122             int                         charOffset) const = 0;
00123 
00124     // These interfaces are inherited from XPathEnvSupport...
00125 
00126     virtual XalanDocument*
00127     parseXML(
00128             const XalanDOMString&   urlString,
00129             const XalanDOMString&   base) = 0;
00130 
00131     virtual XalanDocument*
00132     getSourceDocument(const XalanDOMString&     theURI) const = 0;
00133 
00134     virtual void
00135     setSourceDocument(
00136             const XalanDOMString&   theURI,
00137             XalanDocument*          theDocument) = 0;
00138 
00139     virtual XalanDOMString
00140     findURIFromDoc(const XalanDocument*     owner) const = 0;
00141 
00142     virtual bool
00143     elementAvailable(
00144             const XalanDOMString&   theNamespace, 
00145             const XalanDOMString&   elementName) const = 0;
00146 
00147     virtual bool
00148     functionAvailable(
00149             const XalanDOMString&   theNamespace, 
00150             const XalanDOMString&   functionName) const = 0;
00151 
00152     virtual XObjectPtr
00153     extFunction(
00154             XPathExecutionContext&          executionContext,
00155             const XalanDOMString&           theNamespace,
00156             const XalanDOMString&           functionName,
00157             XalanNode*                      context,
00158             const XObjectArgVectorType&     argVec,
00159             const LocatorType*              locator) const = 0;
00160 
00161     virtual bool
00162     problem(
00163             eSource                 where,
00164             eClassification         classification,
00165             const PrefixResolver*   resolver,
00166             const XalanNode*        sourceNode,
00167             const XalanDOMString&   msg,
00168             const XalanDOMChar*     uri,
00169             int                     lineNo,
00170             int                     charOffset) const = 0;
00171 
00172     // These interfaces are inherited from Resettable...
00173 
00174     virtual void
00175     reset() = 0;
00176 
00177 private:
00178 
00179     // These are not implemented...
00180     XSLTProcessorEnvSupport(const XSLTProcessorEnvSupport&);
00181 
00182     XSLTProcessorEnvSupport&
00183     operator=(const XSLTProcessorEnvSupport&);
00184 
00185     bool
00186     operator==(const XSLTProcessorEnvSupport&) const;
00187 };
00188 
00189 
00190 
00191 XALAN_CPP_NAMESPACE_END
00192 
00193 
00194 
00195 #endif  // XSLTPROCESSORENVSUPPORT_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.7
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.