1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.7"/>
<title>glibmm: Simple XML Subset Parser</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">glibmm
 <span id="projectnumber">2.42.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enumval-members">Enumerator</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Simple XML Subset Parser</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="namespaceGlib_1_1Markup.html">Glib::Markup</a> parser is intended to parse a simple markup format that's a subset of XML.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MarkupError.html">Glib::MarkupError</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Exception class for markup parsing errors. <a href="classGlib_1_1MarkupError.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Markup_1_1AttributeKeyLess.html">Glib::Markup::AttributeKeyLess</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Binary predicate used by <a class="el" href="classGlib_1_1Markup_1_1Parser.html#a65bc2af877b64b3077f8635ef81213dc">Markup::Parser::AttributeMap</a>. <a href="classGlib_1_1Markup_1_1AttributeKeyLess.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Markup_1_1Parser.html">Glib::Markup::Parser</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The abstract markup parser base class. <a href="classGlib_1_1Markup_1_1Parser.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Markup_1_1ParseContext.html">Glib::Markup::ParseContext</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A parse context is used to parse marked-up documents. <a href="classGlib_1_1Markup_1_1ParseContext.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga7d0403c76601e7d3ba4641737e094e77"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classGlib_1_1MarkupError.html">Glib::MarkupError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Markup.html#ga7d0403c76601e7d3ba4641737e094e77">Glib::Markup::Error</a></td></tr>
<tr class="separator:ga7d0403c76601e7d3ba4641737e094e77"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gac95c5843d8dada8449f90f2fd635feb1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Markup.html#gac95c5843d8dada8449f90f2fd635feb1">Glib::Markup::escape_text</a> (const <a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a>& text)</td></tr>
<tr class="memdesc:gac95c5843d8dada8449f90f2fd635feb1"><td class="mdescLeft"> </td><td class="mdescRight">Escapes text so that the markup parser will parse it verbatim. <a href="#gac95c5843d8dada8449f90f2fd635feb1">More...</a><br /></td></tr>
<tr class="separator:gac95c5843d8dada8449f90f2fd635feb1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The <a class="el" href="namespaceGlib_1_1Markup.html">Glib::Markup</a> parser is intended to parse a simple markup format that's a subset of XML. </p>
<p>This is a small, efficient, easy-to-use parser. It should not be used if you expect to interoperate with other applications generating full-scale XML. However, it's very useful for application data files, config files, etc. where you know your application will be the only one writing the file. Full-scale XML parsers should be able to parse the subset used by <a class="el" href="namespaceGlib_1_1Markup.html">Glib::Markup</a> parser, so you can easily migrate to full-scale XML at a later time if the need arises.</p>
<p><a class="el" href="namespaceGlib_1_1Markup.html">Glib::Markup</a> is not guaranteed to signal an error on all invalid XML; the parser may accept documents that an XML parser would not. However, invalid XML documents are not considered valid <a class="el" href="namespaceGlib_1_1Markup.html">Glib::Markup</a> documents.</p>
<dl class="section user"><dt>Simplifications to XML include:</dt><dd></dd></dl>
<ul>
<li>Only UTF-8 encoding is allowed.</li>
<li>No user-defined entities.</li>
<li>Processing instructions, comments and the doctype declaration are "passed
through" but are not interpreted in any way.</li>
<li>No DTD or validation.</li>
</ul>
<dl class="section user"><dt>The markup format does support:</dt><dd></dd></dl>
<ul>
<li>Elements</li>
<li>Attributes</li>
<li>5 standard entities: <code>&amp; &lt; &gt; &quot; &apos;</code></li>
<li>Character references</li>
<li>Sections marked as <code>CDATA</code> </li>
</ul>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga7d0403c76601e7d3ba4641737e094e77"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classGlib_1_1MarkupError.html">Glib::MarkupError</a> <a class="el" href="group__Markup.html#ga7d0403c76601e7d3ba4641737e094e77">Glib::Markup::Error</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gac95c5843d8dada8449f90f2fd635feb1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a> Glib::Markup::escape_text </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a>& </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Escapes text so that the markup parser will parse it verbatim. </p>
<p>Less than, greater than, ampersand, etc. are replaced with the corresponding entities. This function would typically be used when writing out a file to be parsed with the markup parser.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>Some valid UTF-8 text. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Escaped text. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Sep 22 2014 21:38:30 for glibmm by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.7
</small></address>
</body>
</html>
|
