home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _e2a27421a7f7a83597df4933d83a3a96 < prev    next >
Text File  |  2000-03-23  |  25KB  |  491 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>XML::Parser - A perl module for parsing XML documents</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> XML::Parser - A perl module for parsing XML documents</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#methods">METHODS</A></LI>
  26.     <LI><A HREF="#handlers">HANDLERS</A></LI>
  27.     <UL>
  28.  
  29.         <LI><A HREF="#init (expat)">Init        (Expat)</A></LI>
  30.         <LI><A HREF="#final (expat)">Final        (Expat)</A></LI>
  31.         <LI><A HREF="#start (expat, element [, attr, val [,...]])">Start        (Expat, Element [, Attr, Val [,...]])</A></LI>
  32.         <LI><A HREF="#end (expat, element)">End        (Expat, Element)</A></LI>
  33.         <LI><A HREF="#char (expat, string)">Char        (Expat, String)</A></LI>
  34.         <LI><A HREF="#proc (expat, target, data)">Proc        (Expat, Target, Data)</A></LI>
  35.         <LI><A HREF="#comment (expat, data)">Comment        (Expat, Data)</A></LI>
  36.         <LI><A HREF="#cdatastart (expat)">CdataStart    (Expat)</A></LI>
  37.         <LI><A HREF="#cdataend (expat)">CdataEnd        (Expat)</A></LI>
  38.         <LI><A HREF="#default (expat, string)">Default        (Expat, String)</A></LI>
  39.         <LI><A HREF="#unparsed (expat, entity, base, sysid, pubid, notation)">Unparsed        (Expat, Entity, Base, Sysid, Pubid, Notation)</A></LI>
  40.         <LI><A HREF="#notation (expat, notation, base, sysid, pubid)">Notation        (Expat, Notation, Base, Sysid, Pubid)</A></LI>
  41.         <LI><A HREF="#externent (expat, base, sysid, pubid)">ExternEnt    (Expat, Base, Sysid, Pubid)</A></LI>
  42.         <LI><A HREF="#entity (expat, name, val, sysid, pubid, ndata)">Entity        (Expat, Name, Val, Sysid, Pubid, Ndata)</A></LI>
  43.         <LI><A HREF="#element (expat, name, model)">Element        (Expat, Name, Model)</A></LI>
  44.         <LI><A HREF="#attlist (expat, elname, attname, type, default, fixed)">Attlist        (Expat, Elname, Attname, Type, Default, Fixed)</A></LI>
  45.         <LI><A HREF="#doctype (expat, name, sysid, pubid, internal)">Doctype        (Expat, Name, Sysid, Pubid, Internal)</A></LI>
  46.         <LI><A HREF="#xmldecl (expat, version, encoding, standalone)">XMLDecl        (Expat, Version, Encoding, Standalone)</A></LI>
  47.     </UL>
  48.  
  49.     <LI><A HREF="#styles">STYLES</A></LI>
  50.     <UL>
  51.  
  52.         <LI><A HREF="#debug">Debug</A></LI>
  53.         <LI><A HREF="#subs">Subs</A></LI>
  54.         <LI><A HREF="#tree">Tree</A></LI>
  55.         <LI><A HREF="#objects">Objects</A></LI>
  56.         <LI><A HREF="#stream">Stream</A></LI>
  57.     </UL>
  58.  
  59.     <LI><A HREF="#encodings">ENCODINGS</A></LI>
  60.     <LI><A HREF="#authors">AUTHORS</A></LI>
  61. </UL>
  62. <!-- INDEX END -->
  63.  
  64. <HR>
  65. <P>
  66. <H1><A NAME="name">NAME</A></H1>
  67. <P>XML::Parser - A perl module for parsing XML documents</P>
  68. <P>
  69. <HR>
  70. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  71. <UL>
  72. <LI>Linux</LI>
  73. <LI>Solaris</LI>
  74. <LI>Windows</LI>
  75. </UL>
  76. <HR>
  77. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  78. <PRE>
  79.   use XML::Parser;
  80. </PRE>
  81. <PRE>
  82.  
  83.   $p1 = new XML::Parser(Style => 'Debug');
  84.   $p1->parsefile('REC-xml-19980210.xml');
  85.   $p1->parse('<foo id="me">Hello World</foo>');</PRE>
  86. <PRE>
  87.   # Alternative
  88.   $p2 = new XML::Parser(Handlers => {Start => \&handle_start,
  89.                                      End   => \&handle_end,
  90.                                      Char  => \&handle_char});
  91.   $p2->parse($socket);</PRE>
  92. <PRE>
  93.   # Another alternative
  94.   $p3 = new XML::Parser(ErrorContext => 2);</PRE>
  95. <PRE>
  96.   $p3->setHandlers(Char    => \&text,
  97.                    Default => \&other);</PRE>
  98. <PRE>
  99.   open(FOO, 'xmlgenerator |');
  100.   $p3->parse(*FOO, ProtocolEncoding => 'ISO-8859-1');
  101.   close(FOO);</PRE>
  102. <PRE>
  103.   $p3->parsefile('junk.xml', ErrorContext => 3);</PRE>
  104. <P>
  105. <HR>
  106. <H1><A NAME="description">DESCRIPTION</A></H1>
  107. <P>This module provides ways to parse XML documents. It is built on top of
  108. <A HREF="../../../site/lib/XML/Parser/Expat.html">the XML::Parser::Expat manpage</A>, which is a lower level interface to James Clark's
  109. expat library. Each call to one of the parsing methods creates a new
  110. instance of XML::Parser::Expat which is then used to parse the document.
  111. Expat options may be provided when the XML::Parser object is created.
  112. These options are then passed on to the Expat object on each parse call.
  113. They can also be given as extra arguments to the parse methods, in which
  114. case they override options given at XML::Parser creation time.</P>
  115. <P>The behavior of the parser is controlled either by <CODE>/Style</CODE> and/or
  116. <CODE>/Handlers</CODE> options, or by <A HREF="#sethandlers">setHandlers</A> method. These all provide
  117. mechanisms for XML::Parser to set the handlers needed by XML::Parser::Expat.
  118. If neither <A HREF="#item_Style"><CODE>Style</CODE></A> nor <A HREF="#item_Handlers"><CODE>Handlers</CODE></A> are specified, then parsing just
  119. checks the document for being well-formed.</P>
  120. <P>When underlying handlers get called, they receive as their first parameter
  121. the <EM>Expat</EM> object, not the Parser object.</P>
  122. <P>
  123. <HR>
  124. <H1><A NAME="methods">METHODS</A></H1>
  125. <DL>
  126. <DT><STRONG><A NAME="item_new">new</A></STRONG><BR>
  127. <DD>
  128. This is a class method, the constructor for XML::Parser. Options are passed
  129. as keyword value pairs. Recognized options are:
  130. <UL>
  131. <LI><STRONG><A NAME="item_Style">Style</A></STRONG><BR>
  132.  
  133. This option provides an easy way to create a given style of parser. The
  134. built in styles are: <A HREF="#debug">Debug</A>, <A HREF="#subs">Subs</A>, <A HREF="#tree">Tree</A>, <A HREF="#objects">Objects</A>,
  135. and <A HREF="#stream">Stream</A>.
  136. Custom styles can be provided by giving a full package name containing
  137. at least one '::'. This package should then have subs defined for each
  138. handler it wishes to have installed. See <A HREF="#styles">STYLES</A> below
  139. for a discussion of each built in style.
  140. <P></P>
  141. <LI><STRONG><A NAME="item_Handlers">Handlers</A></STRONG><BR>
  142.  
  143. When provided, this option should be an anonymous hash containing as
  144. keys the type of handler and as values a sub reference to handle that
  145. type of event. All the handlers get passed as their 1st parameter the
  146. instance of expat that is parsing the document. Further details on
  147. handlers can be found in <A HREF="#handlers">HANDLERS</A>. Any handler set here
  148. overrides the corresponding handler set with the Style option.
  149. <P></P>
  150. <LI><STRONG><A NAME="item_Pkg">Pkg</A></STRONG><BR>
  151.  
  152. Some styles will refer to subs defined in this package. If not provided,
  153. it defaults to the package which called the constructor.
  154. <P></P>
  155. <LI><STRONG><A NAME="item_ErrorContext">ErrorContext</A></STRONG><BR>
  156.  
  157. This is an Expat option. When this option is defined, errors are reported
  158. in context. The value should be the number of lines to show on either side
  159. of the line in which the error occurred.
  160. <P></P>
  161. <LI><STRONG><A NAME="item_ProtocolEncoding">ProtocolEncoding</A></STRONG><BR>
  162.  
  163. This is an Expat option. This sets the protocol encoding name. It defaults
  164. to none. The built-in encodings are: <CODE>UTF-8</CODE>, <CODE>ISO-8859-1</CODE>, <CODE>UTF-16</CODE>, and
  165. <CODE>US-ASCII</CODE>. Other encodings may be used if they have encoding maps in one
  166. of the directories in the @Encoding_Path list. Check <A HREF="#encodings">ENCODINGS</A> for
  167. more information on encoding maps. Setting the protocol encoding overrides
  168. any encoding in the XML declaration.
  169. <P></P>
  170. <LI><STRONG><A NAME="item_Namespaces">Namespaces</A></STRONG><BR>
  171.  
  172. This is an Expat option. If this is set to a true value, then namespace
  173. processing is done during the parse. See <A HREF="../../../site/lib/XML/Parser/Expat.html#namespaces">Namespaces in the XML::Parser::Expat manpage</A>
  174. for further discussion of namespace processing.
  175. <P></P>
  176. <LI><STRONG><A NAME="item_NoExpand">NoExpand</A></STRONG><BR>
  177.  
  178. This is an Expat option. Normally, the parser will try to expand references
  179. to entities defined in the internal subset. If this option is set to a true
  180. value, and a default handler is also set, then the default handler will be
  181. called when an entity reference is seen in text. This has no effect if a
  182. default handler has not been registered, and it has no effect on the expansion
  183. of entity references inside attribute values.
  184. <P></P>
  185. <LI><STRONG><A NAME="item_Stream_Delimiter">Stream_Delimiter</A></STRONG><BR>
  186.  
  187. This is an Expat option. It takes a string value. When this string is found
  188. alone on a line while parsing from a stream, then the parse is ended as if it
  189. saw an end of file. The intended use is with a stream of xml documents in a
  190. MIME multipart format. The string should not contain a trailing newline.
  191. <P></P>
  192. <LI><STRONG><A NAME="item_ParseParamEnt">ParseParamEnt</A></STRONG><BR>
  193.  
  194. This is an Expat option. Unless standalone is set to ``yes'' in the XML
  195. declaration, setting this to a true value allows the external DTD to be read,
  196. and parameter entities to be parsed and expanded.
  197. <P></P>
  198. <LI><STRONG><A NAME="item_Non%2DExpat%2DOptions">Non-Expat-Options</A></STRONG><BR>
  199.  
  200. If provided, this should be an anonymous hash whose keys are options that
  201. shouldn't be passed to Expat. This should only be of concern to those
  202. subclassing XML::Parser.
  203. <P></P></UL>
  204. <DT><STRONG><A NAME="item_setHandlers">setHandlers(TYPE, HANDLER [, TYPE, HANDLER [...]])</A></STRONG><BR>
  205. <DD>
  206. This method registers handlers for various parser events. It overrides any
  207. previous handlers registered through the Style or Handler options or through
  208. earlier calls to setHandlers. By providing a false or undefined value as
  209. the handler, the existing handler can be unset.
  210. <P>This method returns a list of type, handler pairs corresponding to the
  211. input. The handlers returned are the ones that were in effect prior to
  212. the call.</P>
  213. <P>See a description of the handler types in <A HREF="#handlers">HANDLERS</A>.</P>
  214. <P></P>
  215. <DT><STRONG><A NAME="item_parse">parse(SOURCE [, OPT => OPT_VALUE [...]])</A></STRONG><BR>
  216. <DD>
  217. The SOURCE parameter should either be a string containing the whole XML
  218. document, or it should be an open IO::Handle. Constructor options to
  219. XML::Parser::Expat given as keyword-value pairs may follow the SOURCE
  220. parameter. These override, for this call, any options or attributes passed
  221. through from the XML::Parser instance.
  222. <P>A die call is thrown if a parse error occurs. Otherwise it will return 1
  223. or whatever is returned from the <STRONG>Final</STRONG> handler, if one is installed.
  224. In other words, what parse may return depends on the style.</P>
  225. <P></P>
  226. <DT><STRONG><A NAME="item_parsestring">parsestring</A></STRONG><BR>
  227. <DD>
  228. This is just an alias for parse for backwards compatibility.
  229. <P></P>
  230. <DT><STRONG><A NAME="item_parsefile">parsefile(FILE [, OPT => OPT_VALUE [...]])</A></STRONG><BR>
  231. <DD>
  232. Open FILE for reading, then call parse with the open handle. The file
  233. is closed no matter how parse returns. Returns what parse returns.
  234. <P></P>
  235. <DT><STRONG><A NAME="item_parse_start">parse_start([ OPT => OPT_VALUE [...]])</A></STRONG><BR>
  236. <DD>
  237. Create and return a new instance of XML::Parser::ExpatNB. Constructor
  238. options may be provided. If an init handler has been provided, it is
  239. called before returning the ExpatNB object. Documents are parsed by
  240. making incremental calls to the parse_more method of this object, which
  241. takes a string. A single call to the parse_done method of this object,
  242. which takes no arguments, indicates that the document is finished.
  243. <P>If there is a final handler installed, it is executed by the parse_done
  244. method before returning and the parse_done method returns whatever is
  245. returned by the final handler.</P>
  246. <P></P></DL>
  247. <P>
  248. <HR>
  249. <H1><A NAME="handlers">HANDLERS</A></H1>
  250. <P>Expat is an event based parser. As the parser recognizes parts of the
  251. document (say the start or end tag for an XML element), then any handlers
  252. registered for that type of an event are called with suitable parameters.
  253. All handlers receive an instance of XML::Parser::Expat as their first
  254. argument. See <A HREF="../../../site/lib/XML/Parser/Expat.html#methods">METHODS in the XML::Parser::Expat manpage</A> for a discussion of the
  255. methods that can be called on this object.</P>
  256. <P>
  257. <H2><A NAME="init (expat)">Init        (Expat)</A></H2>
  258. <P>This is called just before the parsing of the document starts.</P>
  259. <P>
  260. <H2><A NAME="final (expat)">Final        (Expat)</A></H2>
  261. <P>This is called just after parsing has finished, but only if no errors
  262. occurred during the parse. Parse returns what this returns.</P>
  263. <P>
  264. <H2><A NAME="start (expat, element [, attr, val [,...]])">Start        (Expat, Element [, Attr, Val [,...]])</A></H2>
  265. <P>This event is generated when an XML start tag is recognized. Element is the
  266. name of the XML element type that is opened with the start tag. The Attr &
  267. Val pairs are generated for each attribute in the start tag.</P>
  268. <P>
  269. <H2><A NAME="end (expat, element)">End        (Expat, Element)</A></H2>
  270. <P>This event is generated when an XML end tag is recognized. Note that
  271. an XML empty tag (<foo/>) generates both a start and an end event.</P>
  272. <P>
  273. <H2><A NAME="char (expat, string)">Char        (Expat, String)</A></H2>
  274. <P>This event is generated when non-markup is recognized. The non-markup
  275. sequence of characters is in String. A single non-markup sequence of
  276. characters may generate multiple calls to this handler. Whatever the
  277. encoding of the string in the original document, this is given to the
  278. handler in UTF-8.</P>
  279. <P>
  280. <H2><A NAME="proc (expat, target, data)">Proc        (Expat, Target, Data)</A></H2>
  281. <P>This event is generated when a processing instruction is recognized.</P>
  282. <P>
  283. <H2><A NAME="comment (expat, data)">Comment        (Expat, Data)</A></H2>
  284. <P>This event is generated when a comment is recognized.</P>
  285. <P>
  286. <H2><A NAME="cdatastart (expat)">CdataStart    (Expat)</A></H2>
  287. <P>This is called at the start of a CDATA section.</P>
  288. <P>
  289. <H2><A NAME="cdataend (expat)">CdataEnd        (Expat)</A></H2>
  290. <P>This is called at the end of a CDATA section.</P>
  291. <P>
  292. <H2><A NAME="default (expat, string)">Default        (Expat, String)</A></H2>
  293. <P>This is called for any characters that don't have a registered handler.
  294. This includes both characters that are part of markup for which no
  295. events are generated (markup declarations) and characters that
  296. could generate events, but for which no handler has been registered.</P>
  297. <P>Whatever the encoding in the original document, the string is returned to
  298. the handler in UTF-8.</P>
  299. <P>
  300. <H2><A NAME="unparsed (expat, entity, base, sysid, pubid, notation)">Unparsed        (Expat, Entity, Base, Sysid, Pubid, Notation)</A></H2>
  301. <P>This is called for a declaration of an unparsed entity. Entity is the name
  302. of the entity. Base is the base to be used for resolving a relative URI.
  303. Sysid is the system id. Pubid is the public id. Notation is the notation
  304. name. Base and Pubid may be undefined.</P>
  305. <P>
  306. <H2><A NAME="notation (expat, notation, base, sysid, pubid)">Notation        (Expat, Notation, Base, Sysid, Pubid)</A></H2>
  307. <P>This is called for a declaration of notation. Notation is the notation name.
  308. Base is the base to be used for resolving a relative URI. Sysid is the system
  309. id. Pubid is the public id. Base, Sysid, and Pubid may all be undefined.</P>
  310. <P>
  311. <H2><A NAME="externent (expat, base, sysid, pubid)">ExternEnt    (Expat, Base, Sysid, Pubid)</A></H2>
  312. <P>This is called when an external entity is referenced. Base is the base to be
  313. used for resolving a relative URI. Sysid is the system id. Pubid is the public
  314. id. Base, and Pubid may be undefined.</P>
  315. <P>This handler should either return a string, which represents the contents of
  316. the external entity, or return an open filehandle that can be read to obtain
  317. the contents of the external entity, or return undef, which indicates the
  318. external entity couldn't be found and will generate a parse error.</P>
  319. <P>If an open filehandle is returned, it must be returned as either a glob
  320. (*FOO) or as a reference to a glob (e.g. an instance of IO::Handle). The
  321. parser will close the filehandle after using it.</P>
  322. <P>A default handler, XML::Parser::default_ext_ent_handler, is installed
  323. for this. It only handles the file URL method and it assumes ``file:'' if
  324. it isn't there. The expat base method can be used to set a basename for
  325. relative pathnames. If no basename is given, or if the basename is itself
  326. a relative name, then it is relative to the current working directory.</P>
  327. <P>
  328. <H2><A NAME="entity (expat, name, val, sysid, pubid, ndata)">Entity        (Expat, Name, Val, Sysid, Pubid, Ndata)</A></H2>
  329. <P>This is called when an entity is declared. For internal entities, the Val
  330. parameter will contain the value and the remaining three parameters will be
  331. undefined. For external entities, the Val parameter will be undefined, the
  332. Sysid parameter will have the system id, the Pubid parameter will have the
  333. public id if it was provided (it will be undefined otherwise), the Ndata
  334. parameter will contain the notation for unparsed entities. If this is a
  335. parameter entity declaration, then a '%' will be prefixed to the name.</P>
  336. <P>Note that this handler and the Unparsed handler above overlap. If both are
  337. set, then this handler will not be called for unparsed entities.</P>
  338. <P>
  339. <H2><A NAME="element (expat, name, model)">Element        (Expat, Name, Model)</A></H2>
  340. <P>The element handler is called when an element declaration is found. Name
  341. is the element name, and Model is the content model as a string.</P>
  342. <P>
  343. <H2><A NAME="attlist (expat, elname, attname, type, default, fixed)">Attlist        (Expat, Elname, Attname, Type, Default, Fixed)</A></H2>
  344. <P>This handler is called for each attribute in an ATTLIST declaration.
  345. So an ATTLIST declaration that has multiple attributes will generate multiple
  346. calls to this handler. The Elname parameter is the name of the element with
  347. which the attribute is being associated. The Attname parameter is the name
  348. of the attribute. Type is the attribute type, given as a string. Default is
  349. the default value, which will either be ``#REQUIRED'', ``#IMPLIED'' or a quoted
  350. string (i.e. the returned string will begin and end with a quote character).
  351. If Fixed is true, then this is a fixed attribute.</P>
  352. <P>
  353. <H2><A NAME="doctype (expat, name, sysid, pubid, internal)">Doctype        (Expat, Name, Sysid, Pubid, Internal)</A></H2>
  354. <P>This handler is called for DOCTYPE declarations. Name is the document type
  355. name. Sysid is the system id of the document type, if it was provided,
  356. otherwise it's undefined. Pubid is the public id of the document type,
  357. which will be undefined if no public id was given. Internal is the internal
  358. subset, given as a string. If there was no internal subset, it will be
  359. undefined. Internal will contain all whitespace, comments, processing
  360. instructions, and declarations seen in the internal subset. The declarations
  361. will be there whether or not they have been processed by another handler
  362. (except for unparsed entities processed by the Unparsed handler). However,
  363. comments and processing instructions will not appear if they've been processed
  364. by their respective handlers.</P>
  365. <P>
  366. <H2><A NAME="xmldecl (expat, version, encoding, standalone)">XMLDecl        (Expat, Version, Encoding, Standalone)</A></H2>
  367. <P>This handler is called for xml declarations. Version is a string containg
  368. the version. Encoding is either undefined or contains an encoding string.
  369. Standalone will be either true, false, or undefined if the standalone attribute
  370. is yes, no, or not made respectively.</P>
  371. <P>
  372. <HR>
  373. <H1><A NAME="styles">STYLES</A></H1>
  374. <P>
  375. <H2><A NAME="debug">Debug</A></H2>
  376. <P>This just prints out the document in outline form. Nothing special is
  377. returned by parse.</P>
  378. <P>
  379. <H2><A NAME="subs">Subs</A></H2>
  380. <P>Each time an element starts, a sub by that name in the package specified
  381. by the Pkg option is called with the same parameters that the Start
  382. handler gets called with.</P>
  383. <P>Each time an element ends, a sub with that name appended with an underscore
  384. (``_''), is called with the same parameters that the End handler gets called
  385. with.</P>
  386. <P>Nothing special is returned by parse.</P>
  387. <P>
  388. <H2><A NAME="tree">Tree</A></H2>
  389. <P>Parse will return a parse tree for the document. Each node in the tree
  390. takes the form of a tag, content pair. Text nodes are represented with
  391. a pseudo-tag of ``0'' and the string that is their content. For elements,
  392. the content is an array reference. The first item in the array is a
  393. (possibly empty) hash reference containing attributes. The remainder of
  394. the array is a sequence of tag-content pairs representing the content
  395. of the element.</P>
  396. <P>So for example the result of parsing:</P>
  397. <PRE>
  398.   <foo><head id="a">Hello <em>there</em></head><bar>Howdy<ref/></bar>do</foo></PRE>
  399. <P>would be:
  400.              Tag   Content
  401.   ==================================================================
  402.   [foo, [{}, head, [{id => ``a''}, 0, ``Hello '',  em, [{}, 0, ``there'']],
  403.           bar, [         {}, 0, ``Howdy'',  ref, [{}]],
  404.             0, ``do''
  405.     ]
  406.   ]</P>
  407. <P>The root document ``foo'', has 3 children: a ``head'' element, a ``bar''
  408. element and the text ``do''. After the empty attribute hash, these are
  409. represented in it's contents by 3 tag-content pairs.</P>
  410. <P>
  411. <H2><A NAME="objects">Objects</A></H2>
  412. <P>This is similar to the Tree style, except that a hash object is created for
  413. each element. The corresponding object will be in the class whose name
  414. is created by appending ``::'' and the element name to the package set with
  415. the Pkg option. Non-markup text will be in the ::Characters class. The
  416. contents of the corresponding object will be in an anonymous array that
  417. is the value of the Kids property for that object.</P>
  418. <P>
  419. <H2><A NAME="stream">Stream</A></H2>
  420. <P>This style also uses the Pkg package. If none of the subs that this
  421. style looks for is there, then the effect of parsing with this style is
  422. to print a canonical copy of the document without comments or declarations.
  423. All the subs receive as their 1st parameter the Expat instance for the
  424. document they're parsing.</P>
  425. <P>It looks for the following routines:</P>
  426. <UL>
  427. <LI><STRONG><A NAME="item_StartDocument">StartDocument</A></STRONG><BR>
  428.  
  429. Called at the start of the parse .
  430. <P></P>
  431. <LI><STRONG><A NAME="item_StartTag">StartTag</A></STRONG><BR>
  432.  
  433. Called for every start tag with a second parameter of the element type. The $_
  434. variable will contain a copy of the tag and the %_ variable will contain
  435. attribute values supplied for that element.
  436. <P></P>
  437. <LI><STRONG><A NAME="item_EndTag">EndTag</A></STRONG><BR>
  438.  
  439. Called for every end tag with a second parameter of the element type. The $_
  440. variable will contain a copy of the end tag.
  441. <P></P>
  442. <LI><STRONG><A NAME="item_Text">Text</A></STRONG><BR>
  443.  
  444. Called just before start or end tags with accumulated non-markup text in
  445. the $_ variable.
  446. <P></P>
  447. <LI><STRONG><A NAME="item_PI">PI</A></STRONG><BR>
  448.  
  449. Called for processing instructions. The $_ variable will contain a copy of
  450. the PI and the target and data are sent as 2nd and 3rd parameters
  451. respectively.
  452. <P></P>
  453. <LI><STRONG><A NAME="item_EndDocument">EndDocument</A></STRONG><BR>
  454.  
  455. Called at conclusion of the parse.
  456. <P></P></UL>
  457. <P>
  458. <HR>
  459. <H1><A NAME="encodings">ENCODINGS</A></H1>
  460. <P>XML documents may be encoded in character sets other than Unicode as
  461. long as they may be mapped into the Unicode character set. Expat has
  462. further restrictions on encodings. Read the xmlparse.h header file in
  463. the expat distribution to see details on these restrictions.</P>
  464. <P>Expat has built-in encodings for: <CODE>UTF-8</CODE>, <CODE>ISO-8859-1</CODE>, <CODE>UTF-16</CODE>, and
  465. <CODE>US-ASCII</CODE>. Encodings are set either through the XML declaration
  466. encoding attribute or through the ProtocolEncoding option to XML::Parser
  467. or XML::Parser::Expat.</P>
  468. <P>For encodings other than the built-ins, expat calls the function
  469. load_encoding in the Expat package with the encoding name. This function
  470. looks for a file in the path list @XML::Parser::Expat::Encoding_Path, that
  471. matches the lower-cased name with a '.enc' extension. The first one it
  472. finds, it loads.</P>
  473. <P>If you wish to build your own encoding maps, check out the XML::Encoding
  474. module from CPAN.</P>
  475. <P>
  476. <HR>
  477. <H1><A NAME="authors">AUTHORS</A></H1>
  478. <P>Larry Wall <<EM><A HREF="mailto:larry@wall.org">larry@wall.org</A></EM>> wrote version 1.0.</P>
  479. <P>Clark Cooper <<EM><A HREF="mailto:coopercc@netheaven.com">coopercc@netheaven.com</A></EM>> picked up support, changed the API
  480. for this version (2.x), provided documentation,
  481. and added some standard package features.</P>
  482. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  483. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  484. <STRONG><P CLASS=block> XML::Parser - A perl module for parsing XML documents</P></STRONG>
  485. </TD></TR>
  486. </TABLE>
  487.  
  488. </BODY>
  489.  
  490. </HTML>
  491.