<!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"/>
<title>FIFE: engine/core/vfs/raw/rawdata.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FIFE <span id="projectnumber">2008.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li id="searchli">
<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="files.html"><span>File List</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('rawdata_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">rawdata.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/***************************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2005-2008 by the FIFE team *</span>
<a name="l00003"></a>00003 <span class="comment"> * http://www.fifengine.de *</span>
<a name="l00004"></a>00004 <span class="comment"> * This file is part of FIFE. *</span>
<a name="l00005"></a>00005 <span class="comment"> * *</span>
<a name="l00006"></a>00006 <span class="comment"> * FIFE is free software; you can redistribute it and/or *</span>
<a name="l00007"></a>00007 <span class="comment"> * modify it under the terms of the GNU Lesser General Public *</span>
<a name="l00008"></a>00008 <span class="comment"> * License as published by the Free Software Foundation; either *</span>
<a name="l00009"></a>00009 <span class="comment"> * version 2.1 of the License, or (at your option) any later version. *</span>
<a name="l00010"></a>00010 <span class="comment"> * *</span>
<a name="l00011"></a>00011 <span class="comment"> * This library is distributed in the hope that it will be useful, *</span>
<a name="l00012"></a>00012 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of *</span>
<a name="l00013"></a>00013 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *</span>
<a name="l00014"></a>00014 <span class="comment"> * Lesser General Public License for more details. *</span>
<a name="l00015"></a>00015 <span class="comment"> * *</span>
<a name="l00016"></a>00016 <span class="comment"> * You should have received a copy of the GNU Lesser General Public *</span>
<a name="l00017"></a>00017 <span class="comment"> * License along with this library; if not, write to the *</span>
<a name="l00018"></a>00018 <span class="comment"> * Free Software Foundation, Inc., *</span>
<a name="l00019"></a>00019 <span class="comment"> * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *</span>
<a name="l00020"></a>00020 <span class="comment"> ***************************************************************************/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef FIFE_VFS_RAW_RAWDATA_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define FIFE_VFS_RAW_RAWDATA_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="comment">// Standard C++ library includes</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <vector></span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="comment">// Platform specific includes</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "util/base/fife_stdint.h"</span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="comment">// 3rd party library includes</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <boost/shared_ptr.hpp></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="comment">// FIFE includes</span>
<a name="l00035"></a>00035 <span class="comment">// These includes are split up in two parts, separated by one empty line</span>
<a name="l00036"></a>00036 <span class="comment">// First block: files included from the FIFE root src directory</span>
<a name="l00037"></a>00037 <span class="comment">// Second block: files included from the same folder</span>
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="preprocessor">#include "rawdatasource.h"</span>
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="keyword">namespace </span>FIFE {
<a name="l00042"></a>00042
<a name="l00048"></a><a class="code" href="class_f_i_f_e_1_1_raw_data.html">00048</a> <span class="keyword">class </span><a class="code" href="class_f_i_f_e_1_1_raw_data.html">RawData</a> {
<a name="l00049"></a>00049 <span class="keyword">public</span>:
<a name="l00050"></a>00050 <a class="code" href="class_f_i_f_e_1_1_raw_data.html">RawData</a>(<a class="code" href="class_f_i_f_e_1_1_raw_data_source.html">RawDataSource</a>* datasource);
<a name="l00051"></a>00051 <span class="keyword">virtual</span> ~<a class="code" href="class_f_i_f_e_1_1_raw_data.html">RawData</a>();
<a name="l00052"></a>00052
<a name="l00055"></a>00055 std::vector<uint8_t> <a class="code" href="class_f_i_f_e_1_1_raw_data.html#a78e03ca972278031ba43490e7dc8ebd6">getDataInBytes</a>();
<a name="l00056"></a>00056
<a name="l00059"></a>00059 std::vector<std::string> <a class="code" href="class_f_i_f_e_1_1_raw_data.html#a2e33082e394813e90ee745c48d3967f2">getDataInLines</a>();
<a name="l00060"></a>00060
<a name="l00061"></a>00061
<a name="l00066"></a>00066 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_f_i_f_e_1_1_raw_data.html#a9502f31b1bd465cb066694baeee47a45">getDataLength</a>() <span class="keyword">const</span>;
<a name="l00067"></a>00067
<a name="l00072"></a>00072 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_f_i_f_e_1_1_raw_data.html#a8ef520634f7c590debc3f1fe21e5ee92">getCurrentIndex</a>() <span class="keyword">const</span>;
<a name="l00073"></a>00073
<a name="l00079"></a>00079 <span class="keywordtype">void</span> <a class="code" href="class_f_i_f_e_1_1_raw_data.html#a7c202be9266be38dcbb3b70ca79d8111">setIndex</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index);
<a name="l00080"></a>00080
<a name="l00086"></a>00086 <span class="keywordtype">void</span> <a class="code" href="class_f_i_f_e_1_1_raw_data.html#aa7690da301a534b40d9748454202c928">moveIndex</a>(<span class="keywordtype">int</span> offset);
<a name="l00087"></a>00087
<a name="l00093"></a><a class="code" href="class_f_i_f_e_1_1_raw_data.html#a08b3bf07b1fd59ca80182938da8fd0f9">00093</a> <span class="keyword">template</span> <<span class="keyword">typename</span> T> T <a class="code" href="class_f_i_f_e_1_1_raw_data.html#a08b3bf07b1fd59ca80182938da8fd0f9">readSingle</a>() {
<a name="l00094"></a>00094 T val;
<a name="l00095"></a>00095 <a class="code" href="class_f_i_f_e_1_1_raw_data.html#a854568ebe8d1360f615928a4e85db84f">readInto</a>(reinterpret_cast<uint8_t*>(&val), <span class="keyword">sizeof</span>(T));
<a name="l00096"></a>00096 <span class="keywordflow">return</span> val;
<a name="l00097"></a>00097 }
<a name="l00098"></a>00098
<a name="l00105"></a>00105 <span class="keywordtype">void</span> <a class="code" href="class_f_i_f_e_1_1_raw_data.html#a854568ebe8d1360f615928a4e85db84f">readInto</a>(uint8_t* buffer, <span class="keywordtype">size_t</span> len);
<a name="l00106"></a>00106
<a name="l00108"></a>00108 uint8_t <a class="code" href="class_f_i_f_e_1_1_raw_data.html#a6244aa18645ae87333f778019b1e82db">read8</a>();
<a name="l00109"></a>00109
<a name="l00113"></a>00113 uint16_t <a class="code" href="class_f_i_f_e_1_1_raw_data.html#a1663689188ba896f969a4baa83573bfd">read16Little</a>();
<a name="l00114"></a>00114
<a name="l00119"></a>00119 uint32_t <a class="code" href="class_f_i_f_e_1_1_raw_data.html#ab5b051c4ee4766a61092a8f6526651e4">read32Little</a>();
<a name="l00120"></a>00120
<a name="l00125"></a>00125 uint16_t <a class="code" href="class_f_i_f_e_1_1_raw_data.html#af38e955b1dafe4e409f254b9b95446a8">read16Big</a>();
<a name="l00126"></a>00126
<a name="l00131"></a>00131 uint32_t <a class="code" href="class_f_i_f_e_1_1_raw_data.html#a9daf4f6cea1e786c59fbab6762f2a8ae">read32Big</a>();
<a name="l00132"></a>00132
<a name="l00139"></a>00139 std::string <a class="code" href="class_f_i_f_e_1_1_raw_data.html#a29a83e3a097b81fbb29becad39f1f535">readString</a>(<span class="keywordtype">size_t</span> len);
<a name="l00140"></a>00140
<a name="l00144"></a>00144 <span class="keywordtype">void</span> <a class="code" href="class_f_i_f_e_1_1_raw_data.html#ad0dfc60c45179765255b64e5f26c561c">read</a>(std::string& outbuffer, <span class="keywordtype">int</span> size=-1);
<a name="l00145"></a>00145
<a name="l00151"></a>00151 <span class="keywordtype">bool</span> <a class="code" href="class_f_i_f_e_1_1_raw_data.html#a966441b126e55e3a65fe332c2cde6445">getLine</a>(std::string& buffer);
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <span class="keyword">private</span>:
<a name="l00154"></a>00154 <a class="code" href="class_f_i_f_e_1_1_raw_data_source.html">RawDataSource</a>* m_datasource;
<a name="l00155"></a>00155 <span class="keywordtype">size_t</span> m_index_current;
<a name="l00156"></a>00156
<a name="l00157"></a>00157 <span class="keyword">template</span> <<span class="keyword">typename</span> T> T littleToHost(T value)<span class="keyword"> const </span>{
<a name="l00158"></a>00158 <span class="keywordflow">if</span> (littleEndian())
<a name="l00159"></a>00159 <span class="keywordflow">return</span> value;
<a name="l00160"></a>00160 <span class="keywordflow">else</span>
<a name="l00161"></a>00161 <span class="keywordflow">return</span> revert(value);
<a name="l00162"></a>00162 }
<a name="l00163"></a>00163
<a name="l00164"></a>00164 <span class="keyword">template</span> <<span class="keyword">typename</span> T> T bigToHost(T value)<span class="keyword"> const </span>{
<a name="l00165"></a>00165 <span class="keywordflow">if</span> (!littleEndian())
<a name="l00166"></a>00166 <span class="keywordflow">return</span> value;
<a name="l00167"></a>00167 <span class="keywordflow">else</span>
<a name="l00168"></a>00168 <span class="keywordflow">return</span> revert(value);
<a name="l00169"></a>00169 }
<a name="l00170"></a>00170
<a name="l00171"></a>00171 <span class="keyword">template</span> <<span class="keyword">typename</span> T> T revert(T value)<span class="keyword"> const </span>{
<a name="l00172"></a>00172 T retval;
<a name="l00173"></a>00173 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i < <span class="keyword">sizeof</span>(T); ++i)
<a name="l00174"></a>00174 reinterpret_cast<uint8_t*>(&retval)[i] = <span class="keyword">reinterpret_cast<</span>uint8_t*<span class="keyword">></span>(&value)[<span class="keyword">sizeof</span>(T)-1-i];
<a name="l00175"></a>00175
<a name="l00176"></a>00176 <span class="keywordflow">return</span> retval;
<a name="l00177"></a>00177 }
<a name="l00178"></a>00178
<a name="l00179"></a>00179 RawData(<span class="keyword">const</span> RawData&);
<a name="l00180"></a>00180 RawData& operator=(<span class="keyword">const</span> RawData&) { <span class="keywordflow">return</span> *<span class="keyword">this</span>; };
<a name="l00181"></a>00181
<a name="l00182"></a>00182 <span class="keyword">static</span> <span class="keywordtype">bool</span> littleEndian();
<a name="l00183"></a>00183 };
<a name="l00184"></a>00184 <span class="keyword">typedef</span> boost::shared_ptr<RawData> RawDataPtr;
<a name="l00185"></a>00185
<a name="l00186"></a>00186 <span class="keyword">class </span>IndexSaver {
<a name="l00187"></a>00187 <span class="keyword">public</span>:
<a name="l00188"></a>00188 IndexSaver(RawData* d) : m_rd(d), m_index(m_rd->getCurrentIndex()) {}
<a name="l00189"></a>00189
<a name="l00190"></a>00190 ~IndexSaver() {
<a name="l00191"></a>00191 m_rd->setIndex(m_index);
<a name="l00192"></a>00192 }
<a name="l00193"></a>00193
<a name="l00194"></a>00194 <span class="keyword">private</span>:
<a name="l00195"></a>00195 RawData* m_rd;
<a name="l00196"></a>00196 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_index;
<a name="l00197"></a>00197
<a name="l00198"></a>00198 IndexSaver(<span class="keyword">const</span> IndexSaver&);
<a name="l00199"></a>00199 IndexSaver& operator=(<span class="keyword">const</span> IndexSaver&) { <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
<a name="l00200"></a>00200 };
<a name="l00201"></a>00201
<a name="l00202"></a>00202 }<span class="comment">//FIFE</span>
<a name="l00203"></a>00203
<a name="l00204"></a>00204 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>rawdata.h</b> </li>
<li class="footer">Generated on Sun Jul 10 2011 for FIFE by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</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>
</body>
</html>
