exml/internal_2_comment_8hpp_source.html
2016-10-23 21:18:24 +02:00

171 lines
22 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!-- HTML header for doxygen 1.8.8-->
<!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="X-UA-Compatible" content="IE=edge">
<!-- For Mobile Devices -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<title>exml: Ewol XML parser: framework/atria-soft/exml/exml/internal/Comment.hpp Source File</title>
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
<script type="text/javascript" src="dynsections.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" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
<script type="text/javascript" src="doxy-boot.js"></script>
</head>
<body>
<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand">exml: Ewol XML parser 0.7.0</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="index.html">Main&nbsp;Page</a></li>
<li><a href="pages.html">Related&nbsp;Pages</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="annotated.html">Classes</a></li>
<li><a href="files.html">Files</a></li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
Link-libs<span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="http://HeeroYui.github.io/lutin">lutin</a></li>
<li><a href="http://atria-soft.github.io/ewol">ewol</a></li>
<li><a href="http://atria-soft.github.io/etk">etk</a></li>
<li><a href="http://atria-soft.github.io/ejson">ejson</a></li>
<li><a href="http://atria-soft.github.io/exml">exml</a></li>
<li><a href="http://atria-soft.github.io/esvg">esvg</a></li>
<li><a href="http://atria-soft.github.io/egami">egami</a></li>
<li><a href="http://atria-soft.github.io/gale">gale</a></li>
<li><a href="http://atria-soft.github.io/ege">ege</a></li>
<li><a href="http://atria-soft.github.io/elog">elog</a></li>
<li><a href="http://atria-soft.github.io/ememory">ememory</a></li>
<li><a href="http://atria-soft.github.io/enet">enet</a></li>
<li><a href="http://atria-soft.github.io/eproperty">eproperty</a></li>
<li><a href="http://atria-soft.github.io/esignal">esignal</a></li>
<li><a href="http://atria-soft.github.io/zeus">zeus</a></li>
<li><a href="http://atria-soft.github.io/audio-ess">audio-ess</a></li>
<li><a href="http://musicdsp.github.io/audio">audio</a></li>
<li><a href="http://musicdsp.github.io/audio-drain">audio-drain</a></li>
<li><a href="http://musicdsp.github.io/audio-orchestra">audio-orchestra</a></li>
<li><a href="http://musicdsp.github.io/audio-river">audio-river</a></li>
</ul>
</li>
</ul>
<div id="search-box" class="input-group">
<div class="input-group-btn">
<button aria-expanded="false" type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
<span class="glyphicon glyphicon-search"></span>
<span class="caret"></span>
</button>
<ul class="dropdown-menu">
<li><a href="#">All</a></li>
<li><a href="#">Classes</a></li>
<li><a href="#">Namespaces</a></li>
<li><a href="#">Files</a></li>
<li><a href="#">Functions</a></li>
<li><a href="#">Variables</a></li>
<li><a href="#">Typedefs</a></li>
<li><a href="#">Enumerations</a></li>
<li><a href="#">Enumerator</a></li>
<li><a href="#">Friends</a></li>
<li><a href="#">Macros</a></li>
<li><a href="#">Pages</a></li>
</ul>
</div>
<button id="search-close" type="button" class="close" aria-label="Close">
<span aria-hidden="true"></span>
</button>
<input id="search-field" class="form-control" accesskey="S" onkeydown="searchBox.OnSearchFieldChange(event);" placeholder="Search ..." type="text">
</div>
</div><!--/.nav-collapse -->
</div>
</nav>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div class="content" id="content">
<div class="container">
<div class="row">
<div class="col-sm-12 panel panel-default" style="padding-bottom: 15px;">
<div style="margin-bottom: 15px;">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_644e041c3a6521da7b27eba0e4eb2b95.html">framework</a></li><li class="navelem"><a class="el" href="dir_a094892b17be858f66bf3446bbb755c7.html">atria-soft</a></li><li class="navelem"><a class="el" href="dir_ae358d914b1fb7d675ed883237a889f5.html">exml</a></li><li class="navelem"><a class="el" href="dir_e0e5ae444ddef5927e74f7409f56d38c.html">exml</a></li><li class="navelem"><a class="el" href="dir_aa537408b4b3694bd6c43d048d5a57b8.html">internal</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Comment.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="internal_2_comment_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="internal_2_node_8hpp.html">exml/internal/Node.hpp</a>&gt;</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceexml.html">exml</a> {</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; <span class="keyword">namespace </span>internal {</div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classexml_1_1internal_1_1_comment.html"> 16</a></span>&#160; <span class="keyword">class </span><a class="code" href="classexml_1_1internal_1_1_comment.html">Comment</a> : <span class="keyword">public</span> <a class="code" href="classexml_1_1internal_1_1_node.html">exml::internal::Node</a> {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">static</span> <a class="codeRef" doxygen="/home/heero/dev/perso/out/doc/release/ememory.tag:http://atria-soft.github.io/ememory/" href="http://atria-soft.github.io/ememory/classememory_1_1_shared_ptr.html">ememory::SharedPtr&lt;exml::internal::Comment&gt;</a> <a class="code" href="classexml_1_1internal_1_1_comment.html#a410b4fb619920d368735ac0cd89dafa6">create</a>(<span class="keyword">const</span> std::string&amp; _value=<span class="stringliteral">&quot;&quot;</span>);</div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classexml_1_1internal_1_1_comment.html#a39ce9bd4d20ff55309b8910ab016a67c"> 28</a></span>&#160; <a class="code" href="classexml_1_1internal_1_1_comment.html#a39ce9bd4d20ff55309b8910ab016a67c">Comment</a>(<span class="keyword">const</span> std::string&amp; _value) :</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <a class="code" href="namespaceexml.html">exml</a>::internal::<a class="code" href="classexml_1_1internal_1_1_node.html">Node</a>(_value) {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; }</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classexml_1_1internal_1_1_comment.html#a3c3de1b1577bb9dbc50940589b21b780"> 33</a></span>&#160; <span class="keyword">enum</span> <a class="code" href="namespaceexml.html#a49be10c1d94fea7f1fe579e5ec041e55">nodeType</a> <a class="code" href="classexml_1_1internal_1_1_comment.html#a3c3de1b1577bb9dbc50940589b21b780">getType</a>()<span class="keyword"> const override </span>{</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">return</span> <a class="code" href="namespaceexml.html#a49be10c1d94fea7f1fe579e5ec041e55a06d4cd63bde972fc66a0aed41d2f5c51">nodeType::comment</a>;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; }</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classexml_1_1internal_1_1_comment.html#aa606a5e28625fac957e78f71940c2391">iParse</a>(<span class="keyword">const</span> std::string&amp; _data, int32_t&amp; _pos, <span class="keywordtype">bool</span> _caseSensitive, <a class="code" href="classexml_1_1_file_pos.html">exml::FilePos</a>&amp; _filePos, <a class="code" href="classexml_1_1internal_1_1_document.html">exml::internal::Document</a>&amp; _doc) <span class="keyword">override</span>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classexml_1_1internal_1_1_comment.html#a1ec817987fa13ae9862b7096176bb1e6">iGenerate</a>(std::string&amp; _data, int32_t _indent) <span class="keyword">const override</span>;</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classexml_1_1internal_1_1_comment.html#a6279c3670d1e7b338b929b14fc10f0dd"> 38</a></span>&#160; <a class="codeRef" doxygen="/home/heero/dev/perso/out/doc/release/ememory.tag:http://atria-soft.github.io/ememory/" href="http://atria-soft.github.io/ememory/classememory_1_1_shared_ptr.html">ememory::SharedPtr&lt;exml::internal::Comment&gt;</a> <a class="code" href="classexml_1_1internal_1_1_comment.html#a6279c3670d1e7b338b929b14fc10f0dd">toComment</a>()<span class="keyword"> override </span>{</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordflow">return</span> ememory::staticPointerCast&lt;exml::internal::Comment&gt;(<a class="codeRef" doxygen="/home/heero/dev/perso/out/doc/release/ememory.tag:http://atria-soft.github.io/ememory/" href="http://atria-soft.github.io/ememory/classememory_1_1_enable_shared_from_this.html#ab9c576f893c44cbf8163b1ddf6f86b38">sharedFromThis</a>());</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; }</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classexml_1_1internal_1_1_comment.html#ade5a7c40fda74c5c86972ba8c0186dd7"> 41</a></span>&#160; <span class="keyword">const</span> <a class="codeRef" doxygen="/home/heero/dev/perso/out/doc/release/ememory.tag:http://atria-soft.github.io/ememory/" href="http://atria-soft.github.io/ememory/classememory_1_1_shared_ptr.html">ememory::SharedPtr&lt;exml::internal::Comment&gt;</a> <a class="code" href="classexml_1_1internal_1_1_comment.html#ade5a7c40fda74c5c86972ba8c0186dd7">toComment</a>()<span class="keyword"> const override </span>{</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">return</span> ememory::staticPointerCast&lt;exml::internal::Comment&gt;(<a class="codeRef" doxygen="/home/heero/dev/perso/out/doc/release/ememory.tag:http://atria-soft.github.io/ememory/" href="http://atria-soft.github.io/ememory/classememory_1_1_enable_shared_from_this.html#ab9c576f893c44cbf8163b1ddf6f86b38">sharedFromThis</a>());</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; }</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; };</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; }</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;}</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="ttc" id="internal_2_node_8hpp_html"><div class="ttname"><a href="internal_2_node_8hpp.html">Node.hpp</a></div></div>
<div class="ttc" id="classememory_1_1_enable_shared_from_this_html_ab9c576f893c44cbf8163b1ddf6f86b38"><div class="ttname"><a href="http://atria-soft.github.io/ememory/classememory_1_1_enable_shared_from_this.html#ab9c576f893c44cbf8163b1ddf6f86b38">ememory::EnableSharedFromThis&lt; Node &gt;::sharedFromThis</a></div><div class="ttdeci">ememory::SharedPtr&lt; EMEMORY_TYPE &gt; sharedFromThis()</div></div>
<div class="ttc" id="classexml_1_1internal_1_1_comment_html_a39ce9bd4d20ff55309b8910ab016a67c"><div class="ttname"><a href="classexml_1_1internal_1_1_comment.html#a39ce9bd4d20ff55309b8910ab016a67c">exml::internal::Comment::Comment</a></div><div class="ttdeci">Comment(const std::string &amp;_value)</div><div class="ttdoc">Constructor. </div><div class="ttdef"><b>Definition:</b> Comment.hpp:28</div></div>
<div class="ttc" id="classexml_1_1internal_1_1_comment_html_a1ec817987fa13ae9862b7096176bb1e6"><div class="ttname"><a href="classexml_1_1internal_1_1_comment.html#a1ec817987fa13ae9862b7096176bb1e6">exml::internal::Comment::iGenerate</a></div><div class="ttdeci">bool iGenerate(std::string &amp;_data, int32_t _indent) const override</div><div class="ttdoc">generate a string with the tree of the xml </div></div>
<div class="ttc" id="classexml_1_1internal_1_1_comment_html_a6279c3670d1e7b338b929b14fc10f0dd"><div class="ttname"><a href="classexml_1_1internal_1_1_comment.html#a6279c3670d1e7b338b929b14fc10f0dd">exml::internal::Comment::toComment</a></div><div class="ttdeci">ememory::SharedPtr&lt; exml::internal::Comment &gt; toComment() override</div><div class="ttdoc">Cast the element in a Comment if it is possible. </div><div class="ttdef"><b>Definition:</b> Comment.hpp:38</div></div>
<div class="ttc" id="namespaceexml_html"><div class="ttname"><a href="namespaceexml.html">exml</a></div><div class="ttdoc">exml namespace containing all function for XML interpretor </div><div class="ttdef"><b>Definition:</b> Attribute.hpp:11</div></div>
<div class="ttc" id="classexml_1_1internal_1_1_document_html"><div class="ttname"><a href="classexml_1_1internal_1_1_document.html">exml::internal::Document</a></div><div class="ttdoc">Basic document element of a document. </div><div class="ttdef"><b>Definition:</b> Document.hpp:16</div></div>
<div class="ttc" id="classexml_1_1internal_1_1_comment_html_aa606a5e28625fac957e78f71940c2391"><div class="ttname"><a href="classexml_1_1internal_1_1_comment.html#aa606a5e28625fac957e78f71940c2391">exml::internal::Comment::iParse</a></div><div class="ttdeci">bool iParse(const std::string &amp;_data, int32_t &amp;_pos, bool _caseSensitive, exml::FilePos &amp;_filePos, exml::internal::Document &amp;_doc) override</div><div class="ttdoc">parse the Current node [pure VIRUAL] </div></div>
<div class="ttc" id="classexml_1_1_file_pos_html"><div class="ttname"><a href="classexml_1_1_file_pos.html">exml::FilePos</a></div><div class="ttdoc">Position in the file of the original data. </div><div class="ttdef"><b>Definition:</b> FilePos.hpp:14</div></div>
<div class="ttc" id="classexml_1_1internal_1_1_comment_html_ade5a7c40fda74c5c86972ba8c0186dd7"><div class="ttname"><a href="classexml_1_1internal_1_1_comment.html#ade5a7c40fda74c5c86972ba8c0186dd7">exml::internal::Comment::toComment</a></div><div class="ttdeci">const ememory::SharedPtr&lt; exml::internal::Comment &gt; toComment() const override</div><div class="ttdoc">Cast the element in a Comment if it is possible. </div><div class="ttdef"><b>Definition:</b> Comment.hpp:41</div></div>
<div class="ttc" id="classexml_1_1internal_1_1_node_html"><div class="ttname"><a href="classexml_1_1internal_1_1_node.html">exml::internal::Node</a></div><div class="ttdoc">Basic main object of all xml elements. </div><div class="ttdef"><b>Definition:</b> Node.hpp:43</div></div>
<div class="ttc" id="namespaceexml_html_a49be10c1d94fea7f1fe579e5ec041e55a06d4cd63bde972fc66a0aed41d2f5c51"><div class="ttname"><a href="namespaceexml.html#a49be10c1d94fea7f1fe579e5ec041e55a06d4cd63bde972fc66a0aed41d2f5c51">exml::nodeType::comment</a></div><div class="ttdoc">comment node : &lt;! &gt; </div></div>
<div class="ttc" id="classememory_1_1_shared_ptr_html"><div class="ttname"><a href="http://atria-soft.github.io/ememory/classememory_1_1_shared_ptr.html">ememory::SharedPtr</a></div></div>
<div class="ttc" id="namespaceexml_html_a49be10c1d94fea7f1fe579e5ec041e55"><div class="ttname"><a href="namespaceexml.html#a49be10c1d94fea7f1fe579e5ec041e55">exml::nodeType</a></div><div class="ttdeci">nodeType</div><div class="ttdoc">Type of the XML elements. </div><div class="ttdef"><b>Definition:</b> nodeType.hpp:17</div></div>
<div class="ttc" id="classexml_1_1internal_1_1_comment_html_a3c3de1b1577bb9dbc50940589b21b780"><div class="ttname"><a href="classexml_1_1internal_1_1_comment.html#a3c3de1b1577bb9dbc50940589b21b780">exml::internal::Comment::getType</a></div><div class="ttdeci">enum nodeType getType() const override</div><div class="ttdoc">get the node type. </div><div class="ttdef"><b>Definition:</b> Comment.hpp:33</div></div>
<div class="ttc" id="classexml_1_1internal_1_1_comment_html_a410b4fb619920d368735ac0cd89dafa6"><div class="ttname"><a href="classexml_1_1internal_1_1_comment.html#a410b4fb619920d368735ac0cd89dafa6">exml::internal::Comment::create</a></div><div class="ttdeci">static ememory::SharedPtr&lt; exml::internal::Comment &gt; create(const std::string &amp;_value=&quot;&quot;)</div><div class="ttdoc">defined factory </div></div>
<div class="ttc" id="classexml_1_1internal_1_1_comment_html"><div class="ttname"><a href="classexml_1_1internal_1_1_comment.html">exml::internal::Comment</a></div><div class="ttdoc">Comment node: &lt;! ... &gt;. </div><div class="ttdef"><b>Definition:</b> Comment.hpp:16</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
</div>
</div>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 24 2016 14:06:01 for exml: Ewol XML parser by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>