Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.8

Main Page | Directories | 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  * Copyright 1999-2004 The Apache Software Foundation.
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #if !defined(XPATHENVSUPPORT_HEADER_GUARD_1357924680)
00017 #define XPATHENVSUPPORT_HEADER_GUARD_1357924680
00018 
00019 
00020 
00021 // Base include file.  Must be first.
00022 #include <xalanc/XPath/XPathDefinitions.hpp>
00023 
00024 
00025 
00026 #include <map>
00027 #include <vector>
00028 
00029 
00030 
00031 // $$$ ToDo: Necessary while XalanDOMString is style a typedef.
00032 #include <xalanc/XalanDOM/XalanDOMString.hpp>
00033 
00034 
00035 
00036 #include <xalanc/PlatformSupport/DOMStringHelper.hpp>
00037 
00038 
00039 
00040 #include <xalanc/XPath/Function.hpp>
00041 
00042 
00043 
00044 XALAN_DECLARE_XERCES_CLASS(Locator)
00045 
00046 
00047 
00048 XALAN_CPP_NAMESPACE_BEGIN
00049 
00050 
00051 
00055 class NodeRefListBase;
00056 class PrefixResolver;
00057 class XObject;
00058 class XPathExecutionContext;
00059 class XObjectFactory;
00060 class XalanDocument;
00061 class XalanElement;
00062 class XalanNode;
00063 class XalanQName;
00064 
00065 
00066 
00067 class XALAN_XPATH_EXPORT XPathEnvSupport
00068 {
00069 public:
00070 
00071     typedef XERCES_CPP_NAMESPACE_QUALIFIER Locator  LocatorType;
00072 
00073     typedef Function::XObjectArgVectorType  XObjectArgVectorType;
00074 
00075     XPathEnvSupport();
00076 
00077     virtual
00078     ~XPathEnvSupport();
00079 
00087     virtual XalanDocument*
00088     parseXML(
00089             const XalanDOMString&   urlString,
00090             const XalanDOMString&   base) = 0;
00091 
00098     virtual XalanDocument*
00099     getSourceDocument(const XalanDOMString&     theURI) const = 0;
00100 
00107     virtual void
00108     setSourceDocument(
00109             const XalanDOMString&   theURI,
00110             XalanDocument*          theDocument) = 0;
00111 
00119     virtual XalanDOMString
00120     findURIFromDoc(const XalanDocument*     owner) const = 0;
00121 
00129     virtual bool
00130     elementAvailable(
00131             const XalanDOMString&   theNamespace, 
00132             const XalanDOMString&   elementName) const = 0;
00133 
00143     virtual bool
00144     functionAvailable(
00145             const XalanDOMString&   theNamespace, 
00146             const XalanDOMString&   functionName) const = 0;
00147 
00158     virtual XObjectPtr
00159     extFunction(
00160             XPathExecutionContext&          executionContext,
00161             const XalanDOMString&           theNamespace,
00162             const XalanDOMString&           functionName, 
00163             XalanNode*                      context,
00164             const XObjectArgVectorType&     argVec,
00165             const LocatorType*              locator) const = 0;
00166 
00167     enum eSource { eXMLParser       = 1,
00168                    eXSLTProcessor   = 2,
00169                    eXPATHParser     = 3,
00170                    eXPATHProcessor  = 4,
00171                    eDataSource      = 5 };
00172 
00173     enum eClassification { eMessage = 0,
00174                            eWarning = 1,
00175                            eError = 2 };
00176 
00193     virtual bool
00194     problem(
00195             eSource                 where,
00196             eClassification         classification,
00197             const PrefixResolver*   resolver,
00198             const XalanNode*        sourceNode,
00199             const XalanDOMString&   msg,
00200             const XalanDOMChar*     uri,
00201             int                     lineNo,
00202             int                     charOffset) const = 0;
00203 
00207     virtual void
00208     reset() = 0;
00209 
00210 private:
00211 
00212     // These are not implemented...
00213     XPathEnvSupport(const XPathEnvSupport&);
00214 
00215     XPathEnvSupport&
00216     operator=(const XPathEnvSupport&);
00217 
00218     bool
00219     operator==(const XPathEnvSupport&) const;
00220 };
00221 
00222 
00223 
00224 XALAN_CPP_NAMESPACE_END
00225 
00226 
00227 
00228 #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.8
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.