<!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/util/resource/pool.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('pool_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">pool.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_POOL_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define FIFE_POOL_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 <map></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <vector></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <string></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <iostream></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <cassert></span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="comment">// 3rd party library includes</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 <span class="preprocessor">#include "resource.h"</span>
<a name="l00039"></a>00039 <span class="preprocessor">#include "resource_location.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="l00043"></a>00043 <span class="keyword">struct </span>ResourceLocationComparator {
<a name="l00044"></a>00044 <span class="keywordtype">bool</span> operator()(<span class="keyword">const</span> ResourceLocation* r1, <span class="keyword">const</span> ResourceLocation* r2)<span class="keyword"> const</span>
<a name="l00045"></a>00045 <span class="keyword"> </span>{
<a name="l00046"></a>00046 <span class="keywordflow">return</span> r1->operator<(*r2);
<a name="l00047"></a>00047 }
<a name="l00048"></a>00048 };
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keyword">class </span>IResource;
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="keyword">enum</span> { RES_LOADED = 0x01, RES_NON_LOADED = 0x02};
<a name="l00053"></a>00053
<a name="l00061"></a><a class="code" href="class_f_i_f_e_1_1_pool.html">00061</a> <span class="keyword">class </span><a class="code" href="class_f_i_f_e_1_1_pool.html">Pool</a> {
<a name="l00062"></a>00062 <span class="keyword">public</span>:
<a name="l00065"></a><a class="code" href="class_f_i_f_e_1_1_pool.html#afec598cfc9551c3093c006dd2f9a70e3">00065</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="class_f_i_f_e_1_1_pool.html#afec598cfc9551c3093c006dd2f9a70e3">INVALID_ID</a> = -1;
<a name="l00066"></a>00066
<a name="l00070"></a>00070 <a class="code" href="class_f_i_f_e_1_1_pool.html#ab14b6b353730b5e56c1b330d7588ce48">Pool</a>(<span class="keyword">const</span> std::string& name);
<a name="l00071"></a>00071
<a name="l00074"></a>00074 <span class="keyword">virtual</span> <a class="code" href="class_f_i_f_e_1_1_pool.html#ad15922e3cf8ae3b5e6fd31f5db752a3c">~Pool</a>();
<a name="l00075"></a>00075
<a name="l00078"></a>00078 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_f_i_f_e_1_1_pool.html#a628f01396bf50d4ad472d4ddac4f0310">addResourceLoader</a>(<a class="code" href="class_f_i_f_e_1_1_resource_loader.html">ResourceLoader</a>* loader);
<a name="l00079"></a>00079
<a name="l00082"></a>00082 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_f_i_f_e_1_1_pool.html#ae71e5b9a745e8b9cbc90e6047413bc27">clearResourceLoaders</a>();
<a name="l00083"></a>00083
<a name="l00087"></a>00087 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="class_f_i_f_e_1_1_pool.html#a3407a81bc1f5497cde2f75db5d911f8c">addResourceFromLocation</a>(<a class="code" href="class_f_i_f_e_1_1_resource_location.html">ResourceLocation</a>* loc);
<a name="l00088"></a>00088
<a name="l00096"></a>00096 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="class_f_i_f_e_1_1_pool.html#a31b406b9de7aa7949e9d4c1f64ee2ac0">addResourceFromFile</a>(<span class="keyword">const</span> std::string& filename);
<a name="l00097"></a>00097
<a name="l00102"></a>00102 <span class="keyword">virtual</span> <a class="code" href="class_f_i_f_e_1_1_i_resource.html">IResource</a>& <span class="keyword">get</span>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index, <span class="keywordtype">bool</span> inc = <span class="keyword">false</span>);
<a name="l00103"></a>00103
<a name="l00109"></a>00109 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_f_i_f_e_1_1_pool.html#a738677b929739c0ccbf2d48860909d88">release</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index, <span class="keywordtype">bool</span> dec = <span class="keyword">false</span>);
<a name="l00110"></a>00110
<a name="l00116"></a>00116 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="class_f_i_f_e_1_1_pool.html#ac8b1f72d4714e373aaf1958b0d51fb12">purgeLoadedResources</a>();
<a name="l00117"></a>00117
<a name="l00120"></a>00120 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="class_f_i_f_e_1_1_pool.html#ac6f2ee63943a21c73326163eea480d9d">getResourceCount</a>(<span class="keywordtype">int</span> status);
<a name="l00121"></a>00121
<a name="l00124"></a>00124 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_f_i_f_e_1_1_pool.html#a261c345535de26b34df434f6abdaf7a1">printStatistics</a>();
<a name="l00125"></a>00125
<a name="l00128"></a>00128 <span class="keywordtype">void</span> <a class="code" href="class_f_i_f_e_1_1_pool.html#a150e01bb094f18fb4a8add5bef1c1106">sanityCheck</a>();
<a name="l00129"></a>00129
<a name="l00135"></a>00135 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_f_i_f_e_1_1_pool.html#a016d53c65173c1cbfb8657cd093a6e47">reset</a>();
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="keyword">protected</span>:
<a name="l00138"></a>00138 <span class="keyword">class </span>PoolEntry {
<a name="l00139"></a>00139 <span class="keyword">public</span>:
<a name="l00140"></a>00140 PoolEntry(): resource(0), location(0), loader(0) {}
<a name="l00141"></a>00141 ~PoolEntry() {
<a name="l00142"></a>00142 <span class="keyword">delete</span> location;
<a name="l00143"></a>00143 <span class="keyword">delete</span> resource;
<a name="l00144"></a>00144 }
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <span class="comment">// Pointer to the resource that is loaded.</span>
<a name="l00147"></a>00147 IResource* resource;
<a name="l00148"></a>00148 <span class="comment">// Location of the resource.</span>
<a name="l00149"></a>00149 ResourceLocation* location;
<a name="l00150"></a>00150 <span class="comment">// Resource loader.</span>
<a name="l00151"></a>00151 ResourceLoader* loader;
<a name="l00152"></a>00152 };
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="keywordtype">void</span> findAndSetProvider(PoolEntry& entry);
<a name="l00155"></a>00155
<a name="l00156"></a>00156 std::vector<PoolEntry*> m_entries;
<a name="l00157"></a>00157 <span class="keyword">typedef</span> std::map<ResourceLocation*, int, ResourceLocationComparator> ResourceLocationToEntry;
<a name="l00158"></a>00158 ResourceLocationToEntry m_location_to_entry;
<a name="l00159"></a>00159 std::vector<ResourceLoader*> m_loaders;
<a name="l00160"></a>00160 std::string m_name;
<a name="l00161"></a>00161 };
<a name="l00162"></a>00162
<a name="l00163"></a>00163 } <span class="comment">// FIFE</span>
<a name="l00164"></a>00164
<a name="l00165"></a>00165 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>pool.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>
