wxExtend/xml_8h_source.html

192 lines
19 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wxExtend: include/wxex/xml.h Source File</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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectrow">
<td id="projectalign">
<div id="projectname">wxExtend
</div>
<div id="projectbrief">Additional templates and function helpers for wxWidgets</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_2fafa5ce03815a2bdea8d271fa718211.html">wxex</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">xml.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> SPDX-License-Identifier: GPL-3.0-or-later</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> Copyright © 2016-2022 Amebis</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright © 2016 GÉANT</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">*/</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;common.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &quot;crypto.h&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include &lt;codeanalysis\warnings.h&gt;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#pragma warning(push)</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#pragma warning(disable: WXWIDGETS_CODE_ANALYSIS_WARNINGS)</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include &lt;wx/string.h&gt;</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &lt;wx/xml/xml.h&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#pragma warning(pop)</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="foldopen" id="foldopen00029" data-start="{" data-end="}">
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="group__wx_extend.html#ga2df1fb125c80cc34345704c395fa98d2"> 29</a></span><span class="keyword">inline</span> wxString <a class="code hl_function" href="group__wx_extend.html#ga2df1fb125c80cc34345704c395fa98d2">wxXmlEscapeText</a>(_In_ <span class="keyword">const</span> wxString&amp; str)</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span>{</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> wxString escaped;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> escaped.reserve(str.length());</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordflow">for</span> (<span class="keyword">auto</span> i = str.begin(); i != str.end(); ++i) {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">const</span> wxChar c = *i;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordflow">switch</span> (c) {</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordflow">case</span> wxS(<span class="charliteral">&#39;&lt;&#39;</span>):</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> escaped.append(wxS(<span class="stringliteral">&quot;&amp;lt;&quot;</span>));</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordflow">case</span> wxS(<span class="charliteral">&#39;&gt;&#39;</span>):</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> escaped.append(wxS(<span class="stringliteral">&quot;&amp;gt;&quot;</span>));</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordflow">case</span> wxS(<span class="charliteral">&#39;&amp;&#39;</span>):</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> escaped.append(wxS(<span class="stringliteral">&quot;&amp;amp;&quot;</span>));</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordflow">case</span> wxS(<span class="charliteral">&#39;\r&#39;</span>):</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> escaped.append(wxS(<span class="stringliteral">&quot;&amp;#xD;&quot;</span>));</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordflow">default</span>:</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> escaped.append(c);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> }</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> }</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordflow">return</span> escaped;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>}</div>
</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="foldopen" id="foldopen00065" data-start="{" data-end="}">
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="group__wx_extend.html#ga0a5fe49ff679628c97dfb29140f39eb7"> 65</a></span><span class="keyword">inline</span> wxString <a class="code hl_function" href="group__wx_extend.html#ga0a5fe49ff679628c97dfb29140f39eb7">wxXmlEscapeAttr</a>(_In_ <span class="keyword">const</span> wxString&amp; str)</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span>{</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> wxString escaped;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> escaped.reserve(str.length());</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordflow">for</span> (<span class="keyword">auto</span> i = str.begin(); i != str.end(); ++i) {</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">const</span> wxChar c = *i;</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keywordflow">switch</span> (c) {</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keywordflow">case</span> wxS(<span class="charliteral">&#39;&lt;&#39;</span>):</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> escaped.append(wxS(<span class="stringliteral">&quot;&amp;lt;&quot;</span>));</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keywordflow">case</span> wxS(<span class="charliteral">&#39;&gt;&#39;</span>):</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> escaped.append(wxS(<span class="stringliteral">&quot;&amp;gt;&quot;</span>));</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keywordflow">case</span> wxS(<span class="charliteral">&#39;&amp;&#39;</span>):</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> escaped.append(wxS(<span class="stringliteral">&quot;&amp;amp;&quot;</span>));</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keywordflow">case</span> wxS(<span class="charliteral">&#39;\r&#39;</span>):</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> escaped.append(wxS(<span class="stringliteral">&quot;&amp;#xD;&quot;</span>));</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="keywordflow">case</span> wxS(<span class="charliteral">&#39;&quot;&#39;</span>):</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> escaped.append(wxS(<span class="stringliteral">&quot;&amp;quot;&quot;</span>));</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordflow">case</span> wxS(<span class="charliteral">&#39;\t&#39;</span>):</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> escaped.append(wxS(<span class="stringliteral">&quot;&amp;#x9;&quot;</span>));</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="keywordflow">case</span> wxS(<span class="charliteral">&#39;\n&#39;</span>):</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> escaped.append(wxS(<span class="stringliteral">&quot;&amp;#xA;&quot;</span>));</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keywordflow">default</span>:</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> escaped.append(c);</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> }</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> }</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keywordflow">return</span> escaped;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span>}</div>
</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="keywordtype">bool</span> <a class="code hl_define" href="group__wx_extend.html#ga624ae3515d39396935a077c6cc0a4d64">WXEXTEND_API</a> <a class="code hl_function" href="group__wx_extend.html#ga50d87745169578f671751e6a3b62c829">wxXmlHashNode</a>(_In_ <a class="code hl_class" href="classwx_crypto_hash.html">wxCryptoHash</a> &amp;hash, _In_ <span class="keyword">const</span> wxXmlNode *node);</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
<div class="ttc" id="aclasswx_crypto_hash_html"><div class="ttname"><a href="classwx_crypto_hash.html">wxCryptoHash</a></div><div class="ttdoc">Cryptographics Hash Base.</div><div class="ttdef"><b>Definition</b> crypto.h:86</div></div>
<div class="ttc" id="agroup__wx_extend_html_ga0a5fe49ff679628c97dfb29140f39eb7"><div class="ttname"><a href="group__wx_extend.html#ga0a5fe49ff679628c97dfb29140f39eb7">wxXmlEscapeAttr</a></div><div class="ttdeci">wxString wxXmlEscapeAttr(const wxString &amp;str)</div><div class="ttdoc">Escapes attribute value string for XML insertion.</div><div class="ttdef"><b>Definition</b> xml.h:65</div></div>
<div class="ttc" id="agroup__wx_extend_html_ga2df1fb125c80cc34345704c395fa98d2"><div class="ttname"><a href="group__wx_extend.html#ga2df1fb125c80cc34345704c395fa98d2">wxXmlEscapeText</a></div><div class="ttdeci">wxString wxXmlEscapeText(const wxString &amp;str)</div><div class="ttdoc">Escapes text string for XML insertion.</div><div class="ttdef"><b>Definition</b> xml.h:29</div></div>
<div class="ttc" id="agroup__wx_extend_html_ga50d87745169578f671751e6a3b62c829"><div class="ttname"><a href="group__wx_extend.html#ga50d87745169578f671751e6a3b62c829">wxXmlHashNode</a></div><div class="ttdeci">bool WXEXTEND_API wxXmlHashNode(wxCryptoHash &amp;hash, const wxXmlNode *node)</div><div class="ttdoc">Calculates hash of the node and all its children.</div><div class="ttdef"><b>Definition</b> xml.cpp:11</div></div>
<div class="ttc" id="agroup__wx_extend_html_ga624ae3515d39396935a077c6cc0a4d64"><div class="ttname"><a href="group__wx_extend.html#ga624ae3515d39396935a077c6cc0a4d64">WXEXTEND_API</a></div><div class="ttdeci">#define WXEXTEND_API</div><div class="ttdoc">Public function calling convention.</div><div class="ttdef"><b>Definition</b> common.h:56</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Mar 11 2024 14:56:54 for wxExtend by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>