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

XPathEnvSupport.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(XPATHENVSUPPORT_HEADER_GUARD_1357924680)
00060 #define XPATHENVSUPPORT_HEADER_GUARD_1357924680
00061 
00062 
00063 
00064 // Base include file.  Must be first.
00065 #include <xalanc/XPath/XPathDefinitions.hpp>
00066 
00067 
00068 
00069 #include <map>
00070 #include <vector>
00071 
00072 
00073 
00074 // $$$ ToDo: Necessary while XalanDOMString is style a typedef.
00075 #include <xalanc/XalanDOM/XalanDOMString.hpp>
00076 
00077 
00078 
00079 #include <xalanc/PlatformSupport/DOMStringHelper.hpp>
00080 
00081 
00082 
00083 #include <xalanc/XPath/Function.hpp>
00084 
00085 
00086 
00087 XALAN_DECLARE_XERCES_CLASS(Locator)
00088 
00089 
00090 
00091 XALAN_CPP_NAMESPACE_BEGIN
00092 
00093 
00094 
00095 class NodeRefListBase;
00096 class PrefixResolver;
00097 class XObject;
00098 class XPathExecutionContext;
00099 class XObjectFactory;
00100 class XalanDocument;
00101 class XalanElement;
00102 class XalanNode;
00103 class XalanQName;
00104 
00105 
00106 
00107 class XALAN_XPATH_EXPORT XPathEnvSupport
00108 {
00109 public:
00110 
00111     typedef XERCES_CPP_NAMESPACE_QUALIFIER Locator  LocatorType;
00112 
00113     typedef Function::XObjectArgVectorType  XObjectArgVectorType;
00114 
00115     XPathEnvSupport();
00116 
00117     virtual
00118     ~XPathEnvSupport();
00119 
00127     virtual XalanDocument*
00128     parseXML(
00129             const XalanDOMString&   urlString,
00130             const XalanDOMString&   base) = 0;
00131 
00138     virtual XalanDocument*
00139     getSourceDocument(const XalanDOMString&     theURI) const = 0;
00140 
00147     virtual void
00148     setSourceDocument(
00149             const XalanDOMString&   theURI,
00150             XalanDocument*          theDocument) = 0;
00151 
00159     virtual XalanDOMString
00160     findURIFromDoc(const XalanDocument*     owner) const = 0;
00161 
00169     virtual bool
00170     elementAvailable(
00171             const XalanDOMString&   theNamespace, 
00172             const XalanDOMString&   elementName) const = 0;
00173 
00183     virtual bool
00184     functionAvailable(
00185             const XalanDOMString&   theNamespace, 
00186             const XalanDOMString&   functionName) const = 0;
00187 
00198     virtual XObjectPtr
00199     extFunction(
00200             XPathExecutionContext&          executionContext,
00201             const XalanDOMString&           theNamespace,
00202             const XalanDOMString&           functionName, 
00203             XalanNode*                      context,
00204             const XObjectArgVectorType&     argVec,
00205             const LocatorType*              locator) const = 0;
00206 
00207     enum eSource { eXMLParser       = 1,
00208                    eXSLTProcessor   = 2,
00209                    eXPATHParser     = 3,
00210                    eXPATHProcessor  = 4,
00211                    eDataSource      = 5 };
00212 
00213     enum eClassification { eMessage = 0,
00214                            eWarning = 1,
00215                            eError = 2 };
00216 
00233     virtual bool
00234     problem(
00235             eSource                 where,
00236             eClassification         classification,
00237             const PrefixResolver*   resolver,
00238             const XalanNode*        sourceNode,
00239             const XalanDOMString&   msg,
00240             const XalanDOMChar*     uri,
00241             int                     lineNo,
00242             int                     charOffset) const = 0;
00243 
00247     virtual void
00248     reset() = 0;
00249 
00250 private:
00251 
00252     // These are not implemented...
00253     XPathEnvSupport(const XPathEnvSupport&);
00254 
00255     XPathEnvSupport&
00256     operator=(const XPathEnvSupport&);
00257 
00258     bool
00259     operator==(const XPathEnvSupport&) const;
00260 };
00261 
00262 
00263 
00264 XALAN_CPP_NAMESPACE_END
00265 
00266 
00267 
00268 #endif  // XPATHENVSUPPORT_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.