blob: 0aaa7fbeb574008ce5dedde9eed57ec325acfd71 [file] [log] [blame]
Daniel Veillard253aa2c2002-02-02 09:17:16 +00001 Generated Classes for libxml2-python
2
3#
4# Global functions of the module
5#
6
7
8# functions from module HTMLparser
9htmlHandleOmittedElem()
10htmlIsScriptAttribute()
11htmlParseDoc()
12htmlParseFile()
13
14# functions from module HTMLtree
15htmlNewDoc()
16htmlNewDocNoDtD()
17
18# functions from module catalog
19catalogAdd()
20catalogCleanup()
21catalogConvert()
Daniel Veillard7db38712002-02-07 16:39:11 +000022catalogDump()
Daniel Veillard253aa2c2002-02-02 09:17:16 +000023catalogGetPublic()
24catalogGetSystem()
25catalogRemove()
26catalogResolve()
27catalogResolvePublic()
28catalogResolveSystem()
29catalogResolveURI()
30catalogSetDebug()
31initializeCatalog()
Daniel Veillard7db38712002-02-07 16:39:11 +000032loadACatalog()
Daniel Veillard253aa2c2002-02-02 09:17:16 +000033loadCatalog()
34loadCatalogs()
Daniel Veillard7db38712002-02-07 16:39:11 +000035loadSGMLSuperCatalog()
36newCatalog()
Daniel Veillard253aa2c2002-02-02 09:17:16 +000037parseCatalogFile()
38
39# functions from module debugXML
Daniel Veillard7db38712002-02-07 16:39:11 +000040debugDumpString()
Daniel Veillard253aa2c2002-02-02 09:17:16 +000041shellPrintXPathError()
42
43# functions from module encoding
44UTF8Strlen()
45UTF8Strloc()
46UTF8Strndup()
47UTF8Strpos()
48UTF8Strsize()
49UTF8Strsub()
50addEncodingAlias()
51checkUTF8()
52cleanupCharEncodingHandlers()
53cleanupEncodingAliases()
54delEncodingAlias()
55encodingAlias()
56initCharEncodingHandlers()
57
58# functions from module entities
59cleanupPredefinedEntities()
60initializePredefinedEntities()
61predefinedEntity()
62
63# functions from module nanoftp
64nanoFTPCleanup()
65nanoFTPInit()
66nanoFTPProxy()
67nanoFTPScanProxy()
68
69# functions from module nanohttp
70nanoHTTPCleanup()
71nanoHTTPInit()
72nanoHTTPScanProxy()
73
74# functions from module parser
75cleanupParser()
Daniel Veillard3ce52572002-02-03 15:08:05 +000076createDocParserCtxt()
Daniel Veillard253aa2c2002-02-02 09:17:16 +000077initParser()
78keepBlanksDefault()
79lineNumbersDefault()
80parseDTD()
81parseDoc()
82parseEntity()
83parseFile()
84parseMemory()
85pedanticParserDefault()
86recoverDoc()
87recoverFile()
88recoverMemory()
89substituteEntitiesDefault()
90
91# functions from module parserInternals
92checkLanguageID()
93copyChar()
94copyCharMultiByte()
Daniel Veillard3ce52572002-02-03 15:08:05 +000095createEntityParserCtxt()
96createFileParserCtxt()
97createMemoryParserCtxt()
98htmlCreateFileParserCtxt()
Daniel Veillard253aa2c2002-02-02 09:17:16 +000099htmlInitAutoClose()
100isBaseChar()
101isBlank()
102isChar()
103isCombining()
104isDigit()
105isExtender()
106isIdeographic()
107isLetter()
108isPubidChar()
Daniel Veillard3ce52572002-02-03 15:08:05 +0000109namePop()
110namePush()
111newParserCtxt()
112nodePop()
113nodePush()
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000114
Daniel Veillard5d819032002-02-02 21:49:17 +0000115# functions from module python
Daniel Veillard8d24cc12002-03-05 15:41:29 +0000116SAXParseFile()
Daniel Veillardc6d4a932002-09-12 15:00:57 +0000117createInputBuffer()
118createOutputBuffer()
Daniel Veillard3ce52572002-02-03 15:08:05 +0000119createPushParser()
Daniel Veillard4e1b26c2002-02-03 20:13:06 +0000120debugMemory()
121dumpMemory()
122htmlCreatePushParser()
Daniel Veillard8d24cc12002-03-05 15:41:29 +0000123htmlSAXParseFile()
Daniel Veillarda94ec6f2002-03-01 13:00:53 +0000124newNode()
Daniel Veillard5d819032002-02-02 21:49:17 +0000125registerErrorHandler()
Daniel Veillardc6d4a932002-09-12 15:00:57 +0000126setEntityLoader()
Daniel Veillard5d819032002-02-02 21:49:17 +0000127
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000128# functions from module tree
129compressMode()
130newComment()
131newDoc()
132newPI()
133newText()
134newTextLen()
135setCompressMode()
136
137# functions from module uri
138URIEscape()
139URIEscapeStr()
140URIUnescapeString()
141buildURI()
Daniel Veillard6361da02002-02-23 10:10:33 +0000142createURI()
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000143normalizeURIPath()
Daniel Veillard6361da02002-02-23 10:10:33 +0000144parseURI()
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000145
Daniel Veillarda7084cd2002-04-15 17:12:47 +0000146# functions from module valid
147validateNameValue()
148validateNamesValue()
149validateNmtokenValue()
150validateNmtokensValue()
151
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000152# functions from module xmlIO
153cleanupInputCallbacks()
154cleanupOutputCallbacks()
Daniel Veillardd5e22ef2002-05-27 21:17:57 +0000155fileMatch()
156iOFTPMatch()
157iOHTTPMatch()
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000158parserGetDirectory()
159registerDefaultInputCallbacks()
160registerDefaultOutputCallbacks()
161registerHTTPPostCallbacks()
162
163# functions from module xmlversion
164checkVersion()
165
Daniel Veillard7db38712002-02-07 16:39:11 +0000166# functions from module xpathInternals
167valuePop()
168
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000169
170#
171# Set of classes of the module
172#
173
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000174
175
176Class xmlNode(xmlCore)
Daniel Veillard36eea2d2002-02-04 00:17:01 +0000177 # accessors
178 ns()
179 nsDefs()
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000180
181 # functions from module debugXML
Daniel Veillard7db38712002-02-07 16:39:11 +0000182 debugDumpNode()
183 debugDumpNodeList()
184 debugDumpOneNode()
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000185 lsCountNode()
Daniel Veillard7db38712002-02-07 16:39:11 +0000186 lsOneNode()
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000187 shellPrintNode()
188
189 # functions from module tree
190 addChild()
191 addChildList()
192 addContent()
193 addContentLen()
194 addNextSibling()
195 addPrevSibling()
196 addSibling()
197 copyNode()
198 copyNodeList()
199 copyProp()
200 copyPropList()
201 docCopyNode()
202 docSetRootElement()
203 freeNode()
204 freeNodeList()
205 getBase()
206 getContent()
207 getLang()
208 getSpacePreserve()
209 hasNsProp()
210 hasProp()
211 isBlankNode()
212 isText()
213 lastChild()
214 lineNo()
215 listGetRawString()
216 listGetString()
217 newChild()
218 newNs()
219 newNsProp()
Daniel Veillard539638b2002-07-06 19:55:14 +0000220 newNsPropEatName()
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000221 newProp()
222 newTextChild()
223 nodePath()
224 nsProp()
225 prop()
226 reconciliateNs()
227 replaceNode()
228 searchNs()
229 searchNsByHref()
230 setBase()
231 setContent()
232 setContentLen()
233 setLang()
234 setListDoc()
235 setName()
236 setNs()
237 setNsProp()
238 setProp()
239 setSpacePreserve()
240 setTreeDoc()
241 textConcat()
242 textMerge()
243 unlinkNode()
244 unsetNsProp()
245 unsetProp()
246
247 # functions from module valid
248 isID()
249 isRef()
250 validNormalizeAttributeValue()
251
252 # functions from module xpath
253 xpathCastNodeToNumber()
254 xpathCastNodeToString()
255 xpathCmpNodes()
256
257 # functions from module xpathInternals
258 xpathNewNodeSet()
259 xpathNewValueTree()
Daniel Veillard7db38712002-02-07 16:39:11 +0000260 xpathNextAncestor()
261 xpathNextAncestorOrSelf()
262 xpathNextAttribute()
263 xpathNextChild()
264 xpathNextDescendant()
265 xpathNextDescendantOrSelf()
266 xpathNextFollowing()
267 xpathNextFollowingSibling()
268 xpathNextNamespace()
269 xpathNextParent()
270 xpathNextPreceding()
271 xpathNextPrecedingSibling()
272 xpathNextSelf()
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000273
274
Daniel Veillard9589d452002-02-02 10:28:17 +0000275Class xmlDoc(xmlNode)
276
277 # functions from module HTMLparser
278 htmlAutoCloseTag()
279 htmlIsAutoClosed()
280
281 # functions from module HTMLtree
Daniel Veillardc6d4a932002-09-12 15:00:57 +0000282 htmlDocContentDumpFormatOutput()
283 htmlDocContentDumpOutput()
Daniel Veillard7db38712002-02-07 16:39:11 +0000284 htmlDocDump()
Daniel Veillard9589d452002-02-02 10:28:17 +0000285 htmlGetMetaEncoding()
Daniel Veillard7db38712002-02-07 16:39:11 +0000286 htmlNodeDumpFile()
287 htmlNodeDumpFileFormat()
Daniel Veillardc6d4a932002-09-12 15:00:57 +0000288 htmlNodeDumpFormatOutput()
Daniel Veillard9589d452002-02-02 10:28:17 +0000289 htmlSaveFile()
290 htmlSaveFileEnc()
291 htmlSaveFileFormat()
292 htmlSetMetaEncoding()
293
Daniel Veillard7db38712002-02-07 16:39:11 +0000294 # functions from module debugXML
295 debugDumpDocument()
296 debugDumpDocumentHead()
297 debugDumpEntities()
298
Daniel Veillard9589d452002-02-02 10:28:17 +0000299 # functions from module entities
300 addDocEntity()
301 addDtdEntity()
302 docEntity()
303 dtdEntity()
304 encodeEntities()
305 encodeEntitiesReentrant()
306 encodeSpecialChars()
307 parameterEntity()
308
309 # functions from module tree
310 copyDoc()
311 createIntSubset()
312 docCompressMode()
Daniel Veillard7db38712002-02-07 16:39:11 +0000313 dump()
314 elemDump()
Daniel Veillard539638b2002-07-06 19:55:14 +0000315 formatDump()
Daniel Veillard9589d452002-02-02 10:28:17 +0000316 freeDoc()
317 getRootElement()
318 intSubset()
319 newCDataBlock()
320 newCharRef()
321 newDocComment()
322 newDocFragment()
323 newDocNode()
Daniel Veillard539638b2002-07-06 19:55:14 +0000324 newDocNodeEatName()
Daniel Veillard9589d452002-02-02 10:28:17 +0000325 newDocProp()
326 newDocRawNode()
327 newDocText()
328 newDocTextLen()
329 newDtd()
330 newGlobalNs()
331 newReference()
Daniel Veillardc6d4a932002-09-12 15:00:57 +0000332 nodeDumpOutput()
Daniel Veillard9589d452002-02-02 10:28:17 +0000333 saveFile()
334 saveFileEnc()
Daniel Veillardc6d4a932002-09-12 15:00:57 +0000335 saveFileTo()
Daniel Veillard9589d452002-02-02 10:28:17 +0000336 saveFormatFile()
337 saveFormatFileEnc()
Daniel Veillardc6d4a932002-09-12 15:00:57 +0000338 saveFormatFileTo()
Daniel Veillard9589d452002-02-02 10:28:17 +0000339 setDocCompressMode()
340 stringGetNodeList()
341 stringLenGetNodeList()
342
343 # functions from module valid
344 ID()
345 isMixedElement()
346 removeID()
347 removeRef()
348
349 # functions from module xinclude
350 xincludeProcess()
351
Daniel Veillard5f4b5992002-02-20 10:22:49 +0000352 # functions from module xpath
Daniel Veillard9589d452002-02-02 10:28:17 +0000353 xpathNewContext()
354
355
Daniel Veillard7db38712002-02-07 16:39:11 +0000356Class xmlAttribute(xmlNode)
Daniel Veillard9589d452002-02-02 10:28:17 +0000357
358
359Class xmlNs(xmlNode)
360
361 # functions from module tree
362 copyNamespace()
363 copyNamespaceList()
364 freeNs()
365 freeNsList()
Daniel Veillard539638b2002-07-06 19:55:14 +0000366 newNodeEatName()
367
368 # functions from module xpathInternals
369 xpathNodeSetFreeNs()
Daniel Veillard9589d452002-02-02 10:28:17 +0000370
371
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000372Class xmlDtd(xmlNode)
373
Daniel Veillard7db38712002-02-07 16:39:11 +0000374 # functions from module debugXML
375 debugDumpDTD()
376
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000377 # functions from module tree
378 copyDtd()
379 freeDtd()
380
381 # functions from module valid
382 dtdAttrDesc()
383 dtdElementDesc()
384 dtdQAttrDesc()
385 dtdQElementDesc()
Daniel Veillard7db38712002-02-07 16:39:11 +0000386Class catalog()
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000387
Daniel Veillard7db38712002-02-07 16:39:11 +0000388 # functions from module catalog
389 add()
390 catalogIsEmpty()
391 convertSGMLCatalog()
392 dump()
393 freeCatalog()
394 remove()
395 resolve()
396 resolvePublic()
397 resolveSystem()
398 resolveURI()
399Class xpathParserContext()
Daniel Veillardc575b992002-02-08 13:28:40 +0000400 # accessors
401 context()
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000402
Daniel Veillard7db38712002-02-07 16:39:11 +0000403 # functions from module xpathInternals
404 xpathAddValues()
405 xpathBooleanFunction()
406 xpathCeilingFunction()
407 xpathCompareValues()
408 xpathConcatFunction()
409 xpathContainsFunction()
410 xpathCountFunction()
411 xpathDivValues()
412 xpathEqualValues()
413 xpathEvalExpr()
414 xpathFalseFunction()
415 xpathFloorFunction()
416 xpathFreeParserContext()
417 xpathIdFunction()
418 xpathLangFunction()
419 xpathLastFunction()
420 xpathLocalNameFunction()
421 xpathModValues()
422 xpathMultValues()
423 xpathNamespaceURIFunction()
424 xpathNormalizeFunction()
425 xpathNotFunction()
426 xpathNumberFunction()
427 xpathParseNCName()
428 xpathParseName()
429 xpathPopBoolean()
430 xpathPopNumber()
431 xpathPopString()
432 xpathPositionFunction()
433 xpathRoot()
434 xpathRoundFunction()
435 xpathStartsWithFunction()
436 xpathStringFunction()
437 xpathStringLengthFunction()
438 xpathSubValues()
439 xpathSubstringAfterFunction()
440 xpathSubstringBeforeFunction()
441 xpathSubstringFunction()
442 xpathSumFunction()
443 xpathTranslateFunction()
444 xpathTrueFunction()
445 xpathValueFlipSign()
446 xpatherror()
Daniel Veillard3ce52572002-02-03 15:08:05 +0000447Class parserCtxt()
448 # accessors
449 doc()
Daniel Veillard26f1dcc2002-02-03 16:53:19 +0000450 isValid()
451 lineNumbers()
452 loadSubset()
453 pedantic()
454 replaceEntities()
455 validate()
456 wellFormed()
Daniel Veillard3ce52572002-02-03 15:08:05 +0000457
Daniel Veillard3cd72402002-05-13 10:33:30 +0000458 # functions from module HTMLparser
459 htmlFreeParserCtxt()
460 htmlParseCharRef()
461 htmlParseChunk()
Daniel Veillardd5e22ef2002-05-27 21:17:57 +0000462 htmlParseDocument()
Daniel Veillard3cd72402002-05-13 10:33:30 +0000463 htmlParseElement()
464
Daniel Veillard3ce52572002-02-03 15:08:05 +0000465 # functions from module parser
466 clearParserCtxt()
Daniel Veillard5f4b5992002-02-20 10:22:49 +0000467 freeParserCtxt()
Daniel Veillard3ce52572002-02-03 15:08:05 +0000468 initParserCtxt()
469 parseChunk()
470 parseDocument()
471 parseExtParsedEnt()
472 stopParser()
473
474 # functions from module parserInternals
475 decodeEntities()
Daniel Veillard3ce52572002-02-03 15:08:05 +0000476 namespaceParseNCName()
477 namespaceParseNSDef()
478 nextChar()
479 parseAttValue()
480 parseAttributeListDecl()
481 parseCDSect()
482 parseCharData()
483 parseCharRef()
484 parseComment()
485 parseContent()
486 parseDocTypeDecl()
487 parseElement()
488 parseElementDecl()
489 parseEncName()
490 parseEncodingDecl()
491 parseEndTag()
492 parseEntityDecl()
493 parseEntityRef()
494 parseExternalSubset()
495 parseMarkupDecl()
496 parseMisc()
497 parseName()
498 parseNamespace()
499 parseNmtoken()
500 parseNotationDecl()
501 parsePEReference()
502 parsePI()
503 parsePITarget()
504 parsePubidLiteral()
505 parseQuotedString()
506 parseReference()
507 parseSDDecl()
508 parseStartTag()
509 parseSystemLiteral()
510 parseTextDecl()
511 parseVersionInfo()
512 parseVersionNum()
513 parseXMLDecl()
514 parserHandlePEReference()
515 parserHandleReference()
516 popInput()
517 scanName()
518 skipBlankChars()
519 stringDecodeEntities()
Daniel Veillard7db38712002-02-07 16:39:11 +0000520
521
Daniel Veillardc6d4a932002-09-12 15:00:57 +0000522Class outputBuffer(ioWriteWrapper)
523
524 # functions from module xmlIO
525 close()
526 flush()
527 write()
528 writeString()
529
530
Daniel Veillard7db38712002-02-07 16:39:11 +0000531Class xmlElement(xmlNode)
532
533
534Class xmlEntity(xmlNode)
535
536 # functions from module parserInternals
537 handleEntity()
538
539
540Class xmlAttr(xmlNode)
541
542 # functions from module debugXML
543 debugDumpAttr()
544 debugDumpAttrList()
545
546 # functions from module tree
547 freeProp()
548 freePropList()
549 removeProp()
Daniel Veillard6361da02002-02-23 10:10:33 +0000550Class URI()
551 # accessors
552 authority()
553 fragment()
554 opaque()
555 path()
556 port()
557 query()
558 scheme()
559 server()
560 setAuthority()
561 setFragment()
562 setOpaque()
563 setPath()
564 setPort()
565 setQuery()
566 setScheme()
567 setServer()
568 setUser()
569 user()
570
571 # functions from module uri
572 freeURI()
573 parseURIReference()
574 printURI()
575 saveUri()
Daniel Veillard9589d452002-02-02 10:28:17 +0000576Class xpathContext()
Daniel Veillardc575b992002-02-08 13:28:40 +0000577 # accessors
578 contextDoc()
579 contextNode()
580 contextPosition()
581 contextSize()
582 function()
583 functionURI()
Daniel Veillard8d24cc12002-03-05 15:41:29 +0000584 setContextDoc()
585 setContextNode()
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000586
Daniel Veillard9589d452002-02-02 10:28:17 +0000587 # functions from module python
588 registerXPathFunction()
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000589
Daniel Veillard9589d452002-02-02 10:28:17 +0000590 # functions from module xpath
591 xpathEval()
592 xpathEvalExpression()
Daniel Veillard5f4b5992002-02-20 10:22:49 +0000593 xpathFreeContext()
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000594
Daniel Veillard9589d452002-02-02 10:28:17 +0000595 # functions from module xpathInternals
Daniel Veillard7db38712002-02-07 16:39:11 +0000596 xpathNewParserContext()
Daniel Veillard9589d452002-02-02 10:28:17 +0000597 xpathNsLookup()
598 xpathRegisterAllFunctions()
599 xpathRegisterNs()
600 xpathRegisteredFuncsCleanup()
601 xpathRegisteredNsCleanup()
602 xpathRegisteredVariablesCleanup()
603 xpathVariableLookup()
604 xpathVariableLookupNS()
Daniel Veillardc6d4a932002-09-12 15:00:57 +0000605
606
607Class inputBuffer(ioReadWrapper)
608
609 # functions from module xmlIO
610 freeParserInputBuffer()
611 grow()
612 push()
613 read()