git.oblomov.eu Git - ohcount/blob - doc/html/parsed__language_8h.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>ohcount: /Users/andy/dev/ohcount/src/parsed_language.h File Reference</title>
   4 <link href="tabs.css" rel="stylesheet" type="text/css">
   5 <link href="doxygen.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.9 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  13       <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  14       <li class="current"><a href="files.html"><span>Files</span></a></li>
  15     </ul>
  16   </div>
  17   <div class="tabs">
  18     <ul>
  19       <li><a href="files.html"><span>File&nbsp;List</span></a></li>
  20       <li><a href="globals.html"><span>Globals</span></a></li>
  21     </ul>
  22   </div>
  23 </div>
  24 <div class="contents">
  25 <h1>/Users/andy/dev/ohcount/src/parsed_language.h File Reference</h1><code>#include &quot;<a class="el" href="structs_8h_source.html">structs.h</a>&quot;</code><br>
  26
  27 <p>
  28 <a href="parsed__language_8h_source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
  29 <tr><td></td></tr>
  30 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
  31 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structParsedLanguage.html">ParsedLanguage</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="parsed__language_8h.html#f0dcb34d59378f9d1ac182e70dc5ac40">ohcount_parsed_language_new</a> (const char *language, int buffer_size)</td></tr>
  32
  33 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="parsed__language_8h.html#5ec0124dc2d3dc90ca53fe2a2ab19b01">ohcount_parsed_language_add_code</a> (<a class="el" href="structParsedLanguage.html">ParsedLanguage</a> *parsed_language, char *<a class="el" href="parser__macros_8h.html#aa1ebe818ec1c763a776cc580551f3e6">p</a>, int length)</td></tr>
  34
  35 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="parsed__language_8h.html#7cd0c780aa6549e45ea4df9f418265a5">ohcount_parsed_language_add_comment</a> (<a class="el" href="structParsedLanguage.html">ParsedLanguage</a> *parsed_language, char *<a class="el" href="parser__macros_8h.html#aa1ebe818ec1c763a776cc580551f3e6">p</a>, int length)</td></tr>
  36
  37 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="parsed__language_8h.html#c1237f5b9dbf4654fc21e446bc9c7c67">ohcount_parsed_language_free</a> (<a class="el" href="structParsedLanguage.html">ParsedLanguage</a> *parsed_language)</td></tr>
  38
  39 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structParsedLanguageListItem.html">ParsedLanguageList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="parsed__language_8h.html#db3c9117c3a9e64faea93c5c4b69a4de">ohcount_parsed_language_list_new</a> ()</td></tr>
  40
  41 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="parsed__language_8h.html#9b76c954c66be2e0f5a407a9db5057a8">ohcount_parsed_language_list_free</a> (<a class="el" href="structParsedLanguageListItem.html">ParsedLanguageList</a> *list)</td></tr>
  42
  43 </table>
  44 <hr><h2>Function Documentation</h2>
  45 <a class="anchor" name="5ec0124dc2d3dc90ca53fe2a2ab19b01"></a><!-- doxytag: member="parsed_language.h::ohcount_parsed_language_add_code" ref="5ec0124dc2d3dc90ca53fe2a2ab19b01" args="(ParsedLanguage *parsed_language, char *p, int length)" -->
  46 <div class="memitem">
  47 <div class="memproto">
  48       <table class="memname">
  49         <tr>
  50           <td class="memname">void ohcount_parsed_language_add_code           </td>
  51           <td>(</td>
  52           <td class="paramtype"><a class="el" href="structParsedLanguage.html">ParsedLanguage</a> *&nbsp;</td>
  53           <td class="paramname"> <em>parsed_language</em>, </td>
  54         </tr>
  55         <tr>
  56           <td class="paramkey"></td>
  57           <td></td>
  58           <td class="paramtype">char *&nbsp;</td>
  59           <td class="paramname"> <em>p</em>, </td>
  60         </tr>
  61         <tr>
  62           <td class="paramkey"></td>
  63           <td></td>
  64           <td class="paramtype">int&nbsp;</td>
  65           <td class="paramname"> <em>length</em></td><td>&nbsp;</td>
  66         </tr>
  67         <tr>
  68           <td></td>
  69           <td>)</td>
  70           <td></td><td></td><td></td>
  71         </tr>
  72       </table>
  73 </div>
  74 <div class="memdoc">
  75
  76 <p>
  77 Adds some code to the code buffer for the given <a class="el" href="structParsedLanguage.html" title="Represents a single language parsed from a SourceFile.">ParsedLanguage</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
  78   <table border="0" cellspacing="2" cellpadding="0">
  79     <tr><td valign="top"></td><td valign="top"><em>parsed_language</em>&nbsp;</td><td>A <a class="el" href="structParsedLanguage.html" title="Represents a single language parsed from a SourceFile.">ParsedLanguage</a> created from <a class="el" href="parsed__language_8h.html#f0dcb34d59378f9d1ac182e70dc5ac40">ohcount_parsed_language_new()</a>. </td></tr>
  80     <tr><td valign="top"></td><td valign="top"><em>p</em>&nbsp;</td><td>A pointer in memory to start copying code from. </td></tr>
  81     <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>The number of characters to copy from p. </td></tr>
  82   </table>
  83 </dl>
  84
  85 </div>
  86 </div><p>
  87 <a class="anchor" name="7cd0c780aa6549e45ea4df9f418265a5"></a><!-- doxytag: member="parsed_language.h::ohcount_parsed_language_add_comment" ref="7cd0c780aa6549e45ea4df9f418265a5" args="(ParsedLanguage *parsed_language, char *p, int length)" -->
  88 <div class="memitem">
  89 <div class="memproto">
  90       <table class="memname">
  91         <tr>
  92           <td class="memname">void ohcount_parsed_language_add_comment           </td>
  93           <td>(</td>
  94           <td class="paramtype"><a class="el" href="structParsedLanguage.html">ParsedLanguage</a> *&nbsp;</td>
  95           <td class="paramname"> <em>parsed_language</em>, </td>
  96         </tr>
  97         <tr>
  98           <td class="paramkey"></td>
  99           <td></td>
 100           <td class="paramtype">char *&nbsp;</td>
 101           <td class="paramname"> <em>p</em>, </td>
 102         </tr>
 103         <tr>
 104           <td class="paramkey"></td>
 105           <td></td>
 106           <td class="paramtype">int&nbsp;</td>
 107           <td class="paramname"> <em>length</em></td><td>&nbsp;</td>
 108         </tr>
 109         <tr>
 110           <td></td>
 111           <td>)</td>
 112           <td></td><td></td><td></td>
 113         </tr>
 114       </table>
 115 </div>
 116 <div class="memdoc">
 117
 118 <p>
 119 Adds a comment to the comment buffer for the given <a class="el" href="structParsedLanguage.html" title="Represents a single language parsed from a SourceFile.">ParsedLanguage</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
 120   <table border="0" cellspacing="2" cellpadding="0">
 121     <tr><td valign="top"></td><td valign="top"><em>parsed_language</em>&nbsp;</td><td>A <a class="el" href="structParsedLanguage.html" title="Represents a single language parsed from a SourceFile.">ParsedLanguage</a> created from <a class="el" href="parsed__language_8h.html#f0dcb34d59378f9d1ac182e70dc5ac40">ohcount_parsed_language_new()</a>. </td></tr>
 122     <tr><td valign="top"></td><td valign="top"><em>p</em>&nbsp;</td><td>A pointer in memory to start copying the comment from. </td></tr>
 123     <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>The number of characters to copy from p. </td></tr>
 124   </table>
 125 </dl>
 126
 127 </div>
 128 </div><p>
 129 <a class="anchor" name="c1237f5b9dbf4654fc21e446bc9c7c67"></a><!-- doxytag: member="parsed_language.h::ohcount_parsed_language_free" ref="c1237f5b9dbf4654fc21e446bc9c7c67" args="(ParsedLanguage *parsed_language)" -->
 130 <div class="memitem">
 131 <div class="memproto">
 132       <table class="memname">
 133         <tr>
 134           <td class="memname">void ohcount_parsed_language_free           </td>
 135           <td>(</td>
 136           <td class="paramtype"><a class="el" href="structParsedLanguage.html">ParsedLanguage</a> *&nbsp;</td>
 137           <td class="paramname"> <em>parsed_language</em>          </td>
 138           <td>&nbsp;)&nbsp;</td>
 139           <td></td>
 140         </tr>
 141       </table>
 142 </div>
 143 <div class="memdoc">
 144
 145 <p>
 146 Frees the memory allocated for the given <a class="el" href="structParsedLanguage.html" title="Represents a single language parsed from a SourceFile.">ParsedLanguage</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
 147   <table border="0" cellspacing="2" cellpadding="0">
 148     <tr><td valign="top"></td><td valign="top"><em>parsed_language</em>&nbsp;</td><td>A <a class="el" href="structParsedLanguage.html" title="Represents a single language parsed from a SourceFile.">ParsedLanguage</a> created from <a class="el" href="parsed__language_8h.html#f0dcb34d59378f9d1ac182e70dc5ac40">ohcount_parsed_language_new()</a>. </td></tr>
 149   </table>
 150 </dl>
 151
 152 </div>
 153 </div><p>
 154 <a class="anchor" name="9b76c954c66be2e0f5a407a9db5057a8"></a><!-- doxytag: member="parsed_language.h::ohcount_parsed_language_list_free" ref="9b76c954c66be2e0f5a407a9db5057a8" args="(ParsedLanguageList *list)" -->
 155 <div class="memitem">
 156 <div class="memproto">
 157       <table class="memname">
 158         <tr>
 159           <td class="memname">void ohcount_parsed_language_list_free           </td>
 160           <td>(</td>
 161           <td class="paramtype"><a class="el" href="structParsedLanguageListItem.html">ParsedLanguageList</a> *&nbsp;</td>
 162           <td class="paramname"> <em>list</em>          </td>
 163           <td>&nbsp;)&nbsp;</td>
 164           <td></td>
 165         </tr>
 166       </table>
 167 </div>
 168 <div class="memdoc">
 169
 170 <p>
 171 Frees the memory allocated for the given ParsedLanguageList. <dl compact><dt><b>Parameters:</b></dt><dd>
 172   <table border="0" cellspacing="2" cellpadding="0">
 173     <tr><td valign="top"></td><td valign="top"><em>list</em>&nbsp;</td><td>A <a class="el" href="structParsedLanguage.html" title="Represents a single language parsed from a SourceFile.">ParsedLanguage</a> created from <a class="el" href="parsed__language_8h.html#db3c9117c3a9e64faea93c5c4b69a4de">ohcount_parsed_language_list_new()</a>. </td></tr>
 174   </table>
 175 </dl>
 176
 177 </div>
 178 </div><p>
 179 <a class="anchor" name="db3c9117c3a9e64faea93c5c4b69a4de"></a><!-- doxytag: member="parsed_language.h::ohcount_parsed_language_list_new" ref="db3c9117c3a9e64faea93c5c4b69a4de" args="()" -->
 180 <div class="memitem">
 181 <div class="memproto">
 182       <table class="memname">
 183         <tr>
 184           <td class="memname"><a class="el" href="structParsedLanguageListItem.html">ParsedLanguageList</a>* ohcount_parsed_language_list_new           </td>
 185           <td>(</td>
 186           <td class="paramname">          </td>
 187           <td>&nbsp;)&nbsp;</td>
 188           <td></td>
 189         </tr>
 190       </table>
 191 </div>
 192 <div class="memdoc">
 193
 194 <p>
 195 Creates a new ParsedLanguageList that is initially empty. <dl class="return" compact><dt><b>Returns:</b></dt><dd>ParsedLanguageList </dd></dl>
 196
 197 </div>
 198 </div><p>
 199 <a class="anchor" name="f0dcb34d59378f9d1ac182e70dc5ac40"></a><!-- doxytag: member="parsed_language.h::ohcount_parsed_language_new" ref="f0dcb34d59378f9d1ac182e70dc5ac40" args="(const char *language, int buffer_size)" -->
 200 <div class="memitem">
 201 <div class="memproto">
 202       <table class="memname">
 203         <tr>
 204           <td class="memname"><a class="el" href="structParsedLanguage.html">ParsedLanguage</a>* ohcount_parsed_language_new           </td>
 205           <td>(</td>
 206           <td class="paramtype">const char *&nbsp;</td>
 207           <td class="paramname"> <em>language</em>, </td>
 208         </tr>
 209         <tr>
 210           <td class="paramkey"></td>
 211           <td></td>
 212           <td class="paramtype">int&nbsp;</td>
 213           <td class="paramname"> <em>buffer_size</em></td><td>&nbsp;</td>
 214         </tr>
 215         <tr>
 216           <td></td>
 217           <td>)</td>
 218           <td></td><td></td><td></td>
 219         </tr>
 220       </table>
 221 </div>
 222 <div class="memdoc">
 223
 224 <p>
 225 Creates a new <a class="el" href="structParsedLanguage.html" title="Represents a single language parsed from a SourceFile.">ParsedLanguage</a> for the given language and buffer size. The given language is not copied and may not be 'free'd. Use a language defined in <a class="el" href="languages_8h.html">src/languages.h</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
 226   <table border="0" cellspacing="2" cellpadding="0">
 227     <tr><td valign="top"></td><td valign="top"><em>language</em>&nbsp;</td><td>The parsed language. </td></tr>
 228     <tr><td valign="top"></td><td valign="top"><em>buffer_size</em>&nbsp;</td><td>The size of the buffers to store parsed code and comment text. </td></tr>
 229   </table>
 230 </dl>
 231 <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="structParsedLanguage.html" title="Represents a single language parsed from a SourceFile.">ParsedLanguage</a> </dd></dl>
 232
 233 </div>
 234 </div><p>
 235 </div>
 236 <hr size="1"><address style="text-align: right;"><small>Generated on Fri Aug 28 15:20:08 2009 for ohcount by&nbsp;
 237 <a href="http://www.doxygen.org/index.html">
 238 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
 239 </body>
 240 </html>