Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

XalanCAPI.h
Go to the documentation of this file.
1 /*
2  * Copyright 1999-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #if !defined(XALAN_CAPI_HEADER_GUARD_1357924680)
17 #define XALAN_CAPI_HEADER_GUARD_1357924680
18 
19 
20 
22 
23 
24 
35 #if defined(__cplusplus)
36 extern "C"
37 {
38 #endif
39 
43  typedef void* XalanHandle;
44 
48  typedef const void* XalanCSSHandle;
49 
53  typedef const void* XalanPSHandle;
54 
59  typedef const char* XalanCCharPtr;
60 
64  typedef unsigned short XalanUTF16Char;
65 
75 #if defined(__cplusplus)
77 #else
78  XalanInitialize(void);
79 #endif
80 
103  XalanTerminate(int fCleanUpICU);
104 
112 
113 
120  DeleteXalanTransformer(XalanHandle theXalanHandle);
121 
135  const char* theXMLFileName,
136  const char* theXSLFileName,
137  const char* theOutFileName,
138  XalanHandle theXalanHandle);
139 
153  XalanPSHandle theParsedSource,
154  XalanCSSHandle theCSSHandle,
155  const char* theOutFileName,
156  XalanHandle theXalanHandle);
157 
173  const char* theXMLFileName,
174  const char* theXSLFileName,
175  char** theOutput,
176  XalanHandle theXalanHandle);
177 
193  XalanPSHandle theParsedSource,
194  XalanCSSHandle theCSSHandle,
195  char** theOutput,
196  XalanHandle theXalanHandle);
197 
205  XalanFreeData(char* theData);
206 
229  const char* theXMLFileName,
230  const char* theXSLFileName,
231  XalanHandle theXalanHandle,
232  void* theOutputHandle,
233  XalanOutputHandlerType theOutputHandler,
234  XalanFlushHandlerType theFlushHandler);
235 
258  XalanPSHandle thePSHandle,
259  XalanCSSHandle theCSSHandle,
260  XalanHandle theXalanHandle,
261  void* theOutputHandle,
262  XalanOutputHandlerType theOutputHandler,
263  XalanFlushHandlerType theFlushHandler);
264 
275  const char* theXSLFileName,
276  XalanHandle theXalanHandle,
277  XalanCSSHandle* theCSSHandle);
278 
290  const char* theXSLStream,
291  unsigned long theXSLStreamLength,
292  XalanHandle theXalanHandle,
293  XalanCSSHandle* theCSSHandle);
294 
304  XalanCSSHandle theCSSHandle,
305  XalanHandle theXalanHandle);
306 
317  const char* theXMLFileName,
318  XalanHandle theXalanHandle,
319  XalanPSHandle* thePSHandle);
320 
332  const char* theXMLStream,
333  unsigned long theXMLStreamLength,
334  XalanHandle theXalanHandle,
335  XalanPSHandle* thePSHandle);
336 
347  XalanPSHandle thePSHandle,
348  XalanHandle theXalanHandle);
349 
360  const char* key,
361  const char* expression,
362  XalanHandle theXalanHandle);
363 
375  const XalanUTF16Char* key,
376  const XalanUTF16Char* expression,
377  XalanHandle theXalanHandle);
378 
389  XALAN_TRANSFORMER_EXPORT_FUNCTION(XalanCCharPtr)
390  XalanGetLastError(XalanHandle theXalanHandle);
391 
392 #if defined(__cplusplus)
393 }
394 #endif
395 
396 
397 
398 #endif // XALAN_CAPI_HEADER_GUARD_1357924680
XalanParseSource(const char *theXMLFileName, XalanHandle theXalanHandle, XalanPSHandle *thePSHandle)
Parse source document.
XalanTransformToHandler(const char *theXMLFileName, const char *theXSLFileName, XalanHandle theXalanHandle, void *theOutputHandle, XalanOutputHandlerType theOutputHandler, XalanFlushHandlerType theFlushHandler)
Transform the XML source tree to a callback function.
XalanTransformToDataPrebuilt(XalanPSHandle theParsedSource, XalanCSSHandle theCSSHandle, char **theOutput, XalanHandle theXalanHandle)
Transform the XML source tree to a dynamically allocated buffer.
XalanGetLastError(XalanHandle theXalanHandle)
Returns the last error that occurred as a result of calling transform.
XalanTransformToFilePrebuilt(XalanPSHandle theParsedSource, XalanCSSHandle theCSSHandle, const char *theOutFileName, XalanHandle theXalanHandle)
Transform the XML source tree to the given result file.
XalanTransformToHandlerPrebuilt(XalanPSHandle thePSHandle, XalanCSSHandle theCSSHandle, XalanHandle theXalanHandle, void *theOutputHandle, XalanOutputHandlerType theOutputHandler, XalanFlushHandlerType theFlushHandler)
Transform the XML source tree to a callback function.
const void * XalanCSSHandle
Handle used to store the address of Compiled Stylesheet instance.
Definition: XalanCAPI.h:48
XalanTransformToData(const char *theXMLFileName, const char *theXSLFileName, char **theOutput, XalanHandle theXalanHandle)
Transform the XML source tree to a dynamically allocated buffer.
XalanTransformToFile(const char *theXMLFileName, const char *theXSLFileName, const char *theOutFileName, XalanHandle theXalanHandle)
Transform the XML source tree to the given result file.
#define XALAN_TRANSFORMER_EXPORT_FUNCTION(T)
Definition: XalanTransformerDefinitions.hpp:39
CreateXalanTransformer()
Create a XalanTransformer instance.
unsigned short XalanUTF16Char
This is a typedef for characters encoded in UTF-16.
Definition: XalanCAPI.h:64
XalanDestroyCompiledStylesheet(XalanCSSHandle theCSSHandle, XalanHandle theXalanHandle)
Destroys a compiled stylesheet.
XalanInitialize(void)
Initialize Xerces and Xalan.
DeleteXalanTransformer(XalanHandle theXalanHandle)
Delete a XalanTransformer instance.
XalanFreeData(char *theData)
Free memory allocated as a result of calling XalanTransformToData.
CallbackSizeType(* XalanOutputHandlerType)(const char *, CallbackSizeType, void *)
Callback function passed to the XalanTransformer APIs.
Definition: XalanTransformerDefinitions.hpp:68
XalanCompileStylesheet(const char *theXSLFileName, XalanHandle theXalanHandle, XalanCSSHandle *theCSSHandle)
Creates a compiled stylesheet.
XalanDestroyParsedSource(XalanPSHandle thePSHandle, XalanHandle theXalanHandle)
Destroys a parsed source.
void * XalanHandle
This is a simple C interface for the class XalanTransformer.
Definition: XalanCAPI.h:43
XalanSetStylesheetParamUTF(const XalanUTF16Char *key, const XalanUTF16Char *expression, XalanHandle theXalanHandle)
Set a top-level stylesheet parameter.
XalanCompileStylesheetFromStream(const char *theXSLStream, unsigned long theXSLStreamLength, XalanHandle theXalanHandle, XalanCSSHandle *theCSSHandle)
Creates a compiled stylesheet.
const void * XalanPSHandle
Handle used to store the address of Parsed Source instance.
Definition: XalanCAPI.h:53
XalanSetStylesheetParam(const char *key, const char *expression, XalanHandle theXalanHandle)
Set a top-level stylesheet parameter.
XalanTerminate(int fCleanUpICU)
Terminate Xalan and Xerces.
void(* XalanFlushHandlerType)(void *)
Callback function passed to the XalanTransformer APIs.
Definition: XalanTransformerDefinitions.hpp:78
XalanParseSourceFromStream(const char *theXMLStream, unsigned long theXMLStreamLength, XalanHandle theXalanHandle, XalanPSHandle *thePSHandle)
Parse source document from a stream.
const char * XalanCCharPtr
This is a typedef to work around limitations with the XALAN_TRANSFORMER_EXPORT_FUNCTION macro...
Definition: XalanCAPI.h:59

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

dot

Xalan-C++ XSLT Processor Version 1.10
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.

Apache Logo