Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


XSLTProcessorEnvSupportDefault.hpp
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 #if !defined(XSLTPROCESSORENVSUPPORTDEFAULT_HEADER_GUARD_1357924680)
19 #define XSLTPROCESSORENVSUPPORTDEFAULT_HEADER_GUARD_1357924680
20 
21 
22 
23 // Base include file. Must be first.
25 
26 
27 
28 // Base class header file...
30 
31 
32 
34 
35 
36 
37 XALAN_CPP_NAMESPACE_BEGIN
38 
39 
40 
41 class XSLTProcessor;
42 
43 
44 
46 {
47 public:
48 
50  MemoryManager& theManager,
51  XSLTProcessor* theProcessor = 0);
52 
53  virtual
55 
56  /**
57  * Reset the XLST processor instance
58  *
59  * @param theProcessor pointer to new processor instance
60  */
61  void
62  setProcessor(XSLTProcessor* theProcessor)
63  {
64  m_processor = theProcessor;
65  }
66 
67 
68  /**
69  * Install an external function in the global space.
70  *
71  * @param theNamespace The namespace for the functionl
72  * @param functionName The name of the function.
73  * @param function The function to install.
74  */
75  static void
76  installExternalFunctionGlobal(
77  const XalanDOMString& theNamespace,
78  const XalanDOMString& functionName,
79  const Function& function);
80 
81  /**
82  * Uninstall an external function from the global space.
83  *
84  * @param theNamespace The namespace for the functionl
85  * @param functionName The name of the function.
86  */
87  static void
88  uninstallExternalFunctionGlobal(
89  const XalanDOMString& theNamespace,
90  const XalanDOMString& functionName);
91 
92  // Interfaces to install and uninstall external functions in this instance.
93 
94  /**
95  * Install an external function in the local space.
96  *
97  * @param theNamespace The namespace for the functionl
98  * @param functionName The name of the function.
99  * @param function The function to install.
100  */
101  virtual void
102  installExternalFunctionLocal(
103  const XalanDOMString& theNamespace,
104  const XalanDOMString& functionName,
105  const Function& function);
106 
107  /**
108  * Uninstall an external function from the local space.
109  *
110  * @param theNamespace The namespace for the functionl
111  * @param functionName The name of the function.
112  */
113  virtual void
114  uninstallExternalFunctionLocal(
115  const XalanDOMString& theNamespace,
116  const XalanDOMString& functionName);
117 
118 
119  // These interfaces are inherited from XSLTProcessorEnvSupport...
120 
121  virtual void
122  problem(
123  eSource source,
124  eClassification classification,
125  const XalanDOMString& msg,
126  const Locator* locator,
127  const XalanNode* sourceNode);
128 
129  virtual void
130  problem(
131  eSource source,
132  eClassification classification,
133  const XalanDOMString& msg,
134  const XalanNode* sourceNode);
135 
136  virtual XalanDocument*
137  parseXML(
138  MemoryManager& theManager,
139  const XalanDOMString& urlString,
140  const XalanDOMString& base,
141  ErrorHandler* theErrorHandler = 0);
142 
143  virtual XalanDocument*
144  getSourceDocument(const XalanDOMString& theURI) const;
145 
146  virtual void
148  const XalanDOMString& theURI,
149  XalanDocument* theDocument);
150 
151  virtual const XalanDOMString&
152  findURIFromDoc(const XalanDocument* owner) const;
153 
154  virtual bool
156  const XalanDOMString& theNamespace,
157  const XalanDOMString& elementName) const;
158 
159  virtual bool
161  const XalanDOMString& theNamespace,
162  const XalanDOMString& functionName) const;
163 
164  virtual XObjectPtr
165  extFunction(
166  XPathExecutionContext& executionContext,
167  const XalanDOMString& theNamespace,
168  const XalanDOMString& functionName,
169  XalanNode* context,
170  const XObjectArgVectorType& argVec,
171  const Locator* locator) const;
172 
173  virtual void
174  reset();
175 
176 
177  // These are not implemented...
179 
181  operator=(const XSLTProcessorEnvSupportDefault&);
182 
183  bool
185 
186 
187  // Data members...
188 
190 
192 };
193 
194 
195 
196 XALAN_CPP_NAMESPACE_END
197 
198 
199 
200 #endif // XSLTPROCESSORENVSUPPORTDEFAULT_HEADER_GUARD_1357924680
virtual const XalanDOMString & findURIFromDoc(const XalanDocument *owner) const =0
Given a DOM Document, tell what URI was used to parse it.
virtual void setSourceDocument(const XalanDOMString &theURI, XalanDocument *theDocument)=0
Associate a document with a given URI.
virtual bool elementAvailable(const XalanDOMString &theNamespace, const XalanDOMString &elementName) const =0
Determine if an external element is available.
virtual XObjectPtr extFunction(XPathExecutionContext &executionContext, const XalanDOMString &theNamespace, const XalanDOMString &functionName, XalanNode *context, const XObjectArgVectorType &argVec, const Locator *locator) const =0
Handle an extension function.
virtual XalanDocument * parseXML(MemoryManager &theManager, const XalanDOMString &urlString, const XalanDOMString &base, ErrorHandler *theErrorHandler=0)=0
Provides support for XML parsing service.
virtual void problem(eSource source, eClassification classification, const XalanDOMString &msg, const Locator *locator, const XalanNode *sourceNode)=0
Function that is called when a problem event occurs.
Class to hold XObjectPtr return types.
Definition: XObject.hpp:883
virtual bool functionAvailable(const XalanDOMString &theNamespace, const XalanDOMString &functionName) const =0
Determine if a function is available.
void setProcessor(XSLTProcessor *theProcessor)
Reset the XLST processor instance.
virtual XalanDocument * getSourceDocument(const XalanDOMString &theURI) const =0
Get the source document for the given URI.
virtual void reset()=0
Reset the instance.
#define XALAN_XSLT_EXPORT
bool operator==(const ElemAttributeSet &theLHS, const ElemAttributeSet &theRHS)
This is an interface for an XSLT Processor engine.

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.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo