git.oblomov.eu Git - ohcount/blob - doc/html/structSourceFile.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: SourceFile Struct 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 class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  14       <li><a href="files.html"><span>Files</span></a></li>
  15     </ul>
  16   </div>
  17   <div class="tabs">
  18     <ul>
  19       <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  20       <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
  21     </ul>
  22   </div>
  23 </div>
  24 <div class="contents">
  25 <h1>SourceFile Struct Reference</h1><!-- doxytag: class="SourceFile" -->Represents a single source code file.
  26 <a href="#_details">More...</a>
  27 <p>
  28 <code>#include &lt;<a class="el" href="structs_8h_source.html">structs.h</a>&gt;</code>
  29 <p>
  30 <table border="0" cellpadding="0" cellspacing="0">
  31 <tr><td></td></tr>
  32 <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
  33 <tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSourceFile.html#a8f5ef18a7d70679124719ef7e553dcd">filepath</a></td></tr>
  34
  35 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSourceFile.html#5d661d6284865c9795a1ed357da09e1f">dirpath</a></td></tr>
  36
  37 <tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSourceFile.html#5ac916961944c54644c758e0ddeb4a92">filename</a></td></tr>
  38
  39 <tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSourceFile.html#bccd254e2fd8f6a2103101d8987fcce2">ext</a></td></tr>
  40
  41 <tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSourceFile.html#bec6ebd918e7d101720ba8f054c223eb">diskpath</a></td></tr>
  42
  43 <tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSourceFile.html#c098f80ce4c0e0a52925f701e2e51af8">contents</a></td></tr>
  44
  45 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSourceFile.html#d371721513cdefdfe210041c3fc25dd5">size</a></td></tr>
  46
  47 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSourceFile.html#8ea0a65619cd242ed80f6a92d85f2654">language</a></td></tr>
  48
  49 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSourceFile.html#2ac018220468b0a0795f2b9e0119982f">language_detected</a></td></tr>
  50
  51 <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="structSourceFile.html#e6fe282981dbb4779a69205cbfbab8cb">parsed_language_list</a></td></tr>
  52
  53 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structLicenseListItem.html">LicenseList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSourceFile.html#4be6d3d73c611e52fb7b1437f7341413">license_list</a></td></tr>
  54
  55 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structLocListItem.html">LocList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSourceFile.html#51d1443a556611397e5edfc30876e3bd">loc_list</a></td></tr>
  56
  57 <tr><td class="memItemLeft" nowrap align="right" valign="top">char **&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSourceFile.html#97ed56dcaa836608cbdfdb1ff110eea9">filenames</a></td></tr>
  58
  59 </table>
  60 <hr><a name="_details"></a><h2>Detailed Description</h2>
  61 Represents a single source code file. <hr><h2>Field Documentation</h2>
  62 <a class="anchor" name="c098f80ce4c0e0a52925f701e2e51af8"></a><!-- doxytag: member="SourceFile::contents" ref="c098f80ce4c0e0a52925f701e2e51af8" args="" -->
  63 <div class="memitem">
  64 <div class="memproto">
  65       <table class="memname">
  66         <tr>
  67           <td class="memname">char* <a class="el" href="structSourceFile.html#c098f80ce4c0e0a52925f701e2e51af8">SourceFile::contents</a>          </td>
  68         </tr>
  69       </table>
  70 </div>
  71 <div class="memdoc">
  72
  73 <p>
  74 The contents of the file. Do not use this field. Use <a class="el" href="sourcefile_8h.html#d78d1d1726970dbcdb8b999f1ab7c175">ohcount_sourcefile_get_contents()</a> instead.
  75 </div>
  76 </div><p>
  77 <a class="anchor" name="5d661d6284865c9795a1ed357da09e1f"></a><!-- doxytag: member="SourceFile::dirpath" ref="5d661d6284865c9795a1ed357da09e1f" args="" -->
  78 <div class="memitem">
  79 <div class="memproto">
  80       <table class="memname">
  81         <tr>
  82           <td class="memname">int <a class="el" href="structSourceFile.html#5d661d6284865c9795a1ed357da09e1f">SourceFile::dirpath</a>          </td>
  83         </tr>
  84       </table>
  85 </div>
  86 <div class="memdoc">
  87
  88 <p>
  89 The last character address considered to be part of the directory path in filepath. This is an address in memory, not a length relative to filepath.
  90 </div>
  91 </div><p>
  92 <a class="anchor" name="bec6ebd918e7d101720ba8f054c223eb"></a><!-- doxytag: member="SourceFile::diskpath" ref="bec6ebd918e7d101720ba8f054c223eb" args="" -->
  93 <div class="memitem">
  94 <div class="memproto">
  95       <table class="memname">
  96         <tr>
  97           <td class="memname">char* <a class="el" href="structSourceFile.html#bec6ebd918e7d101720ba8f054c223eb">SourceFile::diskpath</a>          </td>
  98         </tr>
  99       </table>
 100 </div>
 101 <div class="memdoc">
 102
 103 <p>
 104 If filepath does not represent the real location of the file on disk, this field does.
 105 </div>
 106 </div><p>
 107 <a class="anchor" name="bccd254e2fd8f6a2103101d8987fcce2"></a><!-- doxytag: member="SourceFile::ext" ref="bccd254e2fd8f6a2103101d8987fcce2" args="" -->
 108 <div class="memitem">
 109 <div class="memproto">
 110       <table class="memname">
 111         <tr>
 112           <td class="memname">char* <a class="el" href="structSourceFile.html#bccd254e2fd8f6a2103101d8987fcce2">SourceFile::ext</a>          </td>
 113         </tr>
 114       </table>
 115 </div>
 116 <div class="memdoc">
 117
 118 <p>
 119 The filepath's file extension.
 120 </div>
 121 </div><p>
 122 <a class="anchor" name="5ac916961944c54644c758e0ddeb4a92"></a><!-- doxytag: member="SourceFile::filename" ref="5ac916961944c54644c758e0ddeb4a92" args="" -->
 123 <div class="memitem">
 124 <div class="memproto">
 125       <table class="memname">
 126         <tr>
 127           <td class="memname">char* <a class="el" href="structSourceFile.html#5ac916961944c54644c758e0ddeb4a92">SourceFile::filename</a>          </td>
 128         </tr>
 129       </table>
 130 </div>
 131 <div class="memdoc">
 132
 133 <p>
 134 The filepath's filename.
 135 </div>
 136 </div><p>
 137 <a class="anchor" name="97ed56dcaa836608cbdfdb1ff110eea9"></a><!-- doxytag: member="SourceFile::filenames" ref="97ed56dcaa836608cbdfdb1ff110eea9" args="" -->
 138 <div class="memitem">
 139 <div class="memproto">
 140       <table class="memname">
 141         <tr>
 142           <td class="memname">char** <a class="el" href="structSourceFile.html#97ed56dcaa836608cbdfdb1ff110eea9">SourceFile::filenames</a>          </td>
 143         </tr>
 144       </table>
 145 </div>
 146 <div class="memdoc">
 147
 148 <p>
 149 A string array of all filenames in this file's directory. Do not use this field. Use <a class="el" href="sourcefile_8h.html#f717654d914aaf5630438d84852690ea">ohcount_sourcefile_get_filenames()</a> instead.
 150 </div>
 151 </div><p>
 152 <a class="anchor" name="a8f5ef18a7d70679124719ef7e553dcd"></a><!-- doxytag: member="SourceFile::filepath" ref="a8f5ef18a7d70679124719ef7e553dcd" args="" -->
 153 <div class="memitem">
 154 <div class="memproto">
 155       <table class="memname">
 156         <tr>
 157           <td class="memname">char* <a class="el" href="structSourceFile.html#a8f5ef18a7d70679124719ef7e553dcd">SourceFile::filepath</a>          </td>
 158         </tr>
 159       </table>
 160 </div>
 161 <div class="memdoc">
 162
 163 <p>
 164 The entire path to the file.
 165 </div>
 166 </div><p>
 167 <a class="anchor" name="8ea0a65619cd242ed80f6a92d85f2654"></a><!-- doxytag: member="SourceFile::language" ref="8ea0a65619cd242ed80f6a92d85f2654" args="" -->
 168 <div class="memitem">
 169 <div class="memproto">
 170       <table class="memname">
 171         <tr>
 172           <td class="memname">const char* <a class="el" href="structSourceFile.html#8ea0a65619cd242ed80f6a92d85f2654">SourceFile::language</a>          </td>
 173         </tr>
 174       </table>
 175 </div>
 176 <div class="memdoc">
 177
 178 <p>
 179 The file's detected source code language. Do not use this field. Use <a class="el" href="sourcefile_8h.html#4e26432b8859af9b569e7ceb76a0c4f2">ohcount_sourcefile_get_language()</a> instead.
 180 </div>
 181 </div><p>
 182 <a class="anchor" name="2ac018220468b0a0795f2b9e0119982f"></a><!-- doxytag: member="SourceFile::language_detected" ref="2ac018220468b0a0795f2b9e0119982f" args="" -->
 183 <div class="memitem">
 184 <div class="memproto">
 185       <table class="memname">
 186         <tr>
 187           <td class="memname">int <a class="el" href="structSourceFile.html#2ac018220468b0a0795f2b9e0119982f">SourceFile::language_detected</a>          </td>
 188         </tr>
 189       </table>
 190 </div>
 191 <div class="memdoc">
 192
 193 <p>
 194 Flag used internally for keeping track of whether or not <a class="el" href="sourcefile_8h.html#4e26432b8859af9b569e7ceb76a0c4f2">ohcount_sourcefile_get_language()</a> has been called for this file.
 195 </div>
 196 </div><p>
 197 <a class="anchor" name="4be6d3d73c611e52fb7b1437f7341413"></a><!-- doxytag: member="SourceFile::license_list" ref="4be6d3d73c611e52fb7b1437f7341413" args="" -->
 198 <div class="memitem">
 199 <div class="memproto">
 200       <table class="memname">
 201         <tr>
 202           <td class="memname"><a class="el" href="structLicenseListItem.html">LicenseList</a>* <a class="el" href="structSourceFile.html#4be6d3d73c611e52fb7b1437f7341413">SourceFile::license_list</a>          </td>
 203         </tr>
 204       </table>
 205 </div>
 206 <div class="memdoc">
 207
 208 <p>
 209 A LicenseList of licenses detected. Do not use this field. Use <a class="el" href="sourcefile_8h.html#c8301992dd8f9eb8af00f04404c8ddac">ohcount_sourcefile_get_license_list()</a> instead.
 210 </div>
 211 </div><p>
 212 <a class="anchor" name="51d1443a556611397e5edfc30876e3bd"></a><!-- doxytag: member="SourceFile::loc_list" ref="51d1443a556611397e5edfc30876e3bd" args="" -->
 213 <div class="memitem">
 214 <div class="memproto">
 215       <table class="memname">
 216         <tr>
 217           <td class="memname"><a class="el" href="structLocListItem.html">LocList</a>* <a class="el" href="structSourceFile.html#51d1443a556611397e5edfc30876e3bd">SourceFile::loc_list</a>          </td>
 218         </tr>
 219       </table>
 220 </div>
 221 <div class="memdoc">
 222
 223 <p>
 224 A LocList of all lines of code in each language in the file. Do not use this field. Use <a class="el" href="sourcefile_8h.html#6f2cfdb608e1b2c02546dd7f82c7f0ae">ohcount_sourcefile_get_loc_list()</a> instead.
 225 </div>
 226 </div><p>
 227 <a class="anchor" name="e6fe282981dbb4779a69205cbfbab8cb"></a><!-- doxytag: member="SourceFile::parsed_language_list" ref="e6fe282981dbb4779a69205cbfbab8cb" args="" -->
 228 <div class="memitem">
 229 <div class="memproto">
 230       <table class="memname">
 231         <tr>
 232           <td class="memname"><a class="el" href="structParsedLanguageListItem.html">ParsedLanguageList</a>* <a class="el" href="structSourceFile.html#e6fe282981dbb4779a69205cbfbab8cb">SourceFile::parsed_language_list</a>          </td>
 233         </tr>
 234       </table>
 235 </div>
 236 <div class="memdoc">
 237
 238 <p>
 239 A ParsedLanguageList resulting from parsing the file. Do not use this field. Use <a class="el" href="sourcefile_8h.html#ac4df12ae1934a82e8a5fa0418da898b">ohcount_sourcefile_get_parsed_language_list()</a> instead.
 240 </div>
 241 </div><p>
 242 <a class="anchor" name="d371721513cdefdfe210041c3fc25dd5"></a><!-- doxytag: member="SourceFile::size" ref="d371721513cdefdfe210041c3fc25dd5" args="" -->
 243 <div class="memitem">
 244 <div class="memproto">
 245       <table class="memname">
 246         <tr>
 247           <td class="memname">int <a class="el" href="structSourceFile.html#d371721513cdefdfe210041c3fc25dd5">SourceFile::size</a>          </td>
 248         </tr>
 249       </table>
 250 </div>
 251 <div class="memdoc">
 252
 253 <p>
 254 The size of the file's contents in bytes. Do not use this field. Use <a class="el" href="sourcefile_8h.html#f0bda4d5eb8ebae78653881196d1b2ea">ohcount_sourcefile_get_contents_size()</a> instead.
 255 </div>
 256 </div><p>
 257 <hr>The documentation for this struct was generated from the following file:<ul>
 258 <li>/Users/andy/dev/ohcount/src/<a class="el" href="structs_8h_source.html">structs.h</a></ul>
 259 </div>
 260 <hr size="1"><address style="text-align: right;"><small>Generated on Fri Aug 28 15:20:08 2009 for ohcount by&nbsp;
 261 <a href="http://www.doxygen.org/index.html">
 262 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
 263 </body>
 264 </html>