Files
openmw.github.io/classBsa_1_1BSAFile.html
Travis CI 1afc571f3d Deploy code docs to GitHub Pages Travis build: 4489
Commit: 6e51b4ff57f622c4e11205ec444ffac21e73bbf7
2017-01-24 02:13:55 +00:00

623 lines
32 KiB
HTML

<!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="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>OpenMW: Bsa::BSAFile 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">OpenMW
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(13)"><span class="SelectionMark">&#160;</span>Pages</a></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="namespaceBsa.html">Bsa</a></li><li class="navelem"><a class="el" href="classBsa_1_1BSAFile.html">BSAFile</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classBsa_1_1BSAFile-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Bsa::BSAFile Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="bsa__file_8hpp_source.html">bsa_file.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for Bsa::BSAFile:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classBsa_1_1BSAFile__coll__graph.svg" width="660" height="720"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structBsa_1_1BSAFile_1_1FileStruct.html">FileStruct</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents one file entry in the archive. <a href="structBsa_1_1BSAFile_1_1FileStruct.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structBsa_1_1BSAFile_1_1iltstr.html">iltstr</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Case insensitive string comparison. <a href="structBsa_1_1BSAFile_1_1iltstr.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ae6a6e808767366eaaa85f3457fe52f8e"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structBsa_1_1BSAFile_1_1FileStruct.html">FileStruct</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBsa_1_1BSAFile.html#ae6a6e808767366eaaa85f3457fe52f8e">FileList</a></td></tr>
<tr class="separator:ae6a6e808767366eaaa85f3457fe52f8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a12700618856ab2bcc2b97dcb1e7e3b86"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBsa_1_1BSAFile.html#a12700618856ab2bcc2b97dcb1e7e3b86">BSAFile</a> ()</td></tr>
<tr class="separator:a12700618856ab2bcc2b97dcb1e7e3b86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c854bff3a97dc947761e9a263b5a754"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBsa_1_1BSAFile.html#a5c854bff3a97dc947761e9a263b5a754">open</a> (const std::string &amp;file)</td></tr>
<tr class="memdesc:a5c854bff3a97dc947761e9a263b5a754"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open an archive file. <a href="#a5c854bff3a97dc947761e9a263b5a754">More...</a><br/></td></tr>
<tr class="separator:a5c854bff3a97dc947761e9a263b5a754"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf8a7bc95608c6e312d812158723b476"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbool.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBsa_1_1BSAFile.html#acf8a7bc95608c6e312d812158723b476">exists</a> (const char *file) const </td></tr>
<tr class="memdesc:acf8a7bc95608c6e312d812158723b476"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a file exists. <a href="#acf8a7bc95608c6e312d812158723b476">More...</a><br/></td></tr>
<tr class="separator:acf8a7bc95608c6e312d812158723b476"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bb47e40c7c0e07ec255da137076dff7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceFiles.html#aba837ada2130f11d385768dcd8f0a950">Files::IStreamPtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBsa_1_1BSAFile.html#a1bb47e40c7c0e07ec255da137076dff7">getFile</a> (const char *file)</td></tr>
<tr class="separator:a1bb47e40c7c0e07ec255da137076dff7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a254b09813d8f97bb057752a5e1e368"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceFiles.html#aba837ada2130f11d385768dcd8f0a950">Files::IStreamPtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBsa_1_1BSAFile.html#a0a254b09813d8f97bb057752a5e1e368">getFile</a> (const <a class="el" href="structBsa_1_1BSAFile_1_1FileStruct.html">FileStruct</a> *file)</td></tr>
<tr class="separator:a0a254b09813d8f97bb057752a5e1e368"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7972a16602af590be0ed8401b9413c2"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classBsa_1_1BSAFile.html#ae6a6e808767366eaaa85f3457fe52f8e">FileList</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBsa_1_1BSAFile.html#ad7972a16602af590be0ed8401b9413c2">getList</a> () const </td></tr>
<tr class="separator:ad7972a16602af590be0ed8401b9413c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:a0bbbd2273bfbf276be944ee632bc50cf"><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; const char <br class="typebreak"/>
*, <a class="el" href="classint.html">int</a>, <a class="el" href="structBsa_1_1BSAFile_1_1iltstr.html">iltstr</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBsa_1_1BSAFile.html#a0bbbd2273bfbf276be944ee632bc50cf">Lookup</a></td></tr>
<tr class="separator:a0bbbd2273bfbf276be944ee632bc50cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a82bc739b5188c1038a601975ffdd214d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBsa_1_1BSAFile.html#a82bc739b5188c1038a601975ffdd214d">fail</a> (const std::string &amp;msg)</td></tr>
<tr class="memdesc:a82bc739b5188c1038a601975ffdd214d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error handling. <a href="#a82bc739b5188c1038a601975ffdd214d">More...</a><br/></td></tr>
<tr class="separator:a82bc739b5188c1038a601975ffdd214d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fb9d39804ac8e6289e0a9cb068eed6b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBsa_1_1BSAFile.html#a1fb9d39804ac8e6289e0a9cb068eed6b">readHeader</a> ()</td></tr>
<tr class="memdesc:a1fb9d39804ac8e6289e0a9cb068eed6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read header information from the input source. <a href="#a1fb9d39804ac8e6289e0a9cb068eed6b">More...</a><br/></td></tr>
<tr class="separator:a1fb9d39804ac8e6289e0a9cb068eed6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76516f3ef49832eec637504370d729de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classint.html">int</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBsa_1_1BSAFile.html#a76516f3ef49832eec637504370d729de">getIndex</a> (const char *str) const </td></tr>
<tr class="memdesc:a76516f3ef49832eec637504370d729de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the index of a given file name, or -1 if not found. <a href="#a76516f3ef49832eec637504370d729de">More...</a><br/></td></tr>
<tr class="separator:a76516f3ef49832eec637504370d729de"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a66118023437b97b4b19cde0ffbc04955"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classBsa_1_1BSAFile.html#ae6a6e808767366eaaa85f3457fe52f8e">FileList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBsa_1_1BSAFile.html#a66118023437b97b4b19cde0ffbc04955">files</a></td></tr>
<tr class="memdesc:a66118023437b97b4b19cde0ffbc04955"><td class="mdescLeft">&#160;</td><td class="mdescRight">Table of files in this archive. <a href="#a66118023437b97b4b19cde0ffbc04955">More...</a><br/></td></tr>
<tr class="separator:a66118023437b97b4b19cde0ffbc04955"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f910406e0728505919eb549b758678d"><td class="memItemLeft" align="right" valign="top">std::vector&lt; char &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBsa_1_1BSAFile.html#a4f910406e0728505919eb549b758678d">stringBuf</a></td></tr>
<tr class="memdesc:a4f910406e0728505919eb549b758678d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Filename string buffer. <a href="#a4f910406e0728505919eb549b758678d">More...</a><br/></td></tr>
<tr class="separator:a4f910406e0728505919eb549b758678d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa460901ec2de5dc76430c64df553b6cc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbool.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBsa_1_1BSAFile.html#aa460901ec2de5dc76430c64df553b6cc">isLoaded</a></td></tr>
<tr class="memdesc:aa460901ec2de5dc76430c64df553b6cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">True when an archive has been loaded. <a href="#aa460901ec2de5dc76430c64df553b6cc">More...</a><br/></td></tr>
<tr class="separator:aa460901ec2de5dc76430c64df553b6cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc41171cecfc1ffa7e7d88802d84c8d2"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBsa_1_1BSAFile.html#acc41171cecfc1ffa7e7d88802d84c8d2">filename</a></td></tr>
<tr class="memdesc:acc41171cecfc1ffa7e7d88802d84c8d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used for error messages. <a href="#acc41171cecfc1ffa7e7d88802d84c8d2">More...</a><br/></td></tr>
<tr class="separator:acc41171cecfc1ffa7e7d88802d84c8d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1376a1606f4a660739725cae9d8d1eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classBsa_1_1BSAFile.html#a0bbbd2273bfbf276be944ee632bc50cf">Lookup</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBsa_1_1BSAFile.html#aa1376a1606f4a660739725cae9d8d1eb">lookup</a></td></tr>
<tr class="separator:aa1376a1606f4a660739725cae9d8d1eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class is used to read "Bethesda Archive Files", or BSAs. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="ae6a6e808767366eaaa85f3457fe52f8e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::vector&lt;<a class="el" href="structBsa_1_1BSAFile_1_1FileStruct.html">FileStruct</a>&gt; <a class="el" href="classBsa_1_1BSAFile.html#ae6a6e808767366eaaa85f3457fe52f8e">Bsa::BSAFile::FileList</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a0bbbd2273bfbf276be944ee632bc50cf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">typedef std::map&lt;const char*, <a class="el" href="classint.html">int</a>, <a class="el" href="structBsa_1_1BSAFile_1_1iltstr.html">iltstr</a>&gt; <a class="el" href="classBsa_1_1BSAFile.html#a0bbbd2273bfbf276be944ee632bc50cf">Bsa::BSAFile::Lookup</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A map used for fast file name lookup. The value is the index into the files[] vector above. The iltstr ensures that file name checks are case insensitive. </p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a12700618856ab2bcc2b97dcb1e7e3b86"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Bsa::BSAFile::BSAFile </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>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="acf8a7bc95608c6e312d812158723b476"></a>
<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="classbool.html">bool</a> Bsa::BSAFile::exists </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>file</em></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">
<p>Check if a file exists. </p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classBsa_1_1BSAFile_acf8a7bc95608c6e312d812158723b476_cgraph.svg" width="371" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classBsa_1_1BSAFile_acf8a7bc95608c6e312d812158723b476_icgraph.svg" width="1219" height="182"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</p>
</div>
</div>
<a class="anchor" id="a82bc739b5188c1038a601975ffdd214d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BSAFile::fail </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Error handling. </p>
</div>
</div>
<a class="anchor" id="a1bb47e40c7c0e07ec255da137076dff7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceFiles.html#aba837ada2130f11d385768dcd8f0a950">Files::IStreamPtr</a> BSAFile::getFile </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a file contained in the archive. Throws an exception if the file doesn't exist. </p>
<dl class="section note"><dt>Note</dt><dd>Thread safe. </dd></dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classBsa_1_1BSAFile_a1bb47e40c7c0e07ec255da137076dff7_cgraph.svg" width="398" height="103"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classBsa_1_1BSAFile_a1bb47e40c7c0e07ec255da137076dff7_icgraph.svg" width="1304" height="226"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</p>
</div>
</div>
<a class="anchor" id="a0a254b09813d8f97bb057752a5e1e368"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceFiles.html#aba837ada2130f11d385768dcd8f0a950">Files::IStreamPtr</a> BSAFile::getFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structBsa_1_1BSAFile_1_1FileStruct.html">FileStruct</a> *&#160;</td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a file contained in the archive. </p>
<dl class="section note"><dt>Note</dt><dd>Thread safe. </dd></dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classBsa_1_1BSAFile_a0a254b09813d8f97bb057752a5e1e368_cgraph.svg" width="398" height="51"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</p>
</div>
</div>
<a class="anchor" id="a76516f3ef49832eec637504370d729de"></a>
<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="classint.html">int</a> BSAFile::getIndex </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>str</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the index of a given file name, or -1 if not found. </p>
<p>Get the index of a given file name, or -1 if not found </p>
<dl class="section note"><dt>Note</dt><dd>Thread safe. </dd></dl>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classBsa_1_1BSAFile_a76516f3ef49832eec637504370d729de_icgraph.svg" width="1432" height="182"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</p>
</div>
</div>
<a class="anchor" id="ad7972a16602af590be0ed8401b9413c2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classBsa_1_1BSAFile.html#ae6a6e808767366eaaa85f3457fe52f8e">FileList</a>&amp; Bsa::BSAFile::getList </td>
<td>(</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">
<p>Get a list of all files </p>
<dl class="section note"><dt>Note</dt><dd>Thread safe. </dd></dl>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classBsa_1_1BSAFile_ad7972a16602af590be0ed8401b9413c2_icgraph.svg" width="920" height="3047"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</p>
</div>
</div>
<a class="anchor" id="a5c854bff3a97dc947761e9a263b5a754"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BSAFile::open </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open an archive file. </p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classBsa_1_1BSAFile_a5c854bff3a97dc947761e9a263b5a754_icgraph.svg" width="1131" height="182"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</p>
</div>
</div>
<a class="anchor" id="a1fb9d39804ac8e6289e0a9cb068eed6b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BSAFile::readHeader </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read header information from the input source. </p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classBsa_1_1BSAFile_a1fb9d39804ac8e6289e0a9cb068eed6b_cgraph.svg" width="358" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="acc41171cecfc1ffa7e7d88802d84c8d2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string Bsa::BSAFile::filename</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used for error messages. </p>
</div>
</div>
<a class="anchor" id="a66118023437b97b4b19cde0ffbc04955"></a>
<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="classBsa_1_1BSAFile.html#ae6a6e808767366eaaa85f3457fe52f8e">FileList</a> Bsa::BSAFile::files</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Table of files in this archive. </p>
</div>
</div>
<a class="anchor" id="aa460901ec2de5dc76430c64df553b6cc"></a>
<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="classbool.html">bool</a> Bsa::BSAFile::isLoaded</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>True when an archive has been loaded. </p>
</div>
</div>
<a class="anchor" id="aa1376a1606f4a660739725cae9d8d1eb"></a>
<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="classBsa_1_1BSAFile.html#a0bbbd2273bfbf276be944ee632bc50cf">Lookup</a> Bsa::BSAFile::lookup</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a4f910406e0728505919eb549b758678d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;char&gt; Bsa::BSAFile::stringBuf</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Filename string buffer. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/travis/build/OpenMW/openmw/components/bsa/<a class="el" href="bsa__file_8hpp_source.html">bsa_file.hpp</a></li>
<li>/home/travis/build/OpenMW/openmw/components/bsa/<a class="el" href="bsa__file_8cpp.html">bsa_file.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jan 24 2017 02:05:56 for OpenMW by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>