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

XalanCAPI.h

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(XALAN_CAPI_HEADER_GUARD_1357924680)
00017 #define XALAN_CAPI_HEADER_GUARD_1357924680
00018 
00019 
00020 
00021 #include <xalanc/XalanTransformer/XalanTransformerDefinitions.hpp>
00022 
00023 
00024 
00035 #if defined(__cplusplus)
00036 extern "C"
00037 {
00038 #endif
00039 
00043     typedef void*           XalanHandle;
00044 
00048     typedef const void*     XalanCSSHandle;
00049 
00053     typedef const void*     XalanPSHandle;
00054 
00059     typedef const char*     XalanCCharPtr;
00060 
00064     typedef unsigned short  XalanUTF16Char;
00065 
00074     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
00075 #if defined(__cplusplus)
00076     XalanInitialize();
00077 #else
00078     XalanInitialize(void);
00079 #endif
00080 
00102     XALAN_TRANSFORMER_EXPORT_FUNCTION(void)
00103     XalanTerminate(int  fCleanUpICU);
00104 
00110     XALAN_TRANSFORMER_EXPORT_FUNCTION(XalanHandle)
00111 #if defined(__cplusplus)
00112     CreateXalanTransformer();
00113 #else
00114     CreateXalanTransformer(void);
00115 #endif
00116 
00122     XALAN_TRANSFORMER_EXPORT_FUNCTION(void)
00123     DeleteXalanTransformer(XalanHandle  theXalanHandle);
00124 
00136     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
00137     XalanTransformToFile(
00138                 const char*     theXMLFileName, 
00139                 const char*     theXSLFileName,
00140                 const char*     theOutFileName,
00141                 XalanHandle     theXalanHandle);
00142 
00154     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
00155     XalanTransformToFilePrebuilt(
00156             XalanPSHandle   theParsedSource, 
00157             XalanCSSHandle  theCSSHandle,
00158             const char*     theOutFileName,
00159             XalanHandle     theXalanHandle);
00160 
00174     XALAN_TRANSFORMER_EXPORT_FUNCTION(int) 
00175     XalanTransformToData(
00176             const char*     theXMLFileName, 
00177             const char*     theXSLFileName,
00178             char**          theOutput,
00179             XalanHandle     theXalanHandle);
00180 
00194     XALAN_TRANSFORMER_EXPORT_FUNCTION(int) 
00195     XalanTransformToDataPrebuilt(
00196                 XalanPSHandle   theParsedSource,
00197                 XalanCSSHandle  theCSSHandle,
00198                 char**          theOutput,
00199                 XalanHandle     theXalanHandle);
00200 
00207     XALAN_TRANSFORMER_EXPORT_FUNCTION(void)
00208     XalanFreeData(char*     theData);
00209 
00230     XALAN_TRANSFORMER_EXPORT_FUNCTION(int) 
00231     XalanTransformToHandler(
00232                 const char*             theXMLFileName, 
00233                 const char*             theXSLFileName,
00234                 XalanHandle             theXalanHandle,
00235                 void*                   theOutputHandle, 
00236                 XalanOutputHandlerType  theOutputHandler,
00237                 XalanFlushHandlerType   theFlushHandler);
00238 
00259     XALAN_TRANSFORMER_EXPORT_FUNCTION(int) 
00260     XalanTransformToHandlerPrebuilt(
00261                 XalanPSHandle           thePSHandle,
00262                 XalanCSSHandle          theCSSHandle,
00263                 XalanHandle             theXalanHandle,
00264                 void*                   theOutputHandle,
00265                 XalanOutputHandlerType  theOutputHandler,
00266                 XalanFlushHandlerType   theFlushHandler);
00267 
00276     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
00277     XalanCompileStylesheet(
00278             const char*         theXSLFileName,
00279             XalanHandle         theXalanHandle,
00280             XalanCSSHandle*     theCSSHandle);
00281 
00291     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
00292     XalanCompileStylesheetFromStream(
00293             const char*         theXSLStream,
00294             unsigned long       theXSLStreamLength,
00295             XalanHandle         theXalanHandle,
00296             XalanCSSHandle*     theCSSHandle);
00297 
00305     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
00306     XalanDestroyCompiledStylesheet(
00307             XalanCSSHandle  theCSSHandle,
00308             XalanHandle     theXalanHandle);
00309 
00318     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
00319     XalanParseSource(
00320             const char*     theXMLFileName,
00321             XalanHandle     theXalanHandle,
00322             XalanPSHandle*  thePSHandle);
00323 
00333     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
00334     XalanParseSourceFromStream(
00335             const char*     theXMLStream,
00336             unsigned long   theXMLStreamLength,
00337             XalanHandle     theXalanHandle,
00338             XalanPSHandle*  thePSHandle);
00339 
00348     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
00349     XalanDestroyParsedSource(
00350             XalanPSHandle   thePSHandle,
00351             XalanHandle     theXalanHandle);
00352 
00361     XALAN_TRANSFORMER_EXPORT_FUNCTION(void)
00362     XalanSetStylesheetParam(
00363                 const char*     key,
00364                 const char*     expression,
00365                 XalanHandle     theXalanHandle);
00366 
00376     XALAN_TRANSFORMER_EXPORT_FUNCTION(void)
00377     XalanSetStylesheetParamUTF(
00378                 const XalanUTF16Char*   key,
00379                 const XalanUTF16Char*   expression,
00380                 XalanHandle             theXalanHandle);
00381 
00392     XALAN_TRANSFORMER_EXPORT_FUNCTION(XalanCCharPtr)
00393     XalanGetLastError(XalanHandle   theXalanHandle);
00394 
00395 #if defined(__cplusplus)
00396 }
00397 #endif
00398 
00399 
00400 
00401 #endif  // XALAN_CAPI_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.