TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299
							<!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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torque2D Reference: TamlParser Class Reference</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="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="t2d-stylesheet-extra.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">Torque2D Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</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">
<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><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_taml_parser-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">TamlParser Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__taml_group.html">TAML Reference</a></div></div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;tamlParser.h&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for TamlParser:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
 <div class="center">
  <img src="class_taml_parser.png" usemap="#TamlParser_map" alt=""/>
  <map id="TamlParser_map" name="TamlParser_map">
<area href="class_taml_j_s_o_n_parser.html" title="RapidJson." alt="TamlJSONParser" shape="rect" coords="0,56,110,80"/>
<area href="class_taml_xml_parser.html" alt="TamlXmlParser" shape="rect" coords="120,56,230,80"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a816d0b3686acd385544958d1ee4c229d" id="r_a816d0b3686acd385544958d1ee4c229d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_taml_parser.html#a816d0b3686acd385544958d1ee4c229d">TamlParser</a> ()</td></tr>
<tr class="separator:a816d0b3686acd385544958d1ee4c229d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe903f2f9631b6be41657c937f4e4042" id="r_abe903f2f9631b6be41657c937f4e4042"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_taml_parser.html#abe903f2f9631b6be41657c937f4e4042">~TamlParser</a> ()</td></tr>
<tr class="separator:abe903f2f9631b6be41657c937f4e4042"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa468b547e04ced4c00e7acd1d36853af" id="r_aa468b547e04ced4c00e7acd1d36853af"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_taml_parser.html#aa468b547e04ced4c00e7acd1d36853af">canChangeProperty</a> (void)=0</td></tr>
<tr class="memdesc:aa468b547e04ced4c00e7acd1d36853af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the parser can change a property or not.  <br /></td></tr>
<tr class="separator:aa468b547e04ced4c00e7acd1d36853af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af99fd3952ef3b35fcb59cd52a5e8954e" id="r_af99fd3952ef3b35fcb59cd52a5e8954e"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_taml_parser.html#af99fd3952ef3b35fcb59cd52a5e8954e">accept</a> (const char *pFilename, <a class="el" href="class_taml_visitor.html">TamlVisitor</a> &amp;visitor)=0</td></tr>
<tr class="memdesc:af99fd3952ef3b35fcb59cd52a5e8954e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accept visitor.  <br /></td></tr>
<tr class="separator:af99fd3952ef3b35fcb59cd52a5e8954e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a051c20e2c2a9b16daa149496bca1b17a" id="r_a051c20e2c2a9b16daa149496bca1b17a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_taml_parser.html#a051c20e2c2a9b16daa149496bca1b17a">setParsingFilename</a> (const char *pFilename)</td></tr>
<tr class="memdesc:a051c20e2c2a9b16daa149496bca1b17a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Filename.  <br /></td></tr>
<tr class="separator:a051c20e2c2a9b16daa149496bca1b17a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ae04564f2b679ab9a4ca1afafdeea6a" id="r_a5ae04564f2b679ab9a4ca1afafdeea6a"><td class="memItemLeft" align="right" valign="top">StringTableEntry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_taml_parser.html#a5ae04564f2b679ab9a4ca1afafdeea6a">getParsingFilename</a> (void) const</td></tr>
<tr class="separator:a5ae04564f2b679ab9a4ca1afafdeea6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__taml_group.html">TAML Reference</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a816d0b3686acd385544958d1ee4c229d" name="a816d0b3686acd385544958d1ee4c229d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a816d0b3686acd385544958d1ee4c229d">&#9670;&#160;</a></span>TamlParser()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_taml_parser.html">TamlParser</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="abe903f2f9631b6be41657c937f4e4042" name="abe903f2f9631b6be41657c937f4e4042"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe903f2f9631b6be41657c937f4e4042">&#9670;&#160;</a></span>~TamlParser()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual ~<a class="el" href="class_taml_parser.html">TamlParser</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af99fd3952ef3b35fcb59cd52a5e8954e" name="af99fd3952ef3b35fcb59cd52a5e8954e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af99fd3952ef3b35fcb59cd52a5e8954e">&#9670;&#160;</a></span>accept()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool accept </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>pFilename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_taml_visitor.html">TamlVisitor</a> &amp;&#160;</td>
          <td class="paramname"><em>visitor</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Accept visitor. </p>

<p>Implemented in <a class="el" href="class_taml_j_s_o_n_parser.html#a0db91ed708918d0cd6ab45d1d1e59107">TamlJSONParser</a>, and <a class="el" href="class_taml_xml_parser.html#a0db91ed708918d0cd6ab45d1d1e59107">TamlXmlParser</a>.</p>

</div>
</div>
<a id="aa468b547e04ced4c00e7acd1d36853af" name="aa468b547e04ced4c00e7acd1d36853af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa468b547e04ced4c00e7acd1d36853af">&#9670;&#160;</a></span>canChangeProperty()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool canChangeProperty </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Whether the parser can change a property or not. </p>

<p>Implemented in <a class="el" href="class_taml_j_s_o_n_parser.html#a6fc4407b9650e9f34b86cfb2abcb8c48">TamlJSONParser</a>, and <a class="el" href="class_taml_xml_parser.html#a6fc4407b9650e9f34b86cfb2abcb8c48">TamlXmlParser</a>.</p>

</div>
</div>
<a id="a5ae04564f2b679ab9a4ca1afafdeea6a" name="a5ae04564f2b679ab9a4ca1afafdeea6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ae04564f2b679ab9a4ca1afafdeea6a">&#9670;&#160;</a></span>getParsingFilename()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">StringTableEntry getParsingFilename </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a051c20e2c2a9b16daa149496bca1b17a" name="a051c20e2c2a9b16daa149496bca1b17a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a051c20e2c2a9b16daa149496bca1b17a">&#9670;&#160;</a></span>setParsingFilename()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void setParsingFilename </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>pFilename</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Filename. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>persistence/taml/<b>tamlParser.h</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>