← Back to branch summary

~ubuntu-branches/ubuntu/natty/libxslt/natty-updates

« back to all changes in this revision

Viewing changes to doc/libxslt-api.xml

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2010-01-19 13:15:06 UTC
  • mfrom: (9.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100119131506-cp3debjmuhm12lzi
Tags: 1.1.26-1ubuntu1
Merge with Debian; remaining changes:
Build a python-libxslt1-dbg package.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/libxslt-api.xml
39
39
     <exports symbol='xsltGetExtData' type='function'/>
40
40
     <exports symbol='xsltStyleGetExtData' type='function'/>
41
41
     <exports symbol='xsltStyleExtInitFunction' type='function'/>
42
 
     <exports symbol='xsltExtFunctionLookup' type='function'/>
 
42
     <exports symbol='xsltInitGlobals' type='function'/>
43
43
     <exports symbol='xsltShutdownExts' type='function'/>
44
44
     <exports symbol='xsltExtModuleElementPreComputeLookup' type='function'/>
45
45
     <exports symbol='xsltRegisterTestModule' type='function'/>
239
239
     <exports symbol='xsltChoose' type='function'/>
240
240
     <exports symbol='xsltCopyTextString' type='function'/>
241
241
     <exports symbol='xsltText' type='function'/>
 
242
     <exports symbol='xsltProcessOneNode' type='function'/>
242
243
     <exports symbol='xsltLocalVariablePop' type='function'/>
243
244
     <exports symbol='xsltNumber' type='function'/>
244
245
     <exports symbol='xsltRunStylesheetUser' type='function'/>
299
300
     <author>Daniel Veillard </author>
300
301
     <exports symbol='CHECK_STOPPED0' type='macro'/>
301
302
     <exports symbol='XSLT_PAT_NO_PRIORITY' type='macro'/>
302
 
     <exports symbol='XSLT_ELEMENT_CATEGORY_XSLT' type='macro'/>
303
303
     <exports symbol='XSLT_ITEM_NSINSCOPE_FIELDS' type='macro'/>
304
304
     <exports symbol='XSLT_IS_TEXT_NODE' type='macro'/>
305
 
     <exports symbol='XSLT_VAR_GLOBAL' type='macro'/>
306
305
     <exports symbol='IS_XSLT_ELEM_FAST' type='macro'/>
307
306
     <exports symbol='XSLT_REFACTORED_VARS' type='macro'/>
308
307
     <exports symbol='XSLT_RUNTIME_EXTRA_LST' type='macro'/>
314
313
     <exports symbol='XSLT_GET_INTERNAL_NSMAP' type='macro'/>
315
314
     <exports symbol='XSLT_REFACTORED_KEYCOMP' type='macro'/>
316
315
     <exports symbol='XSLT_REFACTORED_XPATHCOMP' type='macro'/>
317
 
     <exports symbol='XSLT_TCTXT_VARIABLE' type='macro'/>
318
 
     <exports symbol='XSLT_ELEMENT_CATEGORY_LRE' type='macro'/>
319
316
     <exports symbol='XSLT_ITEM_NAVIGATION_FIELDS' type='macro'/>
320
317
     <exports symbol='XSLT_MAX_SORT' type='macro'/>
321
318
     <exports symbol='XSLT_RUNTIME_EXTRA' type='macro'/>
322
319
     <exports symbol='XSLT_IS_RES_TREE_FRAG' type='macro'/>
323
320
     <exports symbol='XML_CAST_FPTR' type='macro'/>
324
 
     <exports symbol='XSLT_ELEMENT_CATEGORY_EXTENSION' type='macro'/>
325
321
     <exports symbol='XSLT_ITEM_COMMON_FIELDS' type='macro'/>
326
322
     <exports symbol='CHECK_STOPPED' type='macro'/>
327
323
     <exports symbol='XSLT_RUNTIME_EXTRA_FREE' type='macro'/>
328
324
     <exports symbol='XSLT_CCTXT' type='macro'/>
329
325
     <exports symbol='CHECK_STOPPEDE' type='macro'/>
330
 
     <exports symbol='XSLT_VAR_IN_SELECT' type='macro'/>
331
326
     <exports symbol='XSLT_ERROR_SEVERITY_ERROR' type='enum'/>
332
327
     <exports symbol='XSLT_FUNC_ELEMENT' type='enum'/>
333
328
     <exports symbol='XSLT_FUNC_VALUEOF' type='enum'/>
575
570
     <exports symbol='_REENTRANT' type='macro'/>
576
571
     <exports symbol='XSLTCALL' type='macro'/>
577
572
    </file>
 
573
    <file name='xsltlocale'>
 
574
     <summary>Locale handling</summary>
 
575
     <description>Interfaces for locale handling. Needed for language dependent sorting. </description>
 
576
     <author>Nick Wellnhofer </author>
 
577
     <exports symbol='XSLT_LOCALE_NONE' type='macro'/>
 
578
     <exports symbol='xsltLocale' type='typedef'/>
 
579
     <exports symbol='xsltLocaleChar' type='typedef'/>
 
580
     <exports symbol='xsltNewLocale' type='function'/>
 
581
     <exports symbol='xsltLocaleStrcmp' type='function'/>
 
582
     <exports symbol='xsltFreeLocale' type='function'/>
 
583
     <exports symbol='xsltStrxfrm' type='function'/>
 
584
    </file>
578
585
    <file name='xsltutils'>
579
586
     <summary>set of utilities for the XSLT engine</summary>
580
587
     <description>interfaces for the utilities module of the XSLT engine. things like message handling, profiling, and other generally useful routines. </description>
718
725
    <macro name='XSLT_DEFAULT_VERSION' file='xslt'>
719
726
      <info>The default version of XSLT supported.</info>
720
727
    </macro>
721
 
    <macro name='XSLT_ELEMENT_CATEGORY_EXTENSION' file='xsltInternals'>
722
 
    </macro>
723
 
    <macro name='XSLT_ELEMENT_CATEGORY_LRE' file='xsltInternals'>
724
 
    </macro>
725
 
    <macro name='XSLT_ELEMENT_CATEGORY_XSLT' file='xsltInternals'>
726
 
    </macro>
727
728
    <macro name='XSLT_FAST_IF' file='xsltInternals'>
728
729
      <info>Internal define to enable usage of xmlXPathCompiledEvalToBoolean() for XSLT &quot;tests&quot;; e.g. in &lt;xsl:if test=&quot;/foo/bar&quot;&gt;</info>
729
730
    </macro>
760
761
    <macro name='XSLT_LIBXSLT_NAMESPACE' file='extra'>
761
762
      <info>This is the libxslt namespace for specific extensions.</info>
762
763
    </macro>
 
764
    <macro name='XSLT_LOCALE_NONE' file='xsltlocale'>
 
765
      <info>Macro indicating that locale are not supported</info>
 
766
    </macro>
763
767
    <macro name='XSLT_MARK_RES_TREE_FRAG' file='xsltInternals'>
764
768
      <info>internal macro to set up tree fragments</info>
765
769
    </macro>
814
818
    <macro name='XSLT_STRANGE' file='xsltutils'>
815
819
      <info>Macro to flag that a problem was detected internally.</info>
816
820
    </macro>
817
 
    <macro name='XSLT_TCTXT_VARIABLE' file='xsltInternals'>
818
 
    </macro>
819
821
    <macro name='XSLT_TIMESTAMP_TICS_PER_SEC' file='xsltutils'>
820
822
      <info>Sampling precision for profiling</info>
821
823
    </macro>
825
827
    <macro name='XSLT_TRACE' file='xsltutils'>
826
828
      <info>Control the type of xsl debugtrace messages emitted.</info>
827
829
    </macro>
828
 
    <macro name='XSLT_VAR_GLOBAL' file='xsltInternals'>
829
 
    </macro>
830
 
    <macro name='XSLT_VAR_IN_SELECT' file='xsltInternals'>
831
 
    </macro>
832
830
    <macro name='XSLT_XALAN_NAMESPACE' file='extra'>
833
831
      <info>This is the Apache project XALAN processor namespace for extensions.</info>
834
832
    </macro>
1056
1054
    </struct>
1057
1055
    <typedef name='xsltKeyTablePtr' file='xsltInternals' type='xsltKeyTable *'/>
1058
1056
    <typedef name='xsltLoadType' file='documents' type='enum'/>
 
1057
    <typedef name='xsltLocale' file='xsltlocale' type='void *'/>
 
1058
    <typedef name='xsltLocaleChar' file='xsltlocale' type='xmlChar'/>
1059
1059
    <struct name='xsltNsAlias' file='xsltInternals' type='struct _xsltNsAlias'>
1060
1060
      <field name='next' type='xsltNsAliasPtr' info=' next in the list'/>
1061
1061
      <field name='literalNs' type='xmlNsPtr' info=''/>
1271
1271
      <field name='descending' type='int' info=' sort'/>
1272
1272
      <field name='lang' type='const xmlChar *' info=' sort'/>
1273
1273
      <field name='has_lang' type='int' info=' sort'/>
 
1274
      <field name='locale' type='xsltLocale' info=' sort'/>
1274
1275
      <field name='case_order' type='const xmlChar *' info=' sort'/>
1275
1276
      <field name='lower_first' type='int' info=' sort'/>
1276
1277
      <field name='use' type='const xmlChar *' info=''/>
1315
1316
      <field name='descending' type='int' info=' sort'/>
1316
1317
      <field name='lang' type='const xmlChar *' info=' sort'/>
1317
1318
      <field name='has_lang' type='int' info=' sort'/>
 
1319
      <field name='locale' type='xsltLocale' info=' sort'/>
1318
1320
      <field name='case_order' type='const xmlChar *' info=' sort'/>
1319
1321
      <field name='lower_first' type='int' info=' sort'/>
1320
1322
      <field name='use' type='const xmlChar *' info=' copy, element'/>
1534
1536
exits'/>
1535
1537
      <field name='localRVTBase' type='xmlDocPtr' info=''/>
1536
1538
      <field name='keyInitLevel' type='int' info=' Needed to catch recursive keys issues'/>
 
1539
      <field name='funcLevel' type='int' info=' Needed to catch recursive functions issues'/>
1537
1540
    </struct>
1538
1541
    <typedef name='xsltTransformContextPtr' file='xsltInternals' type='xsltTransformContext *'/>
1539
1542
    <typedef name='xsltTransformState' file='xsltInternals' type='enum'/>
2013
2016
      <arg name='name' type='const xmlChar *' info='the element name'/>
2014
2017
      <arg name='URI' type='const xmlChar *' info='the element namespace URI'/>
2015
2018
    </function>
2016
 
    <function name='xsltExtFunctionLookup' file='extensions'>
2017
 
      <info></info>
2018
 
      <return type='xmlXPathFunction' info=''/>
2019
 
      <arg name='ctxt' type='xsltTransformContextPtr' info=''/>
2020
 
      <arg name='name' type='const xmlChar *' info=''/>
2021
 
      <arg name='URI' type='const xmlChar *' info=''/>
2022
 
    </function>
2023
2019
    <functype name='xsltExtInitFunction' file='extensions'>
2024
2020
      <info>A function called at initialization time of an XSLT extension module.</info>
2025
2021
      <return type='void *' info='a pointer to the module specific data for this transformation.'/>
2154
2150
      <return type='void'/>
2155
2151
      <arg name='style' type='xsltStylesheetPtr' info='an XSLT stylesheet'/>
2156
2152
    </function>
 
2153
    <function name='xsltFreeLocale' file='xsltlocale'>
 
2154
      <info>Frees a locale created with xsltNewLocale</info>
 
2155
      <return type='void'/>
 
2156
      <arg name='locale' type='xsltLocale' info='the locale to free'/>
 
2157
    </function>
2157
2158
    <function name='xsltFreeNamespaceAliasHashes' file='namespaces'>
2158
2159
      <info>Free up the memory used by namespaces aliases</info>
2159
2160
      <return type='void'/>
2348
2349
    </function>
2349
2350
    <function name='xsltInitAllDocKeys' file='xsltInternals'>
2350
2351
      <info>INTERNAL ROUTINE ONLY  Check if any keys on the current document need to be computed</info>
2351
 
      <return type='int' info=''/>
2352
 
      <arg name='ctxt' type='xsltTransformContextPtr' info=''/>
 
2352
      <return type='int' info='0 in case of success, -1 in case of failure'/>
 
2353
      <arg name='ctxt' type='xsltTransformContextPtr' info='transformation context'/>
2353
2354
    </function>
2354
2355
    <function name='xsltInitCtxtExts' file='extensions'>
2355
2356
      <info>Initialize the set of modules with registered stylesheet data</info>
2378
2379
      <arg name='function' type='xsltTransformFunction' info='the transform function'/>
2379
2380
      <arg name='freeFunc' type='xsltElemPreCompDeallocator' info='the @comp deallocator'/>
2380
2381
    </function>
 
2382
    <function name='xsltInitGlobals' file='extensions'>
 
2383
      <info>Initialize the global variables for extensions</info>
 
2384
      <return type='void'/>
 
2385
    </function>
2381
2386
    <function name='xsltIsBlank' file='xsltInternals'>
2382
2387
      <info>Check if a string is ignorable</info>
2383
2388
      <return type='int' info='1 if the string is NULL or made of blanks chars, 0 otherwise'/>
2420
2425
      <arg name='variable' type='xsltStackElemPtr' info='variable to be pushed to the variable stack'/>
2421
2426
      <arg name='level' type='int' info='new value for variable&apos;s level'/>
2422
2427
    </function>
 
2428
    <function name='xsltLocaleStrcmp' file='xsltlocale'>
 
2429
      <info>Compares two strings transformed with xsltStrxfrm</info>
 
2430
      <return type='int' info='a value &lt; 0 if str1 sorts before str2, a value &gt; 0 if str1 sorts after str2, 0 if str1 and str2 are equal wrt sorting'/>
 
2431
      <arg name='locale' type='xsltLocale' info='a locale identifier'/>
 
2432
      <arg name='str1' type='const xsltLocaleChar *' info='a string transformed with xsltStrxfrm'/>
 
2433
      <arg name='str2' type='const xsltLocaleChar *' info='a string transformed with xsltStrxfrm'/>
 
2434
    </function>
2423
2435
    <function name='xsltMatchPattern' file='pattern'>
2424
2436
      <info></info>
2425
2437
      <return type='int' info=''/>
2460
2472
      <arg name='inst' type='xmlNodePtr' info='the element node'/>
2461
2473
      <arg name='function' type='xsltTransformFunction' info='the transform function'/>
2462
2474
    </function>
 
2475
    <function name='xsltNewLocale' file='xsltlocale'>
 
2476
      <info>Creates a new locale of an opaque system dependent type based on the language tag.</info>
 
2477
      <return type='xsltLocale' info='the locale or NULL on error or if no matching locale was found'/>
 
2478
      <arg name='languageTag' type='const xmlChar *' info='RFC 3066 language tag'/>
 
2479
    </function>
2463
2480
    <function name='xsltNewSecurityPrefs' file='security'>
2464
2481
      <info>Create a new security preference block</info>
2465
2482
      <return type='xsltSecurityPrefsPtr' info='a pointer to the new block or NULL in case of error'/>
2584
2601
      <arg name='cur' type='xmlNodePtr' info='the XSLT &apos;param&apos; element'/>
2585
2602
    </function>
2586
2603
    <function name='xsltParseStylesheetProcess' file='xsltInternals'>
2587
 
      <info></info>
2588
 
      <return type='xsltStylesheetPtr' info=''/>
2589
 
      <arg name='ret' type='xsltStylesheetPtr' info=''/>
2590
 
      <arg name='doc' type='xmlDocPtr' info=''/>
 
2604
      <info>Parses an XSLT stylesheet, adding the associated structures. Called by: xsltParseStylesheetImportedDoc() (xslt.c) xsltParseStylesheetInclude() (imports.c)</info>
 
2605
      <return type='xsltStylesheetPtr' info='the value of the @style parameter if everything went right, NULL if something went amiss.'/>
 
2606
      <arg name='ret' type='xsltStylesheetPtr' info='the XSLT stylesheet (the current stylesheet-level)'/>
 
2607
      <arg name='doc' type='xmlDocPtr' info='and xmlDoc parsed XML'/>
2591
2608
    </function>
2592
2609
    <function name='xsltParseStylesheetVariable' file='variables'>
2593
2610
      <info>Registers a local XSLT &apos;variable&apos; instruction at transformation time and evaluates its value.</info>
2643
2660
      <arg name='style' type='xsltStylesheetPtr' info='the stylesheet'/>
2644
2661
      <arg name='node' type='xmlNodePtr' info='the current node being processed'/>
2645
2662
    </function>
 
2663
    <function name='xsltProcessOneNode' file='transform'>
 
2664
      <info>Process the source node.</info>
 
2665
      <return type='void'/>
 
2666
      <arg name='ctxt' type='xsltTransformContextPtr' info='a XSLT process context'/>
 
2667
      <arg name='contextNode' type='xmlNodePtr' info='the &quot;current node&quot; in the source tree'/>
 
2668
      <arg name='withParams' type='xsltStackElemPtr' info='extra parameters (e.g. xsl:with-param) passed to the template if any'/>
 
2669
    </function>
2646
2670
    <function name='xsltProcessingInstruction' file='transform'>
2647
2671
      <info>Process the xslt processing-instruction node on the source node</info>
2648
2672
      <return type='void'/>
2786
2810
      <arg name='style' type='xsltStylesheetPtr' info='the XSLT stylesheet'/>
2787
2811
    </function>
2788
2812
    <function name='xsltRestoreDocumentNamespaces' file='xsltInternals'>
2789
 
      <info></info>
2790
 
      <return type='int' info=''/>
2791
 
      <arg name='ns' type='xsltNsMapPtr' info=''/>
2792
 
      <arg name='doc' type='xmlDocPtr' info=''/>
 
2813
      <info>Restore the namespaces for the document</info>
 
2814
      <return type='int' info='0 in case of success, -1 in case of failure'/>
 
2815
      <arg name='ns' type='xsltNsMapPtr' info='map of namespaces'/>
 
2816
      <arg name='doc' type='xmlDocPtr' info='the document'/>
2793
2817
    </function>
2794
2818
    <function name='xsltRunStylesheet' file='transform'>
2795
2819
      <info>Apply the stylesheet to the document and generate the output according to @output @SAX and @IObuf. It&apos;s an error to specify both @SAX and @IObuf.  NOTE: This may lead to a non-wellformed output XML wise ! NOTE: This may also result in multiple files being generated NOTE: using IObuf, the result encoding used will be the one used for creating the output buffer, use the following macro to read it from the stylesheet XSLT_GET_IMPORT_PTR(encoding, style, encoding) NOTE: using SAX, any encoding specified in the stylesheet will be lost since the interface uses only UTF8</info>
2984
3008
      <arg name='name' type='const xmlChar *' info='the full QName'/>
2985
3009
      <arg name='prefix' type='const xmlChar **' info='the return value'/>
2986
3010
    </function>
 
3011
    <function name='xsltStrxfrm' file='xsltlocale'>
 
3012
      <info>Transforms a string according to locale. The transformed string must then be compared with xsltLocaleStrcmp and freed with xmlFree.</info>
 
3013
      <return type='xsltLocaleChar *' info='the transformed string or NULL on error'/>
 
3014
      <arg name='locale' type='xsltLocale' info='locale created with xsltNewLocale'/>
 
3015
      <arg name='string' type='const xmlChar *' info='UTF-8 string to transform'/>
 
3016
    </function>
2987
3017
    <functype name='xsltStyleExtInitFunction' file='extensions'>
2988
3018
      <info>A function called at initialization time of an XSLT extension module.</info>
2989
3019
      <return type='void *' info='a pointer to the module specific data for this transformation.'/>