Codebase list ohcount / 6c6b3496-5c95-4881-94ad-331592f9fd83/main doc / html / structSourceFile.html
6c6b3496-5c95-4881-94ad-331592f9fd83/main

Tree @6c6b3496-5c95-4881-94ad-331592f9fd83/main (Download .tar.gz)

structSourceFile.html @6c6b3496-5c95-4881-94ad-331592f9fd83/mainraw · history · blame

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ohcount: SourceFile Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>SourceFile Struct Reference</h1><!-- doxytag: class="SourceFile" -->Represents a single source code file.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="structs_8h_source.html">structs.h</a>&gt;</code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<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>

<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>

<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>

<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>

<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>

<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>

<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>

<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>

<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>

<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>

<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>

<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>

<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>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Represents a single source code file. <hr><h2>Field Documentation</h2>
<a class="anchor" name="c098f80ce4c0e0a52925f701e2e51af8"></a><!-- doxytag: member="SourceFile::contents" ref="c098f80ce4c0e0a52925f701e2e51af8" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* <a class="el" href="structSourceFile.html#c098f80ce4c0e0a52925f701e2e51af8">SourceFile::contents</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
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. 
</div>
</div><p>
<a class="anchor" name="5d661d6284865c9795a1ed357da09e1f"></a><!-- doxytag: member="SourceFile::dirpath" ref="5d661d6284865c9795a1ed357da09e1f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structSourceFile.html#5d661d6284865c9795a1ed357da09e1f">SourceFile::dirpath</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
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. 
</div>
</div><p>
<a class="anchor" name="bec6ebd918e7d101720ba8f054c223eb"></a><!-- doxytag: member="SourceFile::diskpath" ref="bec6ebd918e7d101720ba8f054c223eb" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* <a class="el" href="structSourceFile.html#bec6ebd918e7d101720ba8f054c223eb">SourceFile::diskpath</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
If filepath does not represent the real location of the file on disk, this field does. 
</div>
</div><p>
<a class="anchor" name="bccd254e2fd8f6a2103101d8987fcce2"></a><!-- doxytag: member="SourceFile::ext" ref="bccd254e2fd8f6a2103101d8987fcce2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* <a class="el" href="structSourceFile.html#bccd254e2fd8f6a2103101d8987fcce2">SourceFile::ext</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The filepath's file extension. 
</div>
</div><p>
<a class="anchor" name="5ac916961944c54644c758e0ddeb4a92"></a><!-- doxytag: member="SourceFile::filename" ref="5ac916961944c54644c758e0ddeb4a92" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* <a class="el" href="structSourceFile.html#5ac916961944c54644c758e0ddeb4a92">SourceFile::filename</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The filepath's filename. 
</div>
</div><p>
<a class="anchor" name="97ed56dcaa836608cbdfdb1ff110eea9"></a><!-- doxytag: member="SourceFile::filenames" ref="97ed56dcaa836608cbdfdb1ff110eea9" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char** <a class="el" href="structSourceFile.html#97ed56dcaa836608cbdfdb1ff110eea9">SourceFile::filenames</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
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. 
</div>
</div><p>
<a class="anchor" name="a8f5ef18a7d70679124719ef7e553dcd"></a><!-- doxytag: member="SourceFile::filepath" ref="a8f5ef18a7d70679124719ef7e553dcd" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* <a class="el" href="structSourceFile.html#a8f5ef18a7d70679124719ef7e553dcd">SourceFile::filepath</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The entire path to the file. 
</div>
</div><p>
<a class="anchor" name="8ea0a65619cd242ed80f6a92d85f2654"></a><!-- doxytag: member="SourceFile::language" ref="8ea0a65619cd242ed80f6a92d85f2654" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* <a class="el" href="structSourceFile.html#8ea0a65619cd242ed80f6a92d85f2654">SourceFile::language</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
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. 
</div>
</div><p>
<a class="anchor" name="2ac018220468b0a0795f2b9e0119982f"></a><!-- doxytag: member="SourceFile::language_detected" ref="2ac018220468b0a0795f2b9e0119982f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structSourceFile.html#2ac018220468b0a0795f2b9e0119982f">SourceFile::language_detected</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
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. 
</div>
</div><p>
<a class="anchor" name="4be6d3d73c611e52fb7b1437f7341413"></a><!-- doxytag: member="SourceFile::license_list" ref="4be6d3d73c611e52fb7b1437f7341413" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structLicenseListItem.html">LicenseList</a>* <a class="el" href="structSourceFile.html#4be6d3d73c611e52fb7b1437f7341413">SourceFile::license_list</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
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. 
</div>
</div><p>
<a class="anchor" name="51d1443a556611397e5edfc30876e3bd"></a><!-- doxytag: member="SourceFile::loc_list" ref="51d1443a556611397e5edfc30876e3bd" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structLocListItem.html">LocList</a>* <a class="el" href="structSourceFile.html#51d1443a556611397e5edfc30876e3bd">SourceFile::loc_list</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
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. 
</div>
</div><p>
<a class="anchor" name="e6fe282981dbb4779a69205cbfbab8cb"></a><!-- doxytag: member="SourceFile::parsed_language_list" ref="e6fe282981dbb4779a69205cbfbab8cb" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structParsedLanguageListItem.html">ParsedLanguageList</a>* <a class="el" href="structSourceFile.html#e6fe282981dbb4779a69205cbfbab8cb">SourceFile::parsed_language_list</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
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. 
</div>
</div><p>
<a class="anchor" name="d371721513cdefdfe210041c3fc25dd5"></a><!-- doxytag: member="SourceFile::size" ref="d371721513cdefdfe210041c3fc25dd5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structSourceFile.html#d371721513cdefdfe210041c3fc25dd5">SourceFile::size</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
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. 
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>/Users/andy/dev/ohcount/src/<a class="el" href="structs_8h_source.html">structs.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Aug 28 15:20:08 2009 for ohcount by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>