Blame - doc/html/libxml-parser.html - platform/external/libxml2

2003-04-29 12:40:16 +0000

[diff] [blame]

2

.synopsis, .classsynopsis {

3

background: #eeeeee;

4

border: solid 1px #aaaaaa;

padding: 0.5em;

}

.programlisting {

background: #eeeeff;

border: solid 1px #aaaaff;

padding: 0.5em;

}

.variablelist {

padding: 4px;

margin-left: 3em;

}

.navigation {

background: #ffeeee;

border: solid 1px #ffaaaa;

19

margin-top: 0.5em;

20

margin-bottom: 0.5em;

}

.navigation a {

color: #770000;

}

.navigation a:visited {

color: #550000;

}

.navigation .title {

font-size: 200%;

}

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

31

</style><link rel="home" href="index.html" title="[Insert name here] Reference Manual"><link rel="up" href="ch01.html" title="[Insert title here]"><link rel="previous" href="libxml-threads.html" title="threads"><link rel="next" href="libxml-c14n.html" title="c14n"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libxml-threads.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></img></a></td><td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></img></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></img></a></td><th width="100%" align="center">[Insert name here] Reference Manual</th><td><a accesskey="n" href="libxml-c14n.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></img></a></td></tr></table><div class="refentry" lang="en"><a name="libxml-parser"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">parser</span></h2><p>parser — </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

32

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

33

34

35

#define <a href="libxml-parser.html#XML-DEFAULT-VERSION-CAPS">XML_DEFAULT_VERSION</a>

36

void (<a href="libxml-parser.html#xmlParserInputDeallocate">*xmlParserInputDeallocate</a>) (<a href="libxml-tree.html#xmlChar">xmlChar</a> *str);

37

struct <a href="libxml-parser.html#xmlParserInput">xmlParserInput</a>;

38

struct <a href="libxml-parser.html#xmlParserNodeInfo">xmlParserNodeInfo</a>;

39

typedef <a href="libxml-parser.html#xmlParserNodeInfoPtr">xmlParserNodeInfoPtr</a>;

40

struct <a href="libxml-parser.html#xmlParserNodeInfoSeq">xmlParserNodeInfoSeq</a>;

41

typedef <a href="libxml-parser.html#xmlParserNodeInfoSeqPtr">xmlParserNodeInfoSeqPtr</a>;

42

enum <a href="libxml-parser.html#xmlParserInputState">xmlParserInputState</a>;

43

#define <a href="libxml-parser.html#XML-DETECT-IDS-CAPS">XML_DETECT_IDS</a>

44

#define <a href="libxml-parser.html#XML-COMPLETE-ATTRS-CAPS">XML_COMPLETE_ATTRS</a>

45

#define <a href="libxml-parser.html#XML-SKIP-IDS-CAPS">XML_SKIP_IDS</a>

46

struct <a href="libxml-parser.html#xmlParserCtxt">xmlParserCtxt</a>;

47

struct <a href="libxml-parser.html#xmlSAXLocator">xmlSAXLocator</a>;

48

<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> (<a href="libxml-parser.html#resolveEntitySAXFunc">*resolveEntitySAXFunc</a>) (void *ctx,

49

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *publicId,

50

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *systemId);

51

void (<a href="libxml-parser.html#internalSubsetSAXFunc">*internalSubsetSAXFunc</a>) (void *ctx,

52

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,

53

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ExternalID,

54

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *SystemID);

55

void (<a href="libxml-parser.html#externalSubsetSAXFunc">*externalSubsetSAXFunc</a>) (void *ctx,

56

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,

57

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ExternalID,

58

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *SystemID);

59

<a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> (<a href="libxml-parser.html#getEntitySAXFunc">*getEntitySAXFunc</a>) (void *ctx,

60

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);

61

<a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> (<a href="libxml-parser.html#getParameterEntitySAXFunc">*getParameterEntitySAXFunc</a>) (void *ctx,

62

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);

63

void (<a href="libxml-parser.html#entityDeclSAXFunc">*entityDeclSAXFunc</a>) (void *ctx,

64

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,

Daniel Veillard

1999-04-21 20:12:07 +0000

[diff] [blame]

65

int type,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

66

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *publicId,

67

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *systemId,

68

<a href="libxml-tree.html#xmlChar">xmlChar</a> *content);

69

void (<a href="libxml-parser.html#notationDeclSAXFunc">*notationDeclSAXFunc</a>) (void *ctx,

70

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,

71

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *publicId,

72

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *systemId);

73

void (<a href="libxml-parser.html#attributeDeclSAXFunc">*attributeDeclSAXFunc</a>) (void *ctx,

74

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *elem,

75

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *fullname,

Daniel Veillard

1999-04-21 20:12:07 +0000

[diff] [blame]

76

int type,

77

int def,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

78

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *defaultValue,

79

<a href="libxml-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> tree);

80

void (<a href="libxml-parser.html#elementDeclSAXFunc">*elementDeclSAXFunc</a>) (void *ctx,

81

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,

Daniel Veillard

1999-04-21 20:12:07 +0000

[diff] [blame]

82

int type,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

83

<a href="libxml-tree.html#xmlElementContentPtr">xmlElementContentPtr</a> content);

84

void (<a href="libxml-parser.html#unparsedEntityDeclSAXFunc">*unparsedEntityDeclSAXFunc</a>) (void *ctx,

85

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,

86

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *publicId,

87

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *systemId,

88

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *notationName);

89

void (<a href="libxml-parser.html#setDocumentLocatorSAXFunc">*setDocumentLocatorSAXFunc</a>) (void *ctx,

90

<a href="libxml-tree.html#xmlSAXLocatorPtr">xmlSAXLocatorPtr</a> loc);

91

void (<a href="libxml-parser.html#startDocumentSAXFunc">*startDocumentSAXFunc</a>) (void *ctx);

92

void (<a href="libxml-parser.html#endDocumentSAXFunc">*endDocumentSAXFunc</a>) (void *ctx);

93

void (<a href="libxml-parser.html#startElementSAXFunc">*startElementSAXFunc</a>) (void *ctx,

94

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,

95

const <a href="libxml-tree.html#xmlChar">xmlChar</a> **atts);

96

void (<a href="libxml-parser.html#endElementSAXFunc">*endElementSAXFunc</a>) (void *ctx,

97

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);

98

void (<a href="libxml-parser.html#attributeSAXFunc">*attributeSAXFunc</a>) (void *ctx,

99

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,

100

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value);

101

void (<a href="libxml-parser.html#referenceSAXFunc">*referenceSAXFunc</a>) (void *ctx,

102

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);

103

void (<a href="libxml-parser.html#charactersSAXFunc">*charactersSAXFunc</a>) (void *ctx,

104

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ch,

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

105

int len);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

106

void (<a href="libxml-parser.html#ignorableWhitespaceSAXFunc">*ignorableWhitespaceSAXFunc</a>) (void *ctx,

107

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ch,

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

108

int len);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

109

void (<a href="libxml-parser.html#processingInstructionSAXFunc">*processingInstructionSAXFunc</a>) (void *ctx,

110

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *target,

111

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *data);

112

void (<a href="libxml-parser.html#commentSAXFunc">*commentSAXFunc</a>) (void *ctx,

113

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value);

114

void (<a href="libxml-parser.html#cdataBlockSAXFunc">*cdataBlockSAXFunc</a>) (void *ctx,

115

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value,

Daniel Veillard

b05deb7

1999-08-10 19:04:08 +0000

[diff] [blame]

116

int len);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

117

void (<a href="libxml-parser.html#warningSAXFunc">*warningSAXFunc</a>) (void *ctx,

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

118

const char *msg,

119

...);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

120

void (<a href="libxml-parser.html#errorSAXFunc">*errorSAXFunc</a>) (void *ctx,

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

121

const char *msg,

122

...);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

123

void (<a href="libxml-parser.html#fatalErrorSAXFunc">*fatalErrorSAXFunc</a>) (void *ctx,

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

124

const char *msg,

125

...);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

126

int (<a href="libxml-parser.html#isStandaloneSAXFunc">*isStandaloneSAXFunc</a>) (void *ctx);

127

int (<a href="libxml-parser.html#hasInternalSubsetSAXFunc">*hasInternalSubsetSAXFunc</a>) (void *ctx);

128

int (<a href="libxml-parser.html#hasExternalSubsetSAXFunc">*hasExternalSubsetSAXFunc</a>) (void *ctx);

129

struct <a href="libxml-parser.html#xmlSAXHandler">xmlSAXHandler</a>;

130

<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> (<a href="libxml-parser.html#xmlExternalEntityLoader">*xmlExternalEntityLoader</a>)

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

131

(const char *URL,

132

const char *ID,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

133

<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> context);

134

void <a href="libxml-parser.html#xmlInitParser">xmlInitParser</a> (void);

135

void <a href="libxml-parser.html#xmlCleanupParser">xmlCleanupParser</a> (void);

136

int <a href="libxml-parser.html#xmlParserInputRead">xmlParserInputRead</a> (<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> in,

Daniel Veillard

e2d034d

1999-07-27 19:52:06 +0000

[diff] [blame]

137

int len);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

138

int <a href="libxml-parser.html#xmlParserInputGrow">xmlParserInputGrow</a> (<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> in,

Daniel Veillard

e2d034d

1999-07-27 19:52:06 +0000

[diff] [blame]

139

int len);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

140

<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parser.html#xmlStrdup">xmlStrdup</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *cur);

141

<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parser.html#xmlStrndup">xmlStrndup</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

142

int len);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

143

<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parser.html#xmlCharStrndup">xmlCharStrndup</a> (const char *cur,

Daniel Veillard

a41123c

2001-04-22 19:31:20 +0000

[diff] [blame]

144

int len);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

145

<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parser.html#xmlCharStrdup">xmlCharStrdup</a> (const char *cur);

146

<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parser.html#xmlStrsub">xmlStrsub</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str,

Daniel Veillard

1566d3a

1999-07-15 14:24:29 +0000

[diff] [blame]

147

int start,

148

int len);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

149

const <a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parser.html#xmlStrchr">xmlStrchr</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str,

150

<a href="libxml-tree.html#xmlChar">xmlChar</a> val);

151

const <a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parser.html#xmlStrstr">xmlStrstr</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str,

152

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *val);

153

const <a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parser.html#xmlStrcasestr">xmlStrcasestr</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str,

154

<a href="libxml-tree.html#xmlChar">xmlChar</a> *val);

155

int <a href="libxml-parser.html#xmlStrcmp">xmlStrcmp</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str1,

156

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str2);

157

int <a href="libxml-parser.html#xmlStrncmp">xmlStrncmp</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str1,

158

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str2,

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

159

int len);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

160

int <a href="libxml-parser.html#xmlStrcasecmp">xmlStrcasecmp</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str1,

161

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str2);

162

int <a href="libxml-parser.html#xmlStrncasecmp">xmlStrncasecmp</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str1,

163

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str2,

Daniel Veillard

2000-10-01 20:33:47 +0000

[diff] [blame]

164

int len);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

165

int <a href="libxml-parser.html#xmlStrEqual">xmlStrEqual</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str1,

166

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str2);

167

int <a href="libxml-parser.html#xmlStrlen">xmlStrlen</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str);

168

<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parser.html#xmlStrcat">xmlStrcat</a> (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,

169

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *add);

170

<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parser.html#xmlStrncat">xmlStrncat</a> (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,

171

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *add,

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

172

int len);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

173

<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> <a href="libxml-parser.html#xmlParseDoc">xmlParseDoc</a> (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur);

174

<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> <a href="libxml-parser.html#xmlParseMemory">xmlParseMemory</a> (const char *buffer,

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

175

int size);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

176

<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> <a href="libxml-parser.html#xmlParseFile">xmlParseFile</a> (const char *filename);

177

int <a href="libxml-parser.html#xmlSubstituteEntitiesDefault">xmlSubstituteEntitiesDefault</a> (int val);

178

int <a href="libxml-parser.html#xmlKeepBlanksDefault">xmlKeepBlanksDefault</a> (int val);

179

void <a href="libxml-parser.html#xmlStopParser">xmlStopParser</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);

180

int <a href="libxml-parser.html#xmlPedanticParserDefault">xmlPedanticParserDefault</a> (int val);

181

int <a href="libxml-parser.html#xmlLineNumbersDefault">xmlLineNumbersDefault</a> (int val);

182

<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> <a href="libxml-parser.html#xmlRecoverDoc">xmlRecoverDoc</a> (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur);

183

<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> <a href="libxml-parser.html#xmlRecoverMemory">xmlRecoverMemory</a> (const char *buffer,

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

184

int size);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

185

<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> <a href="libxml-parser.html#xmlRecoverFile">xmlRecoverFile</a> (const char *filename);

186

int <a href="libxml-parser.html#xmlParseDocument">xmlParseDocument</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);

187

int <a href="libxml-parser.html#xmlParseExtParsedEnt">xmlParseExtParsedEnt</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);

188

<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> <a href="libxml-parser.html#xmlSAXParseDoc">xmlSAXParseDoc</a> (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

189

<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

190

int recovery);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

191

int <a href="libxml-parser.html#xmlSAXUserParseFile">xmlSAXUserParseFile</a> (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

192

void *user_data,

193

const char *filename);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

194

int <a href="libxml-parser.html#xmlSAXUserParseMemory">xmlSAXUserParseMemory</a> (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

195

void *user_data,

Daniel Veillard

bed7b05

2001-05-19 14:59:49 +0000

[diff] [blame]

196

const char *buffer,

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

197

int size);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

198

<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> <a href="libxml-parser.html#xmlSAXParseMemory">xmlSAXParseMemory</a> (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2001-08-22 23:44:09 +0000

[diff] [blame]

199

const char *buffer,

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

200

int size,

201

int recovery);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

202

<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> <a href="libxml-parser.html#xmlSAXParseMemoryWithData">xmlSAXParseMemoryWithData</a> (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2003-03-23 20:42:17 +0000

[diff] [blame]

const char *buffer,

int size,

int recovery,

void *data);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

207

<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> <a href="libxml-parser.html#xmlSAXParseFile">xmlSAXParseFile</a> (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

208

const char *filename,

209

int recovery);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

210

<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> <a href="libxml-parser.html#xmlSAXParseFileWithData">xmlSAXParseFileWithData</a> (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

60087f3

2001-10-10 09:45:09 +0000

[diff] [blame]

211

const char *filename,

212

int recovery,

213

void *data);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

214

<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> <a href="libxml-parser.html#xmlSAXParseEntity">xmlSAXParseEntity</a> (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2000-10-01 20:33:47 +0000

[diff] [blame]

215

const char *filename);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

216

<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> <a href="libxml-parser.html#xmlParseEntity">xmlParseEntity</a> (const char *filename);

217

<a href="libxml-tree.html#xmlDtdPtr">xmlDtdPtr</a> <a href="libxml-parser.html#xmlParseDTD">xmlParseDTD</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ExternalID,

218

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *SystemID);

219

<a href="libxml-tree.html#xmlDtdPtr">xmlDtdPtr</a> <a href="libxml-parser.html#xmlSAXParseDTD">xmlSAXParseDTD</a> (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

220

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ExternalID,

221

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *SystemID);

222

<a href="libxml-tree.html#xmlDtdPtr">xmlDtdPtr</a> <a href="libxml-parser.html#xmlIOParseDTD">xmlIOParseDTD</a> (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

223

<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> input,

224

<a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);

225

int <a href="libxml-parser.html#xmlParseBalancedChunkMemory">xmlParseBalancedChunkMemory</a> (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc,

226

<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

227

void *user_data,

228

int depth,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

229

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *string,

230

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> *lst);

231

int <a href="libxml-parser.html#xmlParseBalancedChunkMemoryRecover">xmlParseBalancedChunkMemoryRecover</a>

232

(<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc,

233

<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2002-09-26 12:28:02 +0000

[diff] [blame]

234

void *user_data,

235

int depth,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

236

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *string,

237

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> *lst,

Daniel Veillard

2002-09-26 12:28:02 +0000

[diff] [blame]

238

int recover);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

239

int <a href="libxml-parser.html#xmlParseExternalEntity">xmlParseExternalEntity</a> (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc,

240

<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

241

void *user_data,

242

int depth,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

243

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *URL,

244

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ID,

245

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> *lst);

246

int <a href="libxml-parser.html#xmlParseCtxtExternalEntity">xmlParseCtxtExternalEntity</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctx,

247

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *URL,

248

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ID,

249

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> *lst);

250

int <a href="libxml-parser.html#xmlInitParserCtxt">xmlInitParserCtxt</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);

251

void <a href="libxml-parser.html#xmlClearParserCtxt">xmlClearParserCtxt</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);

252

void <a href="libxml-parser.html#xmlFreeParserCtxt">xmlFreeParserCtxt</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);

253

void <a href="libxml-parser.html#xmlSetupParserForBuffer">xmlSetupParserForBuffer</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,

254

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *buffer,

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

255

const char *filename);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

256

<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> <a href="libxml-parser.html#xmlCreateDocParserCtxt">xmlCreateDocParserCtxt</a> (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur);

257

int <a href="libxml-parser.html#xmlGetFeaturesList">xmlGetFeaturesList</a> (int *len,

Daniel Veillard

7c29ce2

2000-08-12 21:20:53 +0000

[diff] [blame]

258

const char **result);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

259

int <a href="libxml-parser.html#xmlGetFeature">xmlGetFeature</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,

Daniel Veillard

7c29ce2

2000-08-12 21:20:53 +0000

[diff] [blame]

260

const char *name,

261

void *result);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

262

int <a href="libxml-parser.html#xmlSetFeature">xmlSetFeature</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,

Daniel Veillard

7c29ce2

2000-08-12 21:20:53 +0000

[diff] [blame]

263

const char *name,

264

void *value);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

265

<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> <a href="libxml-parser.html#xmlCreatePushParserCtxt">xmlCreatePushParserCtxt</a> (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

void *user_data,

const char *chunk,

int size,

const char *filename);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

270

int <a href="libxml-parser.html#xmlParseChunk">xmlParseChunk</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

271

const char *chunk,

272

int size,

273

int terminate);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

274

<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> <a href="libxml-parser.html#xmlCreateIOParserCtxt">xmlCreateIOParserCtxt</a> (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

275

void *user_data,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

276

<a href="libxml-xmlIO.html#xmlInputReadCallback">xmlInputReadCallback</a> ioread,

277

<a href="libxml-xmlIO.html#xmlInputCloseCallback">xmlInputCloseCallback</a> ioclose,

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

278

void *ioctx,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

279

<a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);

280

<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> <a href="libxml-parser.html#xmlNewIOInputStream">xmlNewIOInputStream</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,

281

<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> input,

282

<a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);

283

const <a href="libxml-parser.html#xmlParserNodeInfo">xmlParserNodeInfo</a>* <a href="libxml-parser.html#xmlParserFindNodeInfo">xmlParserFindNodeInfo</a>

284

(const <a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,

285

const <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);

286

void <a href="libxml-parser.html#xmlInitNodeInfoSeq">xmlInitNodeInfoSeq</a> (<a href="libxml-parser.html#xmlParserNodeInfoSeqPtr">xmlParserNodeInfoSeqPtr</a> seq);

287

void <a href="libxml-parser.html#xmlClearNodeInfoSeq">xmlClearNodeInfoSeq</a> (<a href="libxml-parser.html#xmlParserNodeInfoSeqPtr">xmlParserNodeInfoSeqPtr</a> seq);

288

unsigned <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="long">long</GTKDOCLINK> <a href="libxml-parser.html#xmlParserFindNodeInfoIndex">xmlParserFindNodeInfoIndex</a> (const <a href="libxml-parser.html#xmlParserNodeInfoSeqPtr">xmlParserNodeInfoSeqPtr</a> seq,

289

const <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);

290

void <a href="libxml-parser.html#xmlParserAddNodeInfo">xmlParserAddNodeInfo</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,

291

const <a href="libxml-parser.html#xmlParserNodeInfoPtr">xmlParserNodeInfoPtr</a> info);

292

void <a href="libxml-parser.html#xmlSetExternalEntityLoader">xmlSetExternalEntityLoader</a> (<a href="libxml-parser.html#xmlExternalEntityLoader">xmlExternalEntityLoader</a> f);

293

<a href="libxml-parser.html#xmlExternalEntityLoader">xmlExternalEntityLoader</a> <a href="libxml-parser.html#xmlGetExternalEntityLoader">xmlGetExternalEntityLoader</a>

Daniel Veillard

6bd26dc

1999-09-03 14:28:40 +0000

[diff] [blame]

294

(void);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

295

<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> <a href="libxml-parser.html#xmlLoadExternalEntity">xmlLoadExternalEntity</a> (const char *URL,

Daniel Veillard

6bd26dc

1999-09-03 14:28:40 +0000

[diff] [blame]

296

const char *ID,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

297

<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);

298

</pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>

299

Daniel Veillard

2003-08-15 00:33:43 +0000

[diff] [blame]

300

</p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="XML-DEFAULT-VERSION-CAPS"></a>XML_DEFAULT_VERSION</h3><pre class="programlisting">#define XML_DEFAULT_VERSION "1.0"

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

301

</pre><p>

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

302

The default version of XML used: 1.0</p><p>

303

304

</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserInputDeallocate"></a>xmlParserInputDeallocate ()</h3><pre class="programlisting">void (*xmlParserInputDeallocate) (<a href="libxml-tree.html#xmlChar">xmlChar</a> *str);</pre><p>

305

Callback for freeing some parser input allocations.</p><p>

306

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

307

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str</tt></i> :</span></td><td> the string to deallocate

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

308

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserInput"></a>struct xmlParserInput</h3><pre class="programlisting">struct xmlParserInput {

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

309

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

310

/* Input buffer */

311

xmlParserInputBufferPtr buf; /* UTF-8 encoded buffer */

312

313

const char *filename; /* The file analyzed, if any */

Daniel Veillard

60087f3

2001-10-10 09:45:09 +0000

[diff] [blame]

314

const char *directory; /* the directory/base of the file */

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

315

const xmlChar *base; /* Base of the array to parse */

316

const xmlChar *cur; /* Current char being parsed */

Daniel Veillard

2001-12-31 16:16:02 +0000

[diff] [blame]

317

const xmlChar *end; /* end of the array to parse */

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

318

int length; /* length if known */

319

int line; /* Current line */

320

int col; /* Current column */

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

321

/*

322

* NOTE: consumed is only tested for equality in the parser code,

323

* so even if there is an overflow this should not give troubles

324

* for parsing very large instances.

325

*/

326

unsigned long consumed; /* How many xmlChars already consumed */

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

327

xmlParserInputDeallocate free; /* function to deallocate the base */

328

const xmlChar *encoding; /* the encoding string for entity */

329

const xmlChar *version; /* the version string for entity */

330

int standalone; /* Was that entity marked standalone */

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

331

};

332

</pre><p>

333

An xmlParserInput is an input flow for the XML processor.

Daniel Veillard

2001-08-22 23:44:09 +0000

[diff] [blame]

334

Each entity parsed is associated an xmlParserInput (except the

335

few predefined ones). This is the case both for internal entities

336

- in which case the flow is already completely in memory - or

337

external entities - in which case we use the buf structure for

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

338

progressive reading and I18N conversions to the internal UTF-8 format.</p><p>

339

340

</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserNodeInfo"></a>struct xmlParserNodeInfo</h3><pre class="programlisting">struct xmlParserNodeInfo {

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

341

Daniel Veillard

2000-01-05 14:46:17 +0000

[diff] [blame]

342

const struct _xmlNode* node;

Daniel Veillard

3bbbe6f

2001-05-03 11:15:37 +0000

[diff] [blame]

343

/* Position & line # that text that created the node begins & ends on */

Daniel Veillard

2000-01-05 14:46:17 +0000

[diff] [blame]

344

unsigned long begin_pos;

345

unsigned long begin_line;

346

unsigned long end_pos;

347

unsigned long end_line;

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

348

};

349

</pre><p>

350

The parser can be asked to collect Node informations, i.e. at what

Daniel Veillard

2001-08-22 23:44:09 +0000

[diff] [blame]

351

place in the file they were detected.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

352

NOTE: This is off by default and not very well tested.</p><p>

353

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

354

</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserNodeInfoPtr"></a>xmlParserNodeInfoPtr</h3><pre class="programlisting">typedef xmlParserNodeInfo *xmlParserNodeInfoPtr;

355

</pre><p>

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

356

357

</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserNodeInfoSeq"></a>struct xmlParserNodeInfoSeq</h3><pre class="programlisting">struct xmlParserNodeInfoSeq {

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

358

Daniel Veillard

2000-01-05 14:46:17 +0000

[diff] [blame]

359

unsigned long maximum;

360

unsigned long length;

361

xmlParserNodeInfo* buffer;

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

};

</pre><p>

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

365

</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserNodeInfoSeqPtr"></a>xmlParserNodeInfoSeqPtr</h3><pre class="programlisting">typedef xmlParserNodeInfoSeq *xmlParserNodeInfoSeqPtr;

366

</pre><p>

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

367

368

</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserInputState"></a>enum xmlParserInputState</h3><pre class="programlisting">typedef enum {

Daniel Veillard

be849cf

1999-12-28 16:43:59 +0000

[diff] [blame]

369

XML_PARSER_EOF = -1, /* nothing is to be parsed */

370

XML_PARSER_START = 0, /* nothing has been parsed */

371

XML_PARSER_MISC, /* Misc* before int subset */

Daniel Veillard

2001-12-31 16:16:02 +0000

[diff] [blame]

372

XML_PARSER_PI, /* Within a processing instruction */

Daniel Veillard

be849cf

1999-12-28 16:43:59 +0000

[diff] [blame]

373

XML_PARSER_DTD, /* within some DTD content */

374

XML_PARSER_PROLOG, /* Misc* after internal subset */

375

XML_PARSER_COMMENT, /* within a comment */

376

XML_PARSER_START_TAG, /* within a start tag */

377

XML_PARSER_CONTENT, /* within the content */

378

XML_PARSER_CDATA_SECTION, /* within a CDATA section */

379

XML_PARSER_END_TAG, /* within a closing tag */

380

XML_PARSER_ENTITY_DECL, /* within an entity declaration */

381

XML_PARSER_ENTITY_VALUE, /* within an entity value in a decl */

382

XML_PARSER_ATTRIBUTE_VALUE, /* within an attribute value */

Daniel Veillard

edfb29b

2000-03-14 19:59:05 +0000

[diff] [blame]

383

XML_PARSER_SYSTEM_LITERAL, /* within a SYSTEM value */

Daniel Veillard

28929b2

2000-11-13 18:22:49 +0000

[diff] [blame]

384

XML_PARSER_EPILOG, /* the Misc* after the last end tag */

Daniel Veillard

5f4b599

2002-02-20 10:22:49 +0000

[diff] [blame]

385

XML_PARSER_IGNORE, /* within an IGNORED section */

386

XML_PARSER_PUBLIC_LITERAL /* within a PUBLIC value */

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

387

} xmlParserInputState;

388

</pre><p>

389

The parser is now working also as a state based parser.

390

The recursive one use the state info for entities processing.</p><p>

391

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

392

</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="XML-DETECT-IDS-CAPS"></a>XML_DETECT_IDS</h3><pre class="programlisting">#define XML_DETECT_IDS 2

393

</pre><p>

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

394

Bit in the loadsubset context field to tell to do ID/REFs lookups.

395

Use it to initialize xmlLoadExtDtdDefaultValue.</p><p>

396

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

397

</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="XML-COMPLETE-ATTRS-CAPS"></a>XML_COMPLETE_ATTRS</h3><pre class="programlisting">#define XML_COMPLETE_ATTRS 4

398

</pre><p>

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

399

Bit in the loadsubset context field to tell to do complete the

Daniel Veillard

1927409

2002-03-25 16:48:03 +0000

[diff] [blame]

400

elements attributes lists with the ones defaulted from the DTDs.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

401

Use it to initialize xmlLoadExtDtdDefaultValue.</p><p>

402

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

403

</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="XML-SKIP-IDS-CAPS"></a>XML_SKIP_IDS</h3><pre class="programlisting">#define XML_SKIP_IDS 8

404

</pre><p>

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

405

Bit in the loadsubset context field to tell to not do ID/REFs registration.

406

Used to initialize xmlLoadExtDtdDefaultValue in some special cases.</p><p>

407

408

</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserCtxt"></a>struct xmlParserCtxt</h3><pre class="programlisting">struct xmlParserCtxt {

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

409

Daniel Veillard

2000-01-05 14:46:17 +0000

[diff] [blame]

410

struct _xmlSAXHandler *sax; /* The SAX handler */

Daniel Veillard

2000-10-01 20:33:47 +0000

[diff] [blame]

411

void *userData; /* For SAX interface only, used by DOM build */

Daniel Veillard

2000-01-05 14:46:17 +0000

[diff] [blame]

412

xmlDocPtr myDoc; /* the document being built */

413

int wellFormed; /* is the document well formed */

414

int replaceEntities; /* shall we replace entities ? */

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

415

const xmlChar *version; /* the XML version string */

416

const xmlChar *encoding; /* the declared encoding, if any */

Daniel Veillard

2000-01-05 14:46:17 +0000

[diff] [blame]

417

int standalone; /* standalone document */

Daniel Veillard

2000-10-01 20:33:47 +0000

[diff] [blame]

418

int html; /* an HTML(1)/Docbook(2) document */

Daniel Veillard

2000-01-05 14:46:17 +0000

[diff] [blame]

419

420

/* Input stream stack */

421

xmlParserInputPtr input; /* Current input stream */

422

int inputNr; /* Number of current input streams */

423

int inputMax; /* Max number of input streams */

424

xmlParserInputPtr *inputTab; /* stack of inputs */

425

426

/* Node analysis stack only used for DOM building */

427

xmlNodePtr node; /* Current parsed Node */

428

int nodeNr; /* Depth of the parsing stack */

429

int nodeMax; /* Max depth of the parsing stack */

430

xmlNodePtr *nodeTab; /* array of nodes */

431

432

int record_info; /* Whether node info should be kept */

433

xmlParserNodeInfoSeq node_seq; /* info about each node parsed */

434

435

int errNo; /* error code */

436

437

int hasExternalSubset; /* reference and external subset */

438

int hasPErefs; /* the internal subset has PE refs */

439

int external; /* are we parsing an external entity */

440

441

int valid; /* is the document valid */

442

int validate; /* shall we try to validate ? */

443

xmlValidCtxt vctxt; /* The validity context */

444

445

xmlParserInputState instate; /* current type of input */

446

int token; /* next char look-ahead */

447

448

char *directory; /* the data directory */

449

Daniel Veillard

edfb29b

2000-03-14 19:59:05 +0000

[diff] [blame]

450

/* Node name stack */

Daniel Veillard

2000-01-05 14:46:17 +0000

[diff] [blame]

451

xmlChar *name; /* Current parsed Node */

452

int nameNr; /* Depth of the parsing stack */

453

int nameMax; /* Max depth of the parsing stack */

454

xmlChar * *nameTab; /* array of nodes */

455

456

long nbChars; /* number of xmlChar processed */

457

long checkIndex; /* used by progressive parsing lookup */

Daniel Veillard

f686871

2000-01-05 14:58:38 +0000

[diff] [blame]

458

int keepBlanks; /* ugly but ... */

Daniel Veillard

edfb29b

2000-03-14 19:59:05 +0000

[diff] [blame]

459

int disableSAX; /* SAX callbacks are disabled */

460

int inSubset; /* Parsing is in int 1/ext 2 subset */

461

xmlChar * intSubName; /* name of subset */

462

xmlChar * extSubURI; /* URI of external subset */

463

xmlChar * extSubSystem; /* SYSTEM ID of external subset */

464

465

/* xml:space values */

466

int * space; /* Should the parser preserve spaces */

467

int spaceNr; /* Depth of the parsing stack */

468

int spaceMax; /* Max depth of the parsing stack */

469

int * spaceTab; /* array of space infos */

470

471

int depth; /* to prevent entity substitution loops */

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

472

xmlParserInputPtr entity; /* used to check entities boundaries */

473

int charset; /* encoding of the in-memory content

474

actually an xmlCharEncoding */

475

int nodelen; /* Those two fields are there to */

476

int nodemem; /* Speed up large node parsing */

Daniel Veillard

2000-10-01 20:33:47 +0000

[diff] [blame]

477

int pedantic; /* signal pedantic warnings */

478

void *_private; /* For user data, libxml won't touch it */

Daniel Veillard

d194dd2

2001-02-14 10:37:43 +0000

[diff] [blame]

479

480

int loadsubset; /* should the external subset be loaded */

Daniel Veillard

2001-08-22 23:44:09 +0000

[diff] [blame]

481

int linenumbers; /* set line number in element content */

482

void *catalogs; /* document's own catalog */

Daniel Veillard

2003-03-23 20:42:17 +0000

[diff] [blame]

483

int recovery; /* run in recovery mode */

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

484

int progressive; /* is this a progressive parsing */

485

};

486

</pre><p>

487

The parser context.

Daniel Veillard

1927409

2002-03-25 16:48:03 +0000

[diff] [blame]

488

NOTE This doesn't completely define the parser state, the (current ?)

Daniel Veillard

2003-03-23 20:42:17 +0000

[diff] [blame]

489

design of the parser uses recursive function calls since this allow

490

and easy mapping from the production rules of the specification

491

to the actual code. The drawback is that the actual function call

492

also reflect the parser state. However most of the parsing routines

493

takes as the only argument the parser context pointer, so migrating

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

494

to a state based parser for progressive parsing shouldn't be too hard.</p><p>

495

496

</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSAXLocator"></a>struct xmlSAXLocator</h3><pre class="programlisting">struct xmlSAXLocator {

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

497

Daniel Veillard

2000-01-05 14:46:17 +0000

[diff] [blame]

498

const xmlChar *(*getPublicId)(void *ctx);

499

const xmlChar *(*getSystemId)(void *ctx);

500

int (*getLineNumber)(void *ctx);

501

int (*getColumnNumber)(void *ctx);

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

502

};

503

</pre><p>

504

A SAX Locator.</p><p>

505

506

</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="resolveEntitySAXFunc"></a>resolveEntitySAXFunc ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> (*resolveEntitySAXFunc) (void *ctx,

507

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *publicId,

508

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *systemId);</pre><p>

509

Callback:

Daniel Veillard

5f4b599

2002-02-20 10:22:49 +0000

[diff] [blame]

510

The entity loader, to control the loading of external entities,

511

the application can either:

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

512

- override this <a href="libxml-SAX.html#resolveEntity">resolveEntity</a>() callback in the SAX block

513

- or better use the <a href="libxml-parser.html#xmlSetExternalEntityLoader">xmlSetExternalEntityLoader</a>() function to

514

set up it's own entity resolution routine</p><p>

515

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

516

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

517

</td></tr><tr><td><span class="term"><i class="parameter"><tt>publicId</tt></i> :</span></td><td> The public ID of the entity

518

</td></tr><tr><td><span class="term"><i class="parameter"><tt>systemId</tt></i> :</span></td><td> The system ID of the entity

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

519

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlParserInputPtr if inlined or NULL for DOM behaviour.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

520

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="internalSubsetSAXFunc"></a>internalSubsetSAXFunc ()</h3><pre class="programlisting">void (*internalSubsetSAXFunc) (void *ctx,

521

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,

522

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ExternalID,

523

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *SystemID);</pre><p>

524

Callback on internal subset declaration.</p><p>

525

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

526

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

527

</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> the root element name

528

</td></tr><tr><td><span class="term"><i class="parameter"><tt>ExternalID</tt></i> :</span></td><td> the external ID

529

</td></tr><tr><td><span class="term"><i class="parameter"><tt>SystemID</tt></i> :</span></td><td> the SYSTEM ID (e.g. filename or URL)

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

530

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="externalSubsetSAXFunc"></a>externalSubsetSAXFunc ()</h3><pre class="programlisting">void (*externalSubsetSAXFunc) (void *ctx,

531

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,

532

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ExternalID,

533

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *SystemID);</pre><p>

534

Callback on external subset declaration.</p><p>

535

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

536

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

537

</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> the root element name

538

</td></tr><tr><td><span class="term"><i class="parameter"><tt>ExternalID</tt></i> :</span></td><td> the external ID

539

</td></tr><tr><td><span class="term"><i class="parameter"><tt>SystemID</tt></i> :</span></td><td> the SYSTEM ID (e.g. filename or URL)

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

540

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="getEntitySAXFunc"></a>getEntitySAXFunc ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> (*getEntitySAXFunc) (void *ctx,

541

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);</pre><p>

542

Get an entity by name.</p><p>

543

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

544

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

545

</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> The entity name

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

546

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlEntityPtr if found.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

547

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="getParameterEntitySAXFunc"></a>getParameterEntitySAXFunc ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> (*getParameterEntitySAXFunc) (void *ctx,

548

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);</pre><p>

549

Get a parameter entity by name.</p><p>

550

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

551

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

552

</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> The entity name

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

553

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlEntityPtr if found.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

554

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="entityDeclSAXFunc"></a>entityDeclSAXFunc ()</h3><pre class="programlisting">void (*entityDeclSAXFunc) (void *ctx,

555

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,

Daniel Veillard

1999-04-21 20:12:07 +0000

[diff] [blame]

556

int type,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

557

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *publicId,

558

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *systemId,

559

<a href="libxml-tree.html#xmlChar">xmlChar</a> *content);</pre><p>

560

An entity definition has been parsed.</p><p>

561

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

562

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

563

</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> the entity name

564

</td></tr><tr><td><span class="term"><i class="parameter"><tt>type</tt></i> :</span></td><td> the entity type

565

</td></tr><tr><td><span class="term"><i class="parameter"><tt>publicId</tt></i> :</span></td><td> The public ID of the entity

566

</td></tr><tr><td><span class="term"><i class="parameter"><tt>systemId</tt></i> :</span></td><td> The system ID of the entity

567

</td></tr><tr><td><span class="term"><i class="parameter"><tt>content</tt></i> :</span></td><td> the entity value (without processing).

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

568

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="notationDeclSAXFunc"></a>notationDeclSAXFunc ()</h3><pre class="programlisting">void (*notationDeclSAXFunc) (void *ctx,

569

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,

570

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *publicId,

571

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *systemId);</pre><p>

572

What to do when a notation declaration has been parsed.</p><p>

573

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

574

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

575

</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> The name of the notation

576

</td></tr><tr><td><span class="term"><i class="parameter"><tt>publicId</tt></i> :</span></td><td> The public ID of the entity

577

</td></tr><tr><td><span class="term"><i class="parameter"><tt>systemId</tt></i> :</span></td><td> The system ID of the entity

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

578

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="attributeDeclSAXFunc"></a>attributeDeclSAXFunc ()</h3><pre class="programlisting">void (*attributeDeclSAXFunc) (void *ctx,

579

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *elem,

580

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *fullname,

Daniel Veillard

1999-04-21 20:12:07 +0000

[diff] [blame]

581

int type,

582

int def,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

583

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *defaultValue,

584

<a href="libxml-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> tree);</pre><p>

585

An attribute definition has been parsed.</p><p>

586

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

587

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

588

</td></tr><tr><td><span class="term"><i class="parameter"><tt>elem</tt></i> :</span></td><td> the name of the element

589

</td></tr><tr><td><span class="term"><i class="parameter"><tt>fullname</tt></i> :</span></td><td> the attribute name

590

</td></tr><tr><td><span class="term"><i class="parameter"><tt>type</tt></i> :</span></td><td> the attribute type

591

</td></tr><tr><td><span class="term"><i class="parameter"><tt>def</tt></i> :</span></td><td> the type of default value

592

</td></tr><tr><td><span class="term"><i class="parameter"><tt>defaultValue</tt></i> :</span></td><td> the attribute default value

593

</td></tr><tr><td><span class="term"><i class="parameter"><tt>tree</tt></i> :</span></td><td> the tree of enumerated value set

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

594

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="elementDeclSAXFunc"></a>elementDeclSAXFunc ()</h3><pre class="programlisting">void (*elementDeclSAXFunc) (void *ctx,

595

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,

Daniel Veillard

1999-04-21 20:12:07 +0000

[diff] [blame]

596

int type,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

597

<a href="libxml-tree.html#xmlElementContentPtr">xmlElementContentPtr</a> content);</pre><p>

598

An element definition has been parsed.</p><p>

599

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

600

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

601

</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> the element name

602

</td></tr><tr><td><span class="term"><i class="parameter"><tt>type</tt></i> :</span></td><td> the element type

603

</td></tr><tr><td><span class="term"><i class="parameter"><tt>content</tt></i> :</span></td><td> the element value tree

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

604

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="unparsedEntityDeclSAXFunc"></a>unparsedEntityDeclSAXFunc ()</h3><pre class="programlisting">void (*unparsedEntityDeclSAXFunc) (void *ctx,

605

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,

606

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *publicId,

607

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *systemId,

608

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *notationName);</pre><p>

609

What to do when an unparsed entity declaration is parsed.</p><p>

610

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

611

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

612

</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> The name of the entity

613

</td></tr><tr><td><span class="term"><i class="parameter"><tt>publicId</tt></i> :</span></td><td> The public ID of the entity

614

</td></tr><tr><td><span class="term"><i class="parameter"><tt>systemId</tt></i> :</span></td><td> The system ID of the entity

615

</td></tr><tr><td><span class="term"><i class="parameter"><tt>notationName</tt></i> :</span></td><td> the name of the notation

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

616

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="setDocumentLocatorSAXFunc"></a>setDocumentLocatorSAXFunc ()</h3><pre class="programlisting">void (*setDocumentLocatorSAXFunc) (void *ctx,

617

<a href="libxml-tree.html#xmlSAXLocatorPtr">xmlSAXLocatorPtr</a> loc);</pre><p>

618

Receive the document locator at startup, actually xmlDefaultSAXLocator.

619

Everything is available on the context, so this is useless in our case.</p><p>

620

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

621

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

622

</td></tr><tr><td><span class="term"><i class="parameter"><tt>loc</tt></i> :</span></td><td> A SAX Locator

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

623

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="startDocumentSAXFunc"></a>startDocumentSAXFunc ()</h3><pre class="programlisting">void (*startDocumentSAXFunc) (void *ctx);</pre><p>

624

Called when the document start being processed.</p><p>

625

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

626

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

627

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="endDocumentSAXFunc"></a>endDocumentSAXFunc ()</h3><pre class="programlisting">void (*endDocumentSAXFunc) (void *ctx);</pre><p>

628

Called when the document end has been detected.</p><p>

629

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

630

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

631

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="startElementSAXFunc"></a>startElementSAXFunc ()</h3><pre class="programlisting">void (*startElementSAXFunc) (void *ctx,

632

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,

633

const <a href="libxml-tree.html#xmlChar">xmlChar</a> **atts);</pre><p>

634

Called when an opening tag has been processed.</p><p>

635

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

636

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

637

</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> The element name, including namespace prefix

638

</td></tr><tr><td><span class="term"><i class="parameter"><tt>atts</tt></i> :</span></td><td> An array of name/value attributes pairs, NULL terminated

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

639

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="endElementSAXFunc"></a>endElementSAXFunc ()</h3><pre class="programlisting">void (*endElementSAXFunc) (void *ctx,

640

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);</pre><p>

641

Called when the end of an element has been detected.</p><p>

642

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

643

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

644

</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> The element name

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

645

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="attributeSAXFunc"></a>attributeSAXFunc ()</h3><pre class="programlisting">void (*attributeSAXFunc) (void *ctx,

646

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,

647

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value);</pre><p>

648

Handle an attribute that has been read by the parser.

Daniel Veillard

5f4b599

2002-02-20 10:22:49 +0000

[diff] [blame]

649

The default handling is to convert the attribute into an

650

DOM subtree and past it in a new xmlAttr element added to

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

651

the element.</p><p>

652

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

653

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

654

</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> The attribute name, including namespace prefix

655

</td></tr><tr><td><span class="term"><i class="parameter"><tt>value</tt></i> :</span></td><td> The attribute value

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

656

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="referenceSAXFunc"></a>referenceSAXFunc ()</h3><pre class="programlisting">void (*referenceSAXFunc) (void *ctx,

657

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);</pre><p>

658

Called when an entity reference is detected.</p><p>

659

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

660

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

661

</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> The entity name

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

662

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="charactersSAXFunc"></a>charactersSAXFunc ()</h3><pre class="programlisting">void (*charactersSAXFunc) (void *ctx,

663

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ch,

664

int len);</pre><p>

665

Receiving some chars from the parser.</p><p>

666

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

667

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

668

</td></tr><tr><td><span class="term"><i class="parameter"><tt>ch</tt></i> :</span></td><td> a xmlChar string

669

</td></tr><tr><td><span class="term"><i class="parameter"><tt>len</tt></i> :</span></td><td> the number of xmlChar

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

670

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="ignorableWhitespaceSAXFunc"></a>ignorableWhitespaceSAXFunc ()</h3><pre class="programlisting">void (*ignorableWhitespaceSAXFunc) (void *ctx,

671

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ch,

672

int len);</pre><p>

673

Receiving some ignorable whitespaces from the parser.

674

UNUSED: by default the DOM building will use characters.</p><p>

675

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

676

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

677

</td></tr><tr><td><span class="term"><i class="parameter"><tt>ch</tt></i> :</span></td><td> a xmlChar string

678

</td></tr><tr><td><span class="term"><i class="parameter"><tt>len</tt></i> :</span></td><td> the number of xmlChar

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

679

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="processingInstructionSAXFunc"></a>processingInstructionSAXFunc ()</h3><pre class="programlisting">void (*processingInstructionSAXFunc) (void *ctx,

680

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *target,

681

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *data);</pre><p>

682

A processing instruction has been parsed.</p><p>

683

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

684

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

685

</td></tr><tr><td><span class="term"><i class="parameter"><tt>target</tt></i> :</span></td><td> the target name

686

</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td> the PI data's

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

687

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="commentSAXFunc"></a>commentSAXFunc ()</h3><pre class="programlisting">void (*commentSAXFunc) (void *ctx,

688

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value);</pre><p>

689

A comment has been parsed.</p><p>

690

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

691

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

692

</td></tr><tr><td><span class="term"><i class="parameter"><tt>value</tt></i> :</span></td><td> the comment content

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

693

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="cdataBlockSAXFunc"></a>cdataBlockSAXFunc ()</h3><pre class="programlisting">void (*cdataBlockSAXFunc) (void *ctx,

694

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value,

695

int len);</pre><p>

696

Called when a pcdata block has been parsed.</p><p>

697

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

698

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

699

</td></tr><tr><td><span class="term"><i class="parameter"><tt>value</tt></i> :</span></td><td> The pcdata content

700

</td></tr><tr><td><span class="term"><i class="parameter"><tt>len</tt></i> :</span></td><td> the block length

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

701

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="warningSAXFunc"></a>warningSAXFunc ()</h3><pre class="programlisting">void (*warningSAXFunc) (void *ctx,

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

702

const char *msg,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

703

...);</pre><p>

704

Display and format a warning messages, callback.</p><p>

705

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

706

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> an XML parser context

707

</td></tr><tr><td><span class="term"><i class="parameter"><tt>msg</tt></i> :</span></td><td> the message to display/transmit

708

</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td> extra parameters for the message display

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

709

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="errorSAXFunc"></a>errorSAXFunc ()</h3><pre class="programlisting">void (*errorSAXFunc) (void *ctx,

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

710

const char *msg,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

711

...);</pre><p>

712

Display and format an error messages, callback.</p><p>

713

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

714

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> an XML parser context

715

</td></tr><tr><td><span class="term"><i class="parameter"><tt>msg</tt></i> :</span></td><td> the message to display/transmit

716

</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td> extra parameters for the message display

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

717

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="fatalErrorSAXFunc"></a>fatalErrorSAXFunc ()</h3><pre class="programlisting">void (*fatalErrorSAXFunc) (void *ctx,

Daniel Veillard

1999-02-25 08:46:07 +0000

[diff] [blame]

718

const char *msg,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

719

...);</pre><p>

720

Display and format fatal error messages, callback.

721

Note: so far <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="fatalError">fatalError</GTKDOCLINK>() SAX callbacks are not used, <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="error">error</GTKDOCLINK>()

722

get all the callbacks for errors.</p><p>

723

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

724

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> an XML parser context

725

</td></tr><tr><td><span class="term"><i class="parameter"><tt>msg</tt></i> :</span></td><td> the message to display/transmit

726

</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td> extra parameters for the message display

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

727

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="isStandaloneSAXFunc"></a>isStandaloneSAXFunc ()</h3><pre class="programlisting">int (*isStandaloneSAXFunc) (void *ctx);</pre><p>

728

Is this document tagged standalone?</p><p>

729

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

730

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

731

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if true

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

732

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="hasInternalSubsetSAXFunc"></a>hasInternalSubsetSAXFunc ()</h3><pre class="programlisting">int (*hasInternalSubsetSAXFunc) (void *ctx);</pre><p>

733

Does this document has an internal subset.</p><p>

734

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

735

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

736

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if true

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

737

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="hasExternalSubsetSAXFunc"></a>hasExternalSubsetSAXFunc ()</h3><pre class="programlisting">int (*hasExternalSubsetSAXFunc) (void *ctx);</pre><p>

738

Does this document has an external subset?</p><p>

739

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

740

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context)

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

741

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if true

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

742

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSAXHandler"></a>struct xmlSAXHandler</h3><pre class="programlisting">struct xmlSAXHandler {

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

743

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

744

internalSubsetSAXFunc internalSubset;

745

isStandaloneSAXFunc isStandalone;

746

hasInternalSubsetSAXFunc hasInternalSubset;

747

hasExternalSubsetSAXFunc hasExternalSubset;

748

resolveEntitySAXFunc resolveEntity;

749

getEntitySAXFunc getEntity;

750

entityDeclSAXFunc entityDecl;

751

notationDeclSAXFunc notationDecl;

752

attributeDeclSAXFunc attributeDecl;

753

elementDeclSAXFunc elementDecl;

754

unparsedEntityDeclSAXFunc unparsedEntityDecl;

755

setDocumentLocatorSAXFunc setDocumentLocator;

756

startDocumentSAXFunc startDocument;

757

endDocumentSAXFunc endDocument;

758

startElementSAXFunc startElement;

759

endElementSAXFunc endElement;

760

referenceSAXFunc reference;

761

charactersSAXFunc characters;

762

ignorableWhitespaceSAXFunc ignorableWhitespace;

763

processingInstructionSAXFunc processingInstruction;

764

commentSAXFunc comment;

765

warningSAXFunc warning;

766

errorSAXFunc error;

Daniel Veillard

2003-03-23 20:42:17 +0000

[diff] [blame]

767

fatalErrorSAXFunc fatalError; /* unused error() get all the errors */

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

768

getParameterEntitySAXFunc getParameterEntity;

769

cdataBlockSAXFunc cdataBlock;

770

externalSubsetSAXFunc externalSubset;

Daniel Veillard

52dcab3

2001-10-30 12:51:17 +0000

[diff] [blame]

771

int initialized;

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

772

};

773

</pre><p>

774

A SAX handler is bunch of callbacks called by the parser when processing

775

of the input generate data or structure informations.</p><p>

776

777

</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlExternalEntityLoader"></a>xmlExternalEntityLoader ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> (*xmlExternalEntityLoader)

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

778

(const char *URL,

779

const char *ID,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

780

<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> context);</pre><p>

781

External entity loaders types.</p><p>

782

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

783

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>URL</tt></i> :</span></td><td> The System ID of the resource requested

784

</td></tr><tr><td><span class="term"><i class="parameter"><tt>ID</tt></i> :</span></td><td> The Public ID of the resource requested

785

</td></tr><tr><td><span class="term"><i class="parameter"><tt>context</tt></i> :</span></td><td> the XML parser context

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

786

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the entity input parser.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

787

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlInitParser"></a>xmlInitParser ()</h3><pre class="programlisting">void xmlInitParser (void);</pre><p>

788

Initialization function for the XML parser.

Daniel Veillard

2000-10-01 20:33:47 +0000

[diff] [blame]

789

This is not reentrant. Call once before processing in case of

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

790

use in multithreaded programs.</p><p>

791

792

</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCleanupParser"></a>xmlCleanupParser ()</h3><pre class="programlisting">void xmlCleanupParser (void);</pre><p>

793

Cleanup function for the XML parser. It tries to reclaim all

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

794

parsing related global memory allocated for the parser processing.

795

It doesn't deallocate any document related memory. Calling this

Daniel Veillard

2003-03-23 20:42:17 +0000

[diff] [blame]

796

function should not prevent reusing the parser.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

797

One should call <a href="libxml-parser.html#xmlCleanupParser">xmlCleanupParser</a>() only when the process has

798

finished using the library or XML document built with it.</p><p>

799

800

</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserInputRead"></a>xmlParserInputRead ()</h3><pre class="programlisting">int xmlParserInputRead (<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> in,

801

int len);</pre><p>

802

This function refresh the input for the parser. It doesn't try to

803

preserve pointers to the input buffer, and discard already read data</p><p>

804

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

805

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>in</tt></i> :</span></td><td> an XML parser input

806

</td></tr><tr><td><span class="term"><i class="parameter"><tt>len</tt></i> :</span></td><td> an indicative size for the lookahead

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

807

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of xmlChars read, or -1 in case of error, 0 indicate the

808

end of this entity

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

809

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserInputGrow"></a>xmlParserInputGrow ()</h3><pre class="programlisting">int xmlParserInputGrow (<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> in,

810

int len);</pre><p>

811

This function increase the input for the parser. It tries to

812

preserve pointers to the input buffer, and keep already read data</p><p>

813

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

814

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>in</tt></i> :</span></td><td> an XML parser input

815

</td></tr><tr><td><span class="term"><i class="parameter"><tt>len</tt></i> :</span></td><td> an indicative size for the lookahead

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

816

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of xmlChars read, or -1 in case of error, 0 indicate the

817

end of this entity

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

818

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlStrdup"></a>xmlStrdup ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlStrdup (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *cur);</pre><p>

819

a strdup for array of xmlChar's. Since they are supposed to be

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

820

encoded in UTF-8 or an encoding with 8bit based chars, we assume

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

821

a termination mark of '0'.</p><p>

822

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

823

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cur</tt></i> :</span></td><td> the input xmlChar *

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

824

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a new xmlChar * or NULL

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

825

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlStrndup"></a>xmlStrndup ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlStrndup (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,

826

int len);</pre><p>

827

a strndup for array of xmlChar's</p><p>

828

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

829

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cur</tt></i> :</span></td><td> the input xmlChar *

830

</td></tr><tr><td><span class="term"><i class="parameter"><tt>len</tt></i> :</span></td><td> the len of <i class="parameter"><tt>cur</tt></i>

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

831

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a new xmlChar * or NULL

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

832

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCharStrndup"></a>xmlCharStrndup ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlCharStrndup (const char *cur,

833

int len);</pre><p>

834

a strndup for char's to xmlChar's</p><p>

835

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

836

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cur</tt></i> :</span></td><td> the input char *

837

</td></tr><tr><td><span class="term"><i class="parameter"><tt>len</tt></i> :</span></td><td> the len of <i class="parameter"><tt>cur</tt></i>

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

838

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a new xmlChar * or NULL

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

839

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCharStrdup"></a>xmlCharStrdup ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlCharStrdup (const char *cur);</pre><p>

840

a strdup for char's to xmlChar's</p><p>

841

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

842

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cur</tt></i> :</span></td><td> the input char *

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

843

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a new xmlChar * or NULL

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

844

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlStrsub"></a>xmlStrsub ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlStrsub (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str,

Daniel Veillard

1566d3a

1999-07-15 14:24:29 +0000

[diff] [blame]

845

int start,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

846

int len);</pre><p>

847

Extract a substring of a given string</p><p>

848

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

849

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str</tt></i> :</span></td><td> the xmlChar * array (haystack)

850

</td></tr><tr><td><span class="term"><i class="parameter"><tt>start</tt></i> :</span></td><td> the index of the first char (zero based)

851

</td></tr><tr><td><span class="term"><i class="parameter"><tt>len</tt></i> :</span></td><td> the length of the substring

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

852

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlChar * for the first occurrence or NULL.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

853

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlStrchr"></a>xmlStrchr ()</h3><pre class="programlisting">const <a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlStrchr (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str,

854

<a href="libxml-tree.html#xmlChar">xmlChar</a> val);</pre><p>

855

a strchr for xmlChar's</p><p>

856

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

857

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str</tt></i> :</span></td><td> the xmlChar * array

858

</td></tr><tr><td><span class="term"><i class="parameter"><tt>val</tt></i> :</span></td><td> the xmlChar to search

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

859

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlChar * for the first occurrence or NULL.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

860

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlStrstr"></a>xmlStrstr ()</h3><pre class="programlisting">const <a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlStrstr (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str,

861

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *val);</pre><p>

862

a strstr for xmlChar's</p><p>

863

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

864

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str</tt></i> :</span></td><td> the xmlChar * array (haystack)

865

</td></tr><tr><td><span class="term"><i class="parameter"><tt>val</tt></i> :</span></td><td> the xmlChar to search (needle)

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

866

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlChar * for the first occurrence or NULL.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

867

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlStrcasestr"></a>xmlStrcasestr ()</h3><pre class="programlisting">const <a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlStrcasestr (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str,

868

<a href="libxml-tree.html#xmlChar">xmlChar</a> *val);</pre><p>

869

a case-ignoring strstr for xmlChar's</p><p>

870

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

871

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str</tt></i> :</span></td><td> the xmlChar * array (haystack)

872

</td></tr><tr><td><span class="term"><i class="parameter"><tt>val</tt></i> :</span></td><td> the xmlChar to search (needle)

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

873

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlChar * for the first occurrence or NULL.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

874

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlStrcmp"></a>xmlStrcmp ()</h3><pre class="programlisting">int xmlStrcmp (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str1,

875

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str2);</pre><p>

876

a strcmp for xmlChar's</p><p>

877

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

878

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str1</tt></i> :</span></td><td> the first xmlChar *

879

</td></tr><tr><td><span class="term"><i class="parameter"><tt>str2</tt></i> :</span></td><td> the second xmlChar *

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

880

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the integer result of the comparison

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

881

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlStrncmp"></a>xmlStrncmp ()</h3><pre class="programlisting">int xmlStrncmp (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str1,

882

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str2,

883

int len);</pre><p>

884

a strncmp for xmlChar's</p><p>

885

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

886

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str1</tt></i> :</span></td><td> the first xmlChar *

887

</td></tr><tr><td><span class="term"><i class="parameter"><tt>str2</tt></i> :</span></td><td> the second xmlChar *

888

</td></tr><tr><td><span class="term"><i class="parameter"><tt>len</tt></i> :</span></td><td> the max comparison length

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

889

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the integer result of the comparison

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

890

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlStrcasecmp"></a>xmlStrcasecmp ()</h3><pre class="programlisting">int xmlStrcasecmp (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str1,

891

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str2);</pre><p>

892

a strcasecmp for xmlChar's</p><p>

893

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

894

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str1</tt></i> :</span></td><td> the first xmlChar *

895

</td></tr><tr><td><span class="term"><i class="parameter"><tt>str2</tt></i> :</span></td><td> the second xmlChar *

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

896

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the integer result of the comparison

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

897

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlStrncasecmp"></a>xmlStrncasecmp ()</h3><pre class="programlisting">int xmlStrncasecmp (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str1,

898

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str2,

899

int len);</pre><p>

900

a strncasecmp for xmlChar's</p><p>

901

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

902

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str1</tt></i> :</span></td><td> the first xmlChar *

903

</td></tr><tr><td><span class="term"><i class="parameter"><tt>str2</tt></i> :</span></td><td> the second xmlChar *

904

</td></tr><tr><td><span class="term"><i class="parameter"><tt>len</tt></i> :</span></td><td> the max comparison length

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

905

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the integer result of the comparison

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

906

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlStrEqual"></a>xmlStrEqual ()</h3><pre class="programlisting">int xmlStrEqual (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str1,

907

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str2);</pre><p>

908

Check if both string are equal of have same content

909

Should be a bit more readable and faster than <a href="libxml-parser.html#xmlStrEqual">xmlStrEqual</a>()</p><p>

910

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

911

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str1</tt></i> :</span></td><td> the first xmlChar *

912

</td></tr><tr><td><span class="term"><i class="parameter"><tt>str2</tt></i> :</span></td><td> the second xmlChar *

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

913

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if they are equal, 0 if they are different

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

914

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlStrlen"></a>xmlStrlen ()</h3><pre class="programlisting">int xmlStrlen (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str);</pre><p>

915

length of a xmlChar's string</p><p>

916

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

917

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str</tt></i> :</span></td><td> the xmlChar * array

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

918

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of xmlChar contained in the ARRAY.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

919

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlStrcat"></a>xmlStrcat ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlStrcat (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,

920

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *add);</pre><p>

921

a strcat for array of xmlChar's. Since they are supposed to be

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

922

encoded in UTF-8 or an encoding with 8bit based chars, we assume

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

923

a termination mark of '0'.</p><p>

924

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

925

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cur</tt></i> :</span></td><td> the original xmlChar * array

926

</td></tr><tr><td><span class="term"><i class="parameter"><tt>add</tt></i> :</span></td><td> the xmlChar * array added

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

927

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a new xmlChar * containing the concatenated string.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

928

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlStrncat"></a>xmlStrncat ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlStrncat (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,

929

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *add,

930

int len);</pre><p>

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

931

a strncat for array of xmlChar's, it will extend <i class="parameter"><tt>cur</tt></i> with the len

932

first bytes of <i class="parameter"><tt>add</tt></i>.</p><p>

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

933

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

934

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cur</tt></i> :</span></td><td> the original xmlChar * array

935

</td></tr><tr><td><span class="term"><i class="parameter"><tt>add</tt></i> :</span></td><td> the xmlChar * array added

936

</td></tr><tr><td><span class="term"><i class="parameter"><tt>len</tt></i> :</span></td><td> the length of <i class="parameter"><tt>add</tt></i>

937

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a new xmlChar *, the original <i class="parameter"><tt>cur</tt></i> is reallocated if needed

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

938

and should not be freed

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

939

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseDoc"></a>xmlParseDoc ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> xmlParseDoc (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur);</pre><p>

940

parse an XML in-memory document and build a tree.</p><p>

941

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

942

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cur</tt></i> :</span></td><td> a pointer to an array of xmlChar

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

943

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

944

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseMemory"></a>xmlParseMemory ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> xmlParseMemory (const char *buffer,

945

int size);</pre><p>

946

parse an XML in-memory block and build a tree.</p><p>

947

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

948

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>buffer</tt></i> :</span></td><td> an pointer to a char array

949

</td></tr><tr><td><span class="term"><i class="parameter"><tt>size</tt></i> :</span></td><td> the size of the array

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

950

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

951

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseFile"></a>xmlParseFile ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> xmlParseFile (const char *filename);</pre><p>

952

parse an XML file and build a tree. Automatic support for ZLIB/Compress

953

compressed document is provided by default if found at compile-time.</p><p>

954

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

955

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i> :</span></td><td> the filename

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

956

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree if the file was wellformed,

957

NULL otherwise.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

958

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSubstituteEntitiesDefault"></a>xmlSubstituteEntitiesDefault ()</h3><pre class="programlisting">int xmlSubstituteEntitiesDefault (int val);</pre><p>

959

Set and return the previous value for default entity support.

Daniel Veillard

011b63c

1999-06-02 17:44:04 +0000

[diff] [blame]

960

Initially the parser always keep entity references instead of substituting

961

entity values in the output. This function has to be used to change the

Daniel Veillard

2001-12-31 16:16:02 +0000

[diff] [blame]

962

default parser behavior

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

963

SAX::<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="substituteEntities">substituteEntities</GTKDOCLINK>() has to be used for changing that on a file by

964

file basis.</p><p>

965

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

966

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>val</tt></i> :</span></td><td> int 0 or 1

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

967

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the last value for 0 for no substitution, 1 for substitution.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

968

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlKeepBlanksDefault"></a>xmlKeepBlanksDefault ()</h3><pre class="programlisting">int xmlKeepBlanksDefault (int val);</pre><p>

969

Set and return the previous value for default blanks text nodes support.

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

970

The 1.x version of the parser used an heuristic to try to detect

971

ignorable white spaces. As a result the SAX callback was generating

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

972

<a href="libxml-SAX.html#ignorableWhitespace">ignorableWhitespace</a>() callbacks instead of <a href="libxml-SAX.html#characters">characters</a>() one, and when

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

973

using the DOM output text nodes containing those blanks were not generated.

974

The 2.x and later version will switch to the XML standard way and

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

975

<a href="libxml-SAX.html#ignorableWhitespace">ignorableWhitespace</a>() are only generated when running the parser in

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

976

validating mode and when the current element doesn't allow CDATA or

977

mixed content.

Daniel Veillard

2001-12-31 16:16:02 +0000

[diff] [blame]

978

This function is provided as a way to force the standard behavior

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

979

on 1.X libs and to switch back to the old mode for compatibility when

980

running 1.X client code on 2.X . Upgrade of 1.X code should be done

Daniel Veillard

2003-08-15 00:33:43 +0000

[diff] [blame]

981

by using <a href="libxml-tree.html#xmlIsBlankNode">xmlIsBlankNode</a>() commodity function to detect the "empty"

Daniel Veillard

2000-06-30 17:58:25 +0000

[diff] [blame]

982

nodes generated.

983

This value also affect autogeneration of indentation when saving code

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

984

if blanks sections are kept, indentation is not generated.</p><p>

985

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

986

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>val</tt></i> :</span></td><td> int 0 or 1

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

987

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the last value for 0 for no substitution, 1 for substitution.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

988

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlStopParser"></a>xmlStopParser ()</h3><pre class="programlisting">void xmlStopParser (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>

989

Blocks further parser processing</p><p>

990

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

991

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctxt</tt></i> :</span></td><td> an XML parser context

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

992

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlPedanticParserDefault"></a>xmlPedanticParserDefault ()</h3><pre class="programlisting">int xmlPedanticParserDefault (int val);</pre><p>

993

Set and return the previous value for enabling pedantic warnings.</p><p>

994

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

995

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>val</tt></i> :</span></td><td> int 0 or 1

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

996

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the last value for 0 for no substitution, 1 for substitution.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

997

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlLineNumbersDefault"></a>xmlLineNumbersDefault ()</h3><pre class="programlisting">int xmlLineNumbersDefault (int val);</pre><p>

998

Set and return the previous value for enabling line numbers in elements

999

contents. This may break on old application and is turned off by default.</p><p>

1000

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1001

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>val</tt></i> :</span></td><td> int 0 or 1

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1002

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the last value for 0 for no substitution, 1 for substitution.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1003

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRecoverDoc"></a>xmlRecoverDoc ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> xmlRecoverDoc (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur);</pre><p>

1004

parse an XML in-memory document and build a tree.

1005

In the case the document is not Well Formed, a tree is built anyway</p><p>

1006

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1007

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cur</tt></i> :</span></td><td> a pointer to an array of xmlChar

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1008

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1009

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRecoverMemory"></a>xmlRecoverMemory ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> xmlRecoverMemory (const char *buffer,

1010

int size);</pre><p>

1011

parse an XML in-memory block and build a tree.

1012

In the case the document is not Well Formed, a tree is built anyway</p><p>

1013

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1014

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>buffer</tt></i> :</span></td><td> an pointer to a char array

1015

</td></tr><tr><td><span class="term"><i class="parameter"><tt>size</tt></i> :</span></td><td> the size of the array

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1016

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1017

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRecoverFile"></a>xmlRecoverFile ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> xmlRecoverFile (const char *filename);</pre><p>

1018

parse an XML file and build a tree. Automatic support for ZLIB/Compress

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1019

compressed document is provided by default if found at compile-time.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1020

In the case the document is not Well Formed, a tree is built anyway</p><p>

1021

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1022

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i> :</span></td><td> the filename

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1023

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1024

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseDocument"></a>xmlParseDocument ()</h3><pre class="programlisting">int xmlParseDocument (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>

1025

parse an XML document (and build a tree if using the standard SAX

1026

interface).

1027

</p><p>

1028

[1] document ::= prolog element Misc*

1029

</p><p>

1030

[22] prolog ::= XMLDecl? Misc* (doctypedecl Misc*)?</p><p>

1031

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1032

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctxt</tt></i> :</span></td><td> an XML parser context

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1033

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0, -1 in case of error. the parser context is augmented

1034

as a result of the parsing.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1035

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseExtParsedEnt"></a>xmlParseExtParsedEnt ()</h3><pre class="programlisting">int xmlParseExtParsedEnt (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>

1036

parse a general parsed entity

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1037

An external general parsed entity is well-formed if it matches the

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1038

production labeled extParsedEnt.

1039

</p><p>

1040

[78] extParsedEnt ::= TextDecl? content</p><p>

1041

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1042

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctxt</tt></i> :</span></td><td> an XML parser context

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1043

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0, -1 in case of error. the parser context is augmented

1044

as a result of the parsing.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1045

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSAXParseDoc"></a>xmlSAXParseDoc ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> xmlSAXParseDoc (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

1046

<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,

1047

int recovery);</pre><p>

1048

parse an XML in-memory document and build a tree.

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1049

It use the given SAX function block to handle the parsing callback.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1050

If sax is NULL, fallback to the default DOM tree building routines.</p><p>

1051

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1052

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>sax</tt></i> :</span></td><td> the SAX handler block

1053

</td></tr><tr><td><span class="term"><i class="parameter"><tt>cur</tt></i> :</span></td><td> a pointer to an array of xmlChar

1054

</td></tr><tr><td><span class="term"><i class="parameter"><tt>recovery</tt></i> :</span></td><td> work in recovery mode, i.e. tries to read no Well Formed

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1055

documents

1056

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1057

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSAXUserParseFile"></a>xmlSAXUserParseFile ()</h3><pre class="programlisting">int xmlSAXUserParseFile (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1058

void *user_data,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1059

const char *filename);</pre><p>

1060

parse an XML file and call the given SAX handler routines.

1061

Automatic support for ZLIB/Compress compressed document is provided</p><p>

1062

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1063

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>sax</tt></i> :</span></td><td> a SAX handler

1064

</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i> :</span></td><td> The user data returned on SAX callbacks

1065

</td></tr><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i> :</span></td><td> a file name

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1066

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 in case of success or a error number otherwise

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1067

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSAXUserParseMemory"></a>xmlSAXUserParseMemory ()</h3><pre class="programlisting">int xmlSAXUserParseMemory (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1068

void *user_data,

1069

const char *buffer,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1070

int size);</pre><p>

1071

A better SAX parsing routine.

1072

parse an XML in-memory buffer and call the given SAX handler routines.</p><p>

1073

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1074

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>sax</tt></i> :</span></td><td> a SAX handler

1075

</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i> :</span></td><td> The user data returned on SAX callbacks

1076

</td></tr><tr><td><span class="term"><i class="parameter"><tt>buffer</tt></i> :</span></td><td> an in-memory XML document input

1077

</td></tr><tr><td><span class="term"><i class="parameter"><tt>size</tt></i> :</span></td><td> the length of the XML document in bytes

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1078

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 in case of success or a error number otherwise

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1079

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSAXParseMemory"></a>xmlSAXParseMemory ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> xmlSAXParseMemory (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1080

const char *buffer,

1081

int size,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1082

int recovery);</pre><p>

1083

parse an XML in-memory block and use the given SAX function block

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1084

to handle the parsing callback. If sax is NULL, fallback to the default

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1085

DOM tree building routines.</p><p>

1086

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1087

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>sax</tt></i> :</span></td><td> the SAX handler block

1088

</td></tr><tr><td><span class="term"><i class="parameter"><tt>buffer</tt></i> :</span></td><td> an pointer to a char array

1089

</td></tr><tr><td><span class="term"><i class="parameter"><tt>size</tt></i> :</span></td><td> the size of the array

1090

</td></tr><tr><td><span class="term"><i class="parameter"><tt>recovery</tt></i> :</span></td><td> work in recovery mode, i.e. tries to read not Well Formed

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1091

documents

1092

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1093

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSAXParseMemoryWithData"></a>xmlSAXParseMemoryWithData ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> xmlSAXParseMemoryWithData (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2003-03-23 20:42:17 +0000

[diff] [blame]

1094

const char *buffer,

1095

int size,

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1096

int recovery,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1097

void *data);</pre><p>

1098

parse an XML in-memory block and use the given SAX function block

Daniel Veillard

2003-03-23 20:42:17 +0000

[diff] [blame]

1099

to handle the parsing callback. If sax is NULL, fallback to the default

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1100

DOM tree building routines.

1101

</p><p>

1102

User data (void *) is stored within the parser context in the

1103

context's _private member, so it is available nearly everywhere in libxml</p><p>

1104

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1105

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>sax</tt></i> :</span></td><td> the SAX handler block

1106

</td></tr><tr><td><span class="term"><i class="parameter"><tt>buffer</tt></i> :</span></td><td> an pointer to a char array

1107

</td></tr><tr><td><span class="term"><i class="parameter"><tt>size</tt></i> :</span></td><td> the size of the array

1108

</td></tr><tr><td><span class="term"><i class="parameter"><tt>recovery</tt></i> :</span></td><td> work in recovery mode, i.e. tries to read no Well Formed

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1109

documents

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1110

</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td> the userdata

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1111

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1112

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSAXParseFile"></a>xmlSAXParseFile ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> xmlSAXParseFile (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2003-03-23 20:42:17 +0000

[diff] [blame]

1113

const char *filename,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1114

int recovery);</pre><p>

1115

parse an XML file and build a tree. Automatic support for ZLIB/Compress

Daniel Veillard

2003-03-23 20:42:17 +0000

[diff] [blame]

1116

compressed document is provided by default if found at compile-time.

1117

It use the given SAX function block to handle the parsing callback.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1118

If sax is NULL, fallback to the default DOM tree building routines.</p><p>

1119

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1120

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>sax</tt></i> :</span></td><td> the SAX handler block

1121

</td></tr><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i> :</span></td><td> the filename

1122

</td></tr><tr><td><span class="term"><i class="parameter"><tt>recovery</tt></i> :</span></td><td> work in recovery mode, i.e. tries to read no Well Formed

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1123

documents

1124

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1125

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSAXParseFileWithData"></a>xmlSAXParseFileWithData ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> xmlSAXParseFileWithData (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2003-03-23 20:42:17 +0000

[diff] [blame]

1126

const char *filename,

1127

int recovery,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1128

void *data);</pre><p>

1129

parse an XML file and build a tree. Automatic support for ZLIB/Compress

Daniel Veillard

2003-03-23 20:42:17 +0000

[diff] [blame]

1130

compressed document is provided by default if found at compile-time.

1131

It use the given SAX function block to handle the parsing callback.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1132

If sax is NULL, fallback to the default DOM tree building routines.

1133

</p><p>

1134

User data (void *) is stored within the parser context in the

1135

context's _private member, so it is available nearly everywhere in libxml</p><p>

1136

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1137

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>sax</tt></i> :</span></td><td> the SAX handler block

1138

</td></tr><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i> :</span></td><td> the filename

1139

</td></tr><tr><td><span class="term"><i class="parameter"><tt>recovery</tt></i> :</span></td><td> work in recovery mode, i.e. tries to read no Well Formed

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1140

documents

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1141

</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td> the userdata

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1142

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1143

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSAXParseEntity"></a>xmlSAXParseEntity ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> xmlSAXParseEntity (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

1144

const char *filename);</pre><p>

1145

parse an XML external entity out of context and build a tree.

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1146

It use the given SAX function block to handle the parsing callback.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1147

If sax is NULL, fallback to the default DOM tree building routines.

1148

</p><p>

1149

[78] extParsedEnt ::= TextDecl? content

1150

</p><p>

Daniel Veillard

2003-08-15 00:33:43 +0000

[diff] [blame]

1151

This correspond to a "Well Balanced" chunk</p><p>

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1152

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1153

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>sax</tt></i> :</span></td><td> the SAX handler block

1154

</td></tr><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i> :</span></td><td> the filename

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1155

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1156

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseEntity"></a>xmlParseEntity ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> xmlParseEntity (const char *filename);</pre><p>

1157

parse an XML external entity out of context and build a tree.

1158

</p><p>

1159

[78] extParsedEnt ::= TextDecl? content

1160

</p><p>

Daniel Veillard

2003-08-15 00:33:43 +0000

[diff] [blame]

1161

This correspond to a "Well Balanced" chunk</p><p>

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1162

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1163

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i> :</span></td><td> the filename

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1164

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1165

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseDTD"></a>xmlParseDTD ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDtdPtr">xmlDtdPtr</a> xmlParseDTD (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ExternalID,

1166

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *SystemID);</pre><p>

1167

Load and parse an external subset.</p><p>

1168

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1169

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ExternalID</tt></i> :</span></td><td> a NAME* containing the External ID of the DTD

1170

</td></tr><tr><td><span class="term"><i class="parameter"><tt>SystemID</tt></i> :</span></td><td> a NAME* containing the URL to the DTD

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1171

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting xmlDtdPtr or NULL in case of error.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1172

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSAXParseDTD"></a>xmlSAXParseDTD ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDtdPtr">xmlDtdPtr</a> xmlSAXParseDTD (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

1173

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ExternalID,

1174

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *SystemID);</pre><p>

1175

Load and parse an external subset.</p><p>

1176

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1177

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>sax</tt></i> :</span></td><td> the SAX handler block

1178

</td></tr><tr><td><span class="term"><i class="parameter"><tt>ExternalID</tt></i> :</span></td><td> a NAME* containing the External ID of the DTD

1179

</td></tr><tr><td><span class="term"><i class="parameter"><tt>SystemID</tt></i> :</span></td><td> a NAME* containing the URL to the DTD

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1180

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting xmlDtdPtr or NULL in case of error.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1181

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIOParseDTD"></a>xmlIOParseDTD ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDtdPtr">xmlDtdPtr</a> xmlIOParseDTD (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

1182

<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> input,

1183

<a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);</pre><p>

1184

Load and parse a DTD</p><p>

1185

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1186

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>sax</tt></i> :</span></td><td> the SAX handler block or NULL

1187

</td></tr><tr><td><span class="term"><i class="parameter"><tt>input</tt></i> :</span></td><td> an Input Buffer

1188

</td></tr><tr><td><span class="term"><i class="parameter"><tt>enc</tt></i> :</span></td><td> the charset encoding if known

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1189

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting xmlDtdPtr or NULL in case of error.

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1190

<i class="parameter"><tt>input</tt></i> will be freed at parsing end.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1191

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseBalancedChunkMemory"></a>xmlParseBalancedChunkMemory ()</h3><pre class="programlisting">int xmlParseBalancedChunkMemory (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc,

1192

<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1193

void *user_data,

1194

int depth,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1195

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *string,

1196

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> *lst);</pre><p>

1197

Parse a well-balanced chunk of an XML document

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1198

called by the parser

1199

The allowed sequence for the Well Balanced Chunk is the one defined by

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1200

the content production in the XML grammar:

</p><p>

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1204

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>doc</tt></i> :</span></td><td> the document the chunk pertains to

1205

</td></tr><tr><td><span class="term"><i class="parameter"><tt>sax</tt></i> :</span></td><td> the SAX handler bloc (possibly NULL)

1206

</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i> :</span></td><td> The user data returned on SAX callbacks (possibly NULL)

1207

</td></tr><tr><td><span class="term"><i class="parameter"><tt>depth</tt></i> :</span></td><td> Used for loop detection, use 0

1208

</td></tr><tr><td><span class="term"><i class="parameter"><tt>string</tt></i> :</span></td><td> the input string in UTF8 or ISO-Latin (zero terminated)

1209

</td></tr><tr><td><span class="term"><i class="parameter"><tt>lst</tt></i> :</span></td><td> the return value for the set of parsed nodes

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1210

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if the chunk is well balanced, -1 in case of args problem and

1211

the parser error code otherwise

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1212

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseBalancedChunkMemoryRecover"></a>xmlParseBalancedChunkMemoryRecover ()</h3><pre class="programlisting">int xmlParseBalancedChunkMemoryRecover

1213

(<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc,

1214

<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2002-09-26 12:28:02 +0000

[diff] [blame]

1215

void *user_data,

1216

int depth,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1217

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *string,

1218

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> *lst,

1219

int recover);</pre><p>

1220

Parse a well-balanced chunk of an XML document

Daniel Veillard

2002-09-26 12:28:02 +0000

[diff] [blame]

1221

called by the parser

1222

The allowed sequence for the Well Balanced Chunk is the one defined by

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1223

the content production in the XML grammar:

</p><p>

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1227

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>doc</tt></i> :</span></td><td> the document the chunk pertains to

1228

</td></tr><tr><td><span class="term"><i class="parameter"><tt>sax</tt></i> :</span></td><td> the SAX handler bloc (possibly NULL)

1229

</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i> :</span></td><td> The user data returned on SAX callbacks (possibly NULL)

1230

</td></tr><tr><td><span class="term"><i class="parameter"><tt>depth</tt></i> :</span></td><td> Used for loop detection, use 0

1231

</td></tr><tr><td><span class="term"><i class="parameter"><tt>string</tt></i> :</span></td><td> the input string in UTF8 or ISO-Latin (zero terminated)

1232

</td></tr><tr><td><span class="term"><i class="parameter"><tt>lst</tt></i> :</span></td><td> the return value for the set of parsed nodes

1233

</td></tr><tr><td><span class="term"><i class="parameter"><tt>recover</tt></i> :</span></td><td> return nodes even if the data is broken (use 0)

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1234

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if the chunk is well balanced, -1 in case of args problem and

1235

the parser error code otherwise

1236

1237

In case recover is set to 1, the nodelist will not be empty even if

1238

the parsed chunk is not well balanced.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1239

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseExternalEntity"></a>xmlParseExternalEntity ()</h3><pre class="programlisting">int xmlParseExternalEntity (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc,

1240

<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1241

void *user_data,

1242

int depth,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1243

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *URL,

1244

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ID,

1245

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> *lst);</pre><p>

1246

Parse an external general entity

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1247

An external general parsed entity is well-formed if it matches the

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1248

production labeled extParsedEnt.

1249

</p><p>

1250

[78] extParsedEnt ::= TextDecl? content</p><p>

1251

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1252

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>doc</tt></i> :</span></td><td> the document the chunk pertains to

1253

</td></tr><tr><td><span class="term"><i class="parameter"><tt>sax</tt></i> :</span></td><td> the SAX handler bloc (possibly NULL)

1254

</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i> :</span></td><td> The user data returned on SAX callbacks (possibly NULL)

1255

</td></tr><tr><td><span class="term"><i class="parameter"><tt>depth</tt></i> :</span></td><td> Used for loop detection, use 0

1256

</td></tr><tr><td><span class="term"><i class="parameter"><tt>URL</tt></i> :</span></td><td> the URL for the entity to load

1257

</td></tr><tr><td><span class="term"><i class="parameter"><tt>ID</tt></i> :</span></td><td> the System ID for the entity to load

1258

</td></tr><tr><td><span class="term"><i class="parameter"><tt>lst</tt></i> :</span></td><td> the return value for the set of parsed nodes

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1259

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if the entity is well formed, -1 in case of args problem and

1260

the parser error code otherwise

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1261

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseCtxtExternalEntity"></a>xmlParseCtxtExternalEntity ()</h3><pre class="programlisting">int xmlParseCtxtExternalEntity (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctx,

1262

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *URL,

1263

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ID,

1264

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> *lst);</pre><p>

1265

Parse an external general entity within an existing parsing context

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1266

An external general parsed entity is well-formed if it matches the

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1267

production labeled extParsedEnt.

1268

</p><p>

1269

[78] extParsedEnt ::= TextDecl? content</p><p>

1270

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1271

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> the existing parsing context

1272

</td></tr><tr><td><span class="term"><i class="parameter"><tt>URL</tt></i> :</span></td><td> the URL for the entity to load

1273

</td></tr><tr><td><span class="term"><i class="parameter"><tt>ID</tt></i> :</span></td><td> the System ID for the entity to load

1274

</td></tr><tr><td><span class="term"><i class="parameter"><tt>lst</tt></i> :</span></td><td> the return value for the set of parsed nodes

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1275

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if the entity is well formed, -1 in case of args problem and

1276

the parser error code otherwise

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1277

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlInitParserCtxt"></a>xmlInitParserCtxt ()</h3><pre class="programlisting">int xmlInitParserCtxt (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>

1278

Initialize a parser context</p><p>

1279

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1280

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctxt</tt></i> :</span></td><td> an HTML parser context

1281

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>

1282

1283

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1284

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlClearParserCtxt"></a>xmlClearParserCtxt ()</h3><pre class="programlisting">void xmlClearParserCtxt (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>

1285

Clear (release owned resources) and reinitialize a parser context</p><p>

1286

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1287

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctxt</tt></i> :</span></td><td> an XML parser context

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1288

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlFreeParserCtxt"></a>xmlFreeParserCtxt ()</h3><pre class="programlisting">void xmlFreeParserCtxt (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>

1289

Free all the memory used by a parser context. However the parsed

1290

document in ctxt->myDoc is not freed.</p><p>

1291

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1292

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctxt</tt></i> :</span></td><td> an XML parser context

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1293

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSetupParserForBuffer"></a>xmlSetupParserForBuffer ()</h3><pre class="programlisting">void xmlSetupParserForBuffer (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,

1294

const <a href="libxml-tree.html#xmlChar">xmlChar</a> *buffer,

1295

const char *filename);</pre><p>

1296

Setup the parser context to parse a new buffer; Clears any prior

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1297

contents from the parser context. The buffer parameter must not be

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1298

NULL, but the filename parameter can be</p><p>

1299

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1300

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctxt</tt></i> :</span></td><td> an XML parser context

1301

</td></tr><tr><td><span class="term"><i class="parameter"><tt>buffer</tt></i> :</span></td><td> a xmlChar * buffer

1302

</td></tr><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i> :</span></td><td> a file name

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1303

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCreateDocParserCtxt"></a>xmlCreateDocParserCtxt ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> xmlCreateDocParserCtxt (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur);</pre><p>

1304

Creates a parser context for an XML in-memory document.</p><p>

1305

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1306

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cur</tt></i> :</span></td><td> a pointer to an array of xmlChar

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1307

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser context or NULL

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1308

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlGetFeaturesList"></a>xmlGetFeaturesList ()</h3><pre class="programlisting">int xmlGetFeaturesList (int *len,

1309

const char **result);</pre><p>

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1310

Copy at most *<i class="parameter"><tt>len</tt></i> feature names into the <i class="parameter"><tt>result</tt></i> array</p><p>

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1311

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1312

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>len</tt></i> :</span></td><td> the length of the features name array (input/output)

1313

</td></tr><tr><td><span class="term"><i class="parameter"><tt>result</tt></i> :</span></td><td> an array of string to be filled with the features name.

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1314

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>-1 in case or error, or the total number of features,

1315

len is updated with the number of strings copied,

1316

strings must not be deallocated

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1317

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlGetFeature"></a>xmlGetFeature ()</h3><pre class="programlisting">int xmlGetFeature (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1318

const char *name,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1319

void *result);</pre><p>

1320

Read the current value of one feature of this parser instance</p><p>

1321

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1322

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctxt</tt></i> :</span></td><td> an XML/HTML parser context

1323

</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> the feature name

1324

</td></tr><tr><td><span class="term"><i class="parameter"><tt>result</tt></i> :</span></td><td> location to store the result

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1325

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>-1 in case or error, 0 otherwise

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1326

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSetFeature"></a>xmlSetFeature ()</h3><pre class="programlisting">int xmlSetFeature (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1327

const char *name,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1328

void *value);</pre><p>

1329

Change the current value of one feature of this parser instance</p><p>

1330

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1331

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctxt</tt></i> :</span></td><td> an XML/HTML parser context

1332

</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> the feature name

1333

</td></tr><tr><td><span class="term"><i class="parameter"><tt>value</tt></i> :</span></td><td> pointer to the location of the new value

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1334

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>-1 in case or error, 0 otherwise

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1335

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCreatePushParserCtxt"></a>xmlCreatePushParserCtxt ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> xmlCreatePushParserCtxt (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1336

void *user_data,

1337

const char *chunk,

1338

int size,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1339

const char *filename);</pre><p>

1340

Create a parser context for using the XML parser in push mode.

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1341

If <i class="parameter"><tt>buffer</tt></i> and <i class="parameter"><tt>size</tt></i> are non-NULL, the data is used to detect

Daniel Veillard

2003-03-23 20:42:17 +0000

[diff] [blame]

1342

the encoding. The remaining characters will be parsed so they

1343

don't need to be fed in again through xmlParseChunk.

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1344

To allow content encoding detection, <i class="parameter"><tt>size</tt></i> should be >= 4

1345

The value of <i class="parameter"><tt>filename</tt></i> is used for fetching external entities

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1346

and error/warning reports.</p><p>

1347

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1348

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>sax</tt></i> :</span></td><td> a SAX handler

1349

</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i> :</span></td><td> The user data returned on SAX callbacks

1350

</td></tr><tr><td><span class="term"><i class="parameter"><tt>chunk</tt></i> :</span></td><td> a pointer to an array of chars

1351

</td></tr><tr><td><span class="term"><i class="parameter"><tt>size</tt></i> :</span></td><td> number of chars in the array

1352

</td></tr><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i> :</span></td><td> an optional file name or URI

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1353

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser context or NULL

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1354

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseChunk"></a>xmlParseChunk ()</h3><pre class="programlisting">int xmlParseChunk (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1355

const char *chunk,

1356

int size,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1357

int terminate);</pre><p>

1358

Parse a Chunk of memory</p><p>

1359

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1360

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctxt</tt></i> :</span></td><td> an XML parser context

1361

</td></tr><tr><td><span class="term"><i class="parameter"><tt>chunk</tt></i> :</span></td><td> an char array

1362

</td></tr><tr><td><span class="term"><i class="parameter"><tt>size</tt></i> :</span></td><td> the size in byte of the chunk

1363

</td></tr><tr><td><span class="term"><i class="parameter"><tt>terminate</tt></i> :</span></td><td> last chunk indicator

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1364

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>zero if no error, the xmlParserErrors otherwise.

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1365

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCreateIOParserCtxt"></a>xmlCreateIOParserCtxt ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> xmlCreateIOParserCtxt (<a href="libxml-tree.html#xmlSAXHandlerPtr">xmlSAXHandlerPtr</a> sax,

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1366

void *user_data,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1367

<a href="libxml-xmlIO.html#xmlInputReadCallback">xmlInputReadCallback</a> ioread,

1368

<a href="libxml-xmlIO.html#xmlInputCloseCallback">xmlInputCloseCallback</a> ioclose,

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1369

void *ioctx,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1370

<a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);</pre><p>

1371

Create a parser context for using the XML parser with an existing

1372

I/O stream</p><p>

1373

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1374

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>sax</tt></i> :</span></td><td> a SAX handler

1375

</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i> :</span></td><td> The user data returned on SAX callbacks

1376

</td></tr><tr><td><span class="term"><i class="parameter"><tt>ioread</tt></i> :</span></td><td> an I/O read function

1377

</td></tr><tr><td><span class="term"><i class="parameter"><tt>ioclose</tt></i> :</span></td><td> an I/O close function

1378

</td></tr><tr><td><span class="term"><i class="parameter"><tt>ioctx</tt></i> :</span></td><td> an I/O handler

1379

</td></tr><tr><td><span class="term"><i class="parameter"><tt>enc</tt></i> :</span></td><td> the charset encoding if known

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1380

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser context or NULL

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1381

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlNewIOInputStream"></a>xmlNewIOInputStream ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> xmlNewIOInputStream (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,

1382

<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> input,

1383

<a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);</pre><p>

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1384

Create a new input stream structure encapsulating the <i class="parameter"><tt>input</tt></i> into

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1385

a stream suitable for the parser.</p><p>

1386

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1387

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctxt</tt></i> :</span></td><td> an XML parser context

1388

</td></tr><tr><td><span class="term"><i class="parameter"><tt>input</tt></i> :</span></td><td> an I/O Input

1389

</td></tr><tr><td><span class="term"><i class="parameter"><tt>enc</tt></i> :</span></td><td> the charset encoding if known

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1390

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new input stream or NULL

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1391

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserFindNodeInfo"></a>xmlParserFindNodeInfo ()</h3><pre class="programlisting">const <a href="libxml-parser.html#xmlParserNodeInfo">xmlParserNodeInfo</a>* xmlParserFindNodeInfo

1392

(const <a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,

1393

const <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);</pre><p>

1394

Find the parser node info struct for a given node</p><p>

1395

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1396

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctxt</tt></i> :</span></td><td>

1397

</td></tr><tr><td><span class="term"><i class="parameter"><tt>node</tt></i> :</span></td><td> an XML node within the tree

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1398

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>an xmlParserNodeInfo block pointer or NULL

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1399

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlInitNodeInfoSeq"></a>xmlInitNodeInfoSeq ()</h3><pre class="programlisting">void xmlInitNodeInfoSeq (<a href="libxml-parser.html#xmlParserNodeInfoSeqPtr">xmlParserNodeInfoSeqPtr</a> seq);</pre><p>

1400

-- Initialize (set to initial state) node info sequence</p><p>

1401

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1402

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>seq</tt></i> :</span></td><td> a node info sequence pointer

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1403

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlClearNodeInfoSeq"></a>xmlClearNodeInfoSeq ()</h3><pre class="programlisting">void xmlClearNodeInfoSeq (<a href="libxml-parser.html#xmlParserNodeInfoSeqPtr">xmlParserNodeInfoSeqPtr</a> seq);</pre><p>

1404

-- Clear (release memory and reinitialize) node

1405

info sequence</p><p>

1406

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1407

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>seq</tt></i> :</span></td><td> a node info sequence pointer

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1408

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserFindNodeInfoIndex"></a>xmlParserFindNodeInfoIndex ()</h3><pre class="programlisting">unsigned <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="long">long</GTKDOCLINK> xmlParserFindNodeInfoIndex (const <a href="libxml-parser.html#xmlParserNodeInfoSeqPtr">xmlParserNodeInfoSeqPtr</a> seq,

1409

const <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);</pre><p>

1410

xmlParserFindNodeInfoIndex : Find the index that the info record for

1411

the given node is or should be at in a sorted sequence</p><p>

1412

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1413

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>seq</tt></i> :</span></td><td> a node info sequence pointer

1414

</td></tr><tr><td><span class="term"><i class="parameter"><tt>node</tt></i> :</span></td><td> an XML node pointer

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1415

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a long indicating the position of the record

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1416

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserAddNodeInfo"></a>xmlParserAddNodeInfo ()</h3><pre class="programlisting">void xmlParserAddNodeInfo (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,

1417

const <a href="libxml-parser.html#xmlParserNodeInfoPtr">xmlParserNodeInfoPtr</a> info);</pre><p>

1418

Insert node info record into the sorted sequence</p><p>

1419

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1420

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctxt</tt></i> :</span></td><td> an XML parser context

1421

</td></tr><tr><td><span class="term"><i class="parameter"><tt>info</tt></i> :</span></td><td> a node info sequence pointer

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1422

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSetExternalEntityLoader"></a>xmlSetExternalEntityLoader ()</h3><pre class="programlisting">void xmlSetExternalEntityLoader (<a href="libxml-parser.html#xmlExternalEntityLoader">xmlExternalEntityLoader</a> f);</pre><p>

1423

Changes the defaultexternal entity resolver function for the application</p><p>

1424

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1425

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>f</tt></i> :</span></td><td> the new entity resolver function

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1426

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlGetExternalEntityLoader"></a>xmlGetExternalEntityLoader ()</h3><pre class="programlisting"><a href="libxml-parser.html#xmlExternalEntityLoader">xmlExternalEntityLoader</a> xmlGetExternalEntityLoader

1427

(void);</pre><p>

1428

Get the default external entity resolver function for the application</p><p>

1429

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1430

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlExternalEntityLoader function pointer

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1431

</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlLoadExternalEntity"></a>xmlLoadExternalEntity ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> xmlLoadExternalEntity (const char *URL,

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1432

const char *ID,

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1433

<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>

1434

Load an external entity, note that the use of this function for

Daniel Veillard

2002-01-21 17:53:42 +0000

[diff] [blame]

1435

unparsed entities may generate problems

Daniel Veillard

2003-04-29 12:40:16 +0000

[diff] [blame]

1436

TODO: a more generic External entity API must be designed</p><p>

1437

William M. Brack

2003-08-16 12:44:47 +0000

[diff] [blame]

1438

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>URL</tt></i> :</span></td><td> the URL for the entity to load

1439

</td></tr><tr><td><span class="term"><i class="parameter"><tt>ID</tt></i> :</span></td><td> the Public ID for the entity to load

1440

</td></tr><tr><td><span class="term"><i class="parameter"><tt>ctxt</tt></i> :</span></td><td> the context in which the entity is called or NULL

Daniel Veillard

2003-06-13 12:30:10 +0000

[diff] [blame]

1441

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlParserInputPtr or NULL

William M. Brack