source: trunk/packages/libyaml/doc/html/group__basic.html @ 935

Last change on this file since 935 was 898, checked in by hartmans, 16 years ago

Add pyyaml and libyaml packages
backported from lenny.
There is discussion about how these should go in the repository; these are added in this form
in order to make forward progress.

File size: 16.6 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>yaml: Basic Types</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.1 -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="modules.html"><span>Modules</span></a></li>
12    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13    <li><a href="files.html"><span>Files</span></a></li>
14  </ul></div>
15<h1>Basic Types</h1><table border="0" cellpadding="0" cellspacing="0">
16<tr><td></td></tr>
17<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__version__directive__s.html">yaml_version_directive_s</a></td></tr>
19
20<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The version directive data.  <a href="structyaml__version__directive__s.html#_details">More...</a><br></td></tr>
21<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_s</a></td></tr>
22
23<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The tag directive data.  <a href="structyaml__tag__directive__s.html#_details">More...</a><br></td></tr>
24<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__mark__s.html">yaml_mark_s</a></td></tr>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The pointer position.  <a href="structyaml__mark__s.html#_details">More...</a><br></td></tr>
27<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
28<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf8657e81f0b8b05d1a081001fc6cb8bd"></a><!-- doxytag: member="basic::yaml_char_t" ref="gf8657e81f0b8b05d1a081001fc6cb8bd" args="" -->
29typedef unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__basic.html#gf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a></td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The character type (UTF-8 octet). <br></td></tr>
32<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g2fc55608333fbe6df17cf891be709b72"></a><!-- doxytag: member="basic::yaml_version_directive_t" ref="g2fc55608333fbe6df17cf891be709b72" args="" -->
33typedef <a class="el" href="structyaml__version__directive__s.html">yaml_version_directive_s</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__basic.html#g2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a></td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The version directive data. <br></td></tr>
36<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0b4bc4871b0c9104e32d40d5f3803674"></a><!-- doxytag: member="basic::yaml_tag_directive_t" ref="g0b4bc4871b0c9104e32d40d5f3803674" args="" -->
37typedef <a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_s</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__basic.html#g0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a></td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The tag directive data. <br></td></tr>
40<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g2170996d7e636397b5e6bc0c1b7df7c6"></a><!-- doxytag: member="basic::yaml_encoding_t" ref="g2170996d7e636397b5e6bc0c1b7df7c6" args="" -->
41typedef enum <a class="el" href="group__basic.html#gb88ee52b5d722e644c1cb4d1afcccdd9">yaml_encoding_e</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__basic.html#g2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a></td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The stream encoding. <br></td></tr>
44<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g64d1365e1acd4deeab50d6b48e39cb6d"></a><!-- doxytag: member="basic::yaml_break_t" ref="g64d1365e1acd4deeab50d6b48e39cb6d" args="" -->
45typedef enum <a class="el" href="group__basic.html#g912ad8c893126133fab5e4231db3017e">yaml_break_e</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__basic.html#g64d1365e1acd4deeab50d6b48e39cb6d">yaml_break_t</a></td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Line break types. <br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1a449f0c1b023e2ef1a596093c018e73"></a><!-- doxytag: member="basic::yaml_error_type_t" ref="g1a449f0c1b023e2ef1a596093c018e73" args="" -->
49typedef enum <a class="el" href="group__basic.html#g2efbcde2e82238117982b789c5a8ea01">yaml_error_type_e</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__basic.html#g1a449f0c1b023e2ef1a596093c018e73">yaml_error_type_t</a></td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Many bad things could happen with the parser and emitter. <br></td></tr>
52<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g232eacba89691b841ba941338a302bfd"></a><!-- doxytag: member="basic::yaml_mark_t" ref="g232eacba89691b841ba941338a302bfd" args="" -->
53typedef <a class="el" href="structyaml__mark__s.html">yaml_mark_s</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__basic.html#g232eacba89691b841ba941338a302bfd">yaml_mark_t</a></td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The pointer position. <br></td></tr>
56<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
57<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__basic.html#gb88ee52b5d722e644c1cb4d1afcccdd9">yaml_encoding_e</a> { <br>
58&nbsp;&nbsp;<a class="el" href="group__basic.html#ggb88ee52b5d722e644c1cb4d1afcccdd9b61d2a81b8e698e642ce6ad69612fa7f">YAML_ANY_ENCODING</a>,
59<br>
60&nbsp;&nbsp;<a class="el" href="group__basic.html#ggb88ee52b5d722e644c1cb4d1afcccdd95bacbc5e68fc0c25baedf87e3be25a28">YAML_UTF8_ENCODING</a>,
61<br>
62&nbsp;&nbsp;<a class="el" href="group__basic.html#ggb88ee52b5d722e644c1cb4d1afcccdd9c68c68725ec1f6492e59fd388fd123c9">YAML_UTF16LE_ENCODING</a>,
63<br>
64&nbsp;&nbsp;<a class="el" href="group__basic.html#ggb88ee52b5d722e644c1cb4d1afcccdd99f4fcb99a71d3416239f343f1334780b">YAML_UTF16BE_ENCODING</a>
65<br>
66 }</td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The stream encoding.  <a href="group__basic.html#gb88ee52b5d722e644c1cb4d1afcccdd9">More...</a><br></td></tr>
69<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__basic.html#g912ad8c893126133fab5e4231db3017e">yaml_break_e</a> { <br>
70&nbsp;&nbsp;<a class="el" href="group__basic.html#gg912ad8c893126133fab5e4231db3017e052bd56adef565c33a86fcc05b49513f">YAML_ANY_BREAK</a>,
71<br>
72&nbsp;&nbsp;<a class="el" href="group__basic.html#gg912ad8c893126133fab5e4231db3017e116a98ba4ed0bacfdf098a7d5beeb9d4">YAML_CR_BREAK</a>,
73<br>
74&nbsp;&nbsp;<a class="el" href="group__basic.html#gg912ad8c893126133fab5e4231db3017e23bf395462dcd045e22303be6f3f7781">YAML_LN_BREAK</a>,
75<br>
76&nbsp;&nbsp;<a class="el" href="group__basic.html#gg912ad8c893126133fab5e4231db3017e15f8daa406870ebfe82b85781c2468f3">YAML_CRLN_BREAK</a>
77<br>
78 }</td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Line break types.  <a href="group__basic.html#g912ad8c893126133fab5e4231db3017e">More...</a><br></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__basic.html#g2efbcde2e82238117982b789c5a8ea01">yaml_error_type_e</a> { <br>
82&nbsp;&nbsp;<a class="el" href="group__basic.html#gg2efbcde2e82238117982b789c5a8ea0124cadfb5364769959ad8647649d1e86f">YAML_NO_ERROR</a>,
83<br>
84&nbsp;&nbsp;<a class="el" href="group__basic.html#gg2efbcde2e82238117982b789c5a8ea0157be0407d1f344206d9673c9571bde53">YAML_MEMORY_ERROR</a>,
85<br>
86&nbsp;&nbsp;<a class="el" href="group__basic.html#gg2efbcde2e82238117982b789c5a8ea019216f41a453dc36b090cdc1ca9f89637">YAML_READER_ERROR</a>,
87<br>
88&nbsp;&nbsp;<a class="el" href="group__basic.html#gg2efbcde2e82238117982b789c5a8ea016f8d865d9a25b385146660d8260d3d6f">YAML_SCANNER_ERROR</a>,
89<br>
90&nbsp;&nbsp;<a class="el" href="group__basic.html#gg2efbcde2e82238117982b789c5a8ea010e12c79d8586bc61470e3088b666078b">YAML_PARSER_ERROR</a>,
91<br>
92&nbsp;&nbsp;<a class="el" href="group__basic.html#gg2efbcde2e82238117982b789c5a8ea0143d6eb640e50a1b1ec843cc54ab15f2b">YAML_COMPOSER_ERROR</a>,
93<br>
94&nbsp;&nbsp;<a class="el" href="group__basic.html#gg2efbcde2e82238117982b789c5a8ea01e80fef003be3d7e72ed7acae7984004c">YAML_WRITER_ERROR</a>,
95<br>
96&nbsp;&nbsp;<a class="el" href="group__basic.html#gg2efbcde2e82238117982b789c5a8ea018ec99a26382dd2853a5550027f6e9db1">YAML_EMITTER_ERROR</a>
97<br>
98 }</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Many bad things could happen with the parser and emitter.  <a href="group__basic.html#g2efbcde2e82238117982b789c5a8ea01">More...</a><br></td></tr>
101</table>
102<hr><h2>Enumeration Type Documentation</h2>
103<a class="anchor" name="gb88ee52b5d722e644c1cb4d1afcccdd9"></a><!-- doxytag: member="yaml.h::yaml_encoding_e" ref="gb88ee52b5d722e644c1cb4d1afcccdd9" args="" -->
104<div class="memitem">
105<div class="memproto">
106      <table class="memname">
107        <tr>
108          <td class="memname">enum <a class="el" href="group__basic.html#gb88ee52b5d722e644c1cb4d1afcccdd9">yaml_encoding_e</a>          </td>
109        </tr>
110      </table>
111</div>
112<div class="memdoc">
113
114<p>
115The stream encoding.
116<p>
117<dl compact><dt><b>Enumerator: </b></dt><dd>
118<table border="0" cellspacing="2" cellpadding="0">
119<tr><td valign="top"><em><a class="anchor" name="ggb88ee52b5d722e644c1cb4d1afcccdd9b61d2a81b8e698e642ce6ad69612fa7f"></a><!-- doxytag: member="YAML_ANY_ENCODING" ref="ggb88ee52b5d722e644c1cb4d1afcccdd9b61d2a81b8e698e642ce6ad69612fa7f" args="" -->YAML_ANY_ENCODING</em>&nbsp;</td><td>
120Let the parser choose the encoding. </td></tr>
121<tr><td valign="top"><em><a class="anchor" name="ggb88ee52b5d722e644c1cb4d1afcccdd95bacbc5e68fc0c25baedf87e3be25a28"></a><!-- doxytag: member="YAML_UTF8_ENCODING" ref="ggb88ee52b5d722e644c1cb4d1afcccdd95bacbc5e68fc0c25baedf87e3be25a28" args="" -->YAML_UTF8_ENCODING</em>&nbsp;</td><td>
122The default UTF-8 encoding. </td></tr>
123<tr><td valign="top"><em><a class="anchor" name="ggb88ee52b5d722e644c1cb4d1afcccdd9c68c68725ec1f6492e59fd388fd123c9"></a><!-- doxytag: member="YAML_UTF16LE_ENCODING" ref="ggb88ee52b5d722e644c1cb4d1afcccdd9c68c68725ec1f6492e59fd388fd123c9" args="" -->YAML_UTF16LE_ENCODING</em>&nbsp;</td><td>
124The UTF-16-LE encoding with BOM. </td></tr>
125<tr><td valign="top"><em><a class="anchor" name="ggb88ee52b5d722e644c1cb4d1afcccdd99f4fcb99a71d3416239f343f1334780b"></a><!-- doxytag: member="YAML_UTF16BE_ENCODING" ref="ggb88ee52b5d722e644c1cb4d1afcccdd99f4fcb99a71d3416239f343f1334780b" args="" -->YAML_UTF16BE_ENCODING</em>&nbsp;</td><td>
126The UTF-16-BE encoding with BOM. </td></tr>
127</table>
128</dl>
129
130</div>
131</div><p>
132<a class="anchor" name="g912ad8c893126133fab5e4231db3017e"></a><!-- doxytag: member="yaml.h::yaml_break_e" ref="g912ad8c893126133fab5e4231db3017e" args="" -->
133<div class="memitem">
134<div class="memproto">
135      <table class="memname">
136        <tr>
137          <td class="memname">enum <a class="el" href="group__basic.html#g912ad8c893126133fab5e4231db3017e">yaml_break_e</a>          </td>
138        </tr>
139      </table>
140</div>
141<div class="memdoc">
142
143<p>
144Line break types.
145<p>
146<dl compact><dt><b>Enumerator: </b></dt><dd>
147<table border="0" cellspacing="2" cellpadding="0">
148<tr><td valign="top"><em><a class="anchor" name="gg912ad8c893126133fab5e4231db3017e052bd56adef565c33a86fcc05b49513f"></a><!-- doxytag: member="YAML_ANY_BREAK" ref="gg912ad8c893126133fab5e4231db3017e052bd56adef565c33a86fcc05b49513f" args="" -->YAML_ANY_BREAK</em>&nbsp;</td><td>
149Let the parser choose the break type. </td></tr>
150<tr><td valign="top"><em><a class="anchor" name="gg912ad8c893126133fab5e4231db3017e116a98ba4ed0bacfdf098a7d5beeb9d4"></a><!-- doxytag: member="YAML_CR_BREAK" ref="gg912ad8c893126133fab5e4231db3017e116a98ba4ed0bacfdf098a7d5beeb9d4" args="" -->YAML_CR_BREAK</em>&nbsp;</td><td>
151Use CR for line breaks (Mac style). </td></tr>
152<tr><td valign="top"><em><a class="anchor" name="gg912ad8c893126133fab5e4231db3017e23bf395462dcd045e22303be6f3f7781"></a><!-- doxytag: member="YAML_LN_BREAK" ref="gg912ad8c893126133fab5e4231db3017e23bf395462dcd045e22303be6f3f7781" args="" -->YAML_LN_BREAK</em>&nbsp;</td><td>
153Use LN for line breaks (Unix style). </td></tr>
154<tr><td valign="top"><em><a class="anchor" name="gg912ad8c893126133fab5e4231db3017e15f8daa406870ebfe82b85781c2468f3"></a><!-- doxytag: member="YAML_CRLN_BREAK" ref="gg912ad8c893126133fab5e4231db3017e15f8daa406870ebfe82b85781c2468f3" args="" -->YAML_CRLN_BREAK</em>&nbsp;</td><td>
155Use CR LN for line breaks (DOS style). </td></tr>
156</table>
157</dl>
158
159</div>
160</div><p>
161<a class="anchor" name="g2efbcde2e82238117982b789c5a8ea01"></a><!-- doxytag: member="yaml.h::yaml_error_type_e" ref="g2efbcde2e82238117982b789c5a8ea01" args="" -->
162<div class="memitem">
163<div class="memproto">
164      <table class="memname">
165        <tr>
166          <td class="memname">enum <a class="el" href="group__basic.html#g2efbcde2e82238117982b789c5a8ea01">yaml_error_type_e</a>          </td>
167        </tr>
168      </table>
169</div>
170<div class="memdoc">
171
172<p>
173Many bad things could happen with the parser and emitter.
174<p>
175<dl compact><dt><b>Enumerator: </b></dt><dd>
176<table border="0" cellspacing="2" cellpadding="0">
177<tr><td valign="top"><em><a class="anchor" name="gg2efbcde2e82238117982b789c5a8ea0124cadfb5364769959ad8647649d1e86f"></a><!-- doxytag: member="YAML_NO_ERROR" ref="gg2efbcde2e82238117982b789c5a8ea0124cadfb5364769959ad8647649d1e86f" args="" -->YAML_NO_ERROR</em>&nbsp;</td><td>
178No error is produced. </td></tr>
179<tr><td valign="top"><em><a class="anchor" name="gg2efbcde2e82238117982b789c5a8ea0157be0407d1f344206d9673c9571bde53"></a><!-- doxytag: member="YAML_MEMORY_ERROR" ref="gg2efbcde2e82238117982b789c5a8ea0157be0407d1f344206d9673c9571bde53" args="" -->YAML_MEMORY_ERROR</em>&nbsp;</td><td>
180Cannot allocate or reallocate a block of memory. </td></tr>
181<tr><td valign="top"><em><a class="anchor" name="gg2efbcde2e82238117982b789c5a8ea019216f41a453dc36b090cdc1ca9f89637"></a><!-- doxytag: member="YAML_READER_ERROR" ref="gg2efbcde2e82238117982b789c5a8ea019216f41a453dc36b090cdc1ca9f89637" args="" -->YAML_READER_ERROR</em>&nbsp;</td><td>
182Cannot read or decode the input stream. </td></tr>
183<tr><td valign="top"><em><a class="anchor" name="gg2efbcde2e82238117982b789c5a8ea016f8d865d9a25b385146660d8260d3d6f"></a><!-- doxytag: member="YAML_SCANNER_ERROR" ref="gg2efbcde2e82238117982b789c5a8ea016f8d865d9a25b385146660d8260d3d6f" args="" -->YAML_SCANNER_ERROR</em>&nbsp;</td><td>
184Cannot scan the input stream. </td></tr>
185<tr><td valign="top"><em><a class="anchor" name="gg2efbcde2e82238117982b789c5a8ea010e12c79d8586bc61470e3088b666078b"></a><!-- doxytag: member="YAML_PARSER_ERROR" ref="gg2efbcde2e82238117982b789c5a8ea010e12c79d8586bc61470e3088b666078b" args="" -->YAML_PARSER_ERROR</em>&nbsp;</td><td>
186Cannot parse the input stream. </td></tr>
187<tr><td valign="top"><em><a class="anchor" name="gg2efbcde2e82238117982b789c5a8ea0143d6eb640e50a1b1ec843cc54ab15f2b"></a><!-- doxytag: member="YAML_COMPOSER_ERROR" ref="gg2efbcde2e82238117982b789c5a8ea0143d6eb640e50a1b1ec843cc54ab15f2b" args="" -->YAML_COMPOSER_ERROR</em>&nbsp;</td><td>
188Cannot compose a YAML document. </td></tr>
189<tr><td valign="top"><em><a class="anchor" name="gg2efbcde2e82238117982b789c5a8ea01e80fef003be3d7e72ed7acae7984004c"></a><!-- doxytag: member="YAML_WRITER_ERROR" ref="gg2efbcde2e82238117982b789c5a8ea01e80fef003be3d7e72ed7acae7984004c" args="" -->YAML_WRITER_ERROR</em>&nbsp;</td><td>
190Cannot write to the output stream. </td></tr>
191<tr><td valign="top"><em><a class="anchor" name="gg2efbcde2e82238117982b789c5a8ea018ec99a26382dd2853a5550027f6e9db1"></a><!-- doxytag: member="YAML_EMITTER_ERROR" ref="gg2efbcde2e82238117982b789c5a8ea018ec99a26382dd2853a5550027f6e9db1" args="" -->YAML_EMITTER_ERROR</em>&nbsp;</td><td>
192Cannot emit a YAML stream. </td></tr>
193</table>
194</dl>
195
196</div>
197</div><p>
198<hr size="1"><address style="align: right;"><small>Generated on Thu May 31 22:50:59 2007 for yaml by&nbsp;
199<a href="http://www.doxygen.org/index.html">
200<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
201</body>
202</html>
Note: See TracBrowser for help on using the repository browser.