## Xalan-C++ API Documentation

### The Xalan C++ XSLT Processor Version 1.9

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  * 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 // $$$ ToDo: Necessary while XalanDOMString is style a typedef.
    00027 #include <xalanc/XalanDOM/XalanDOMString.hpp>
    00028
    00029
    00030
    00031 #include <xalanc/PlatformSupport/DOMStringHelper.hpp>
    00032
    00033
    00034
    00035 #include <xalanc/XPath/Function.hpp>
    00036
    00037
    00038
    00039 XALAN_DECLARE_XERCES_CLASS(Locator)
    00040
    00041
    00042
    00043 XALAN_CPP_NAMESPACE_BEGIN
    00044
    00045
    00046
    00050 class NodeRefListBase;
    00051 class PrefixResolver;
    00052 class XObject;
    00053 class XPathExecutionContext;
    00054 class XObjectFactory;
    00055 class XalanDocument;
    00056 class XalanElement;
    00057 class XalanNode;
    00058 class XalanQName;
    00059
    00060
    00061
    00062 class XALAN_XPATH_EXPORT XPathEnvSupport
    00063 {
    00064 public:
    00065
    00066     typedef XERCES_CPP_NAMESPACE_QUALIFIER Locator  LocatorType;
    00067
    00068     typedef Function::XObjectArgVectorType  XObjectArgVectorType;
    00069
    00070     XPathEnvSupport();
    00071
    00072     virtual
    00073     ~XPathEnvSupport();
    00074
    00082     virtual XalanDocument*
    00083     parseXML(
    00084             MemoryManagerType&      theManager,
    00085             const XalanDOMString&   urlString,
    00086             const XalanDOMString&   base) = 0;
    00087
    00094     virtual XalanDocument*
    00095     getSourceDocument(const XalanDOMString&     theURI) const = 0;
    00096
    00103     virtual void
    00104     setSourceDocument(
    00105             const XalanDOMString&   theURI,
    00106             XalanDocument*          theDocument) = 0;
    00107
    00115     virtual const XalanDOMString&
    00116     findURIFromDoc(const XalanDocument*     owner) const = 0;
    00117
    00125     virtual bool
    00126     elementAvailable(
    00127             const XalanDOMString&   theNamespace,
    00128             const XalanDOMString&   elementName) const = 0;
    00129
    00139     virtual bool
    00140     functionAvailable(
    00141             const XalanDOMString&   theNamespace,
    00142             const XalanDOMString&   functionName) const = 0;
    00143
    00154     virtual XObjectPtr
    00155     extFunction(
    00156             XPathExecutionContext&          executionContext,
    00157             const XalanDOMString&           theNamespace,
    00158             const XalanDOMString&           functionName,
    00159             XalanNode*                      context,
    00160             const XObjectArgVectorType&     argVec,
    00161             const LocatorType*              locator) const = 0;
    00162
    00163     enum eSource { eXMLParser       = 1,
    00164                    eXSLTProcessor   = 2,
    00165                    eXPATHParser     = 3,
    00166                    eXPATHProcessor  = 4,
    00167                    eDataSource      = 5 };
    00168
    00169     enum eClassification { eMessage = 0,
    00170                            eWarning = 1,
    00171                            eError = 2 };
    00172
    00189     virtual bool
    00190     problem(
    00191             eSource                 where,
    00192             eClassification         classification,
    00193             const PrefixResolver*   resolver,
    00194             const XalanNode*        sourceNode,
    00195             const XalanDOMString&   msg,
    00196             const XalanDOMChar*     uri,
    00197             int                     lineNo,
    00198             int                     charOffset) const = 0;
    00199
    00203     virtual void
    00204     reset() = 0;
    00205
    00206 private:
    00207
    00208     // These are not implemented...
    00209     XPathEnvSupport(const XPathEnvSupport&);
    00210
    00211     XPathEnvSupport&
    00212     operator=(const XPathEnvSupport&);
    00213
    00214     bool
    00215     operator==(const XPathEnvSupport&) const;
    00216 };
    00217
    00218
    00219
    00220 XALAN_CPP_NAMESPACE_END
    00221
    00222
    00223
    00224 #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.9 Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.