<!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"/>
<title>GG: Enum.h Source File</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="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">GG
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1 -->
<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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_a8649c70aabfef076611d3be10291d33.html">GG</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Enum.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="Enum_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// -*- C++ -*-</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/* GG is a GUI for SDL and OpenGL.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Copyright (C) 2003-2008 T. Zachary Laine</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> modify it under the terms of the GNU Lesser General Public License</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> as published by the Free Software Foundation; either version 2.1</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> </span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> This library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> </span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> License along with this library; if not, write to the Free</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> 02111-1307 USA</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> If you do not wish to comply with the terms of the LGPL please</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> contact the author as other terms are available for a fee.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> </span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> Zach Laine</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> whatwasthataddress@gmail.com */</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#ifndef _GG_Enum_h_</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor"></span><span class="preprocessor">#define _GG_Enum_h_</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <boost/config.hpp></span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include <map></span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">namespace </span>GG {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="code" href="structGG_1_1EnumMapBase.html"> 42</a></span> <span class="keyword">struct </span><a class="code" href="structGG_1_1EnumMapBase.html" title="A base type for all templated EnumMap types.">EnumMapBase</a></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  BOOST_STATIC_CONSTANT(<span class="keywordtype">long</span> <span class="keywordtype">int</span>, BAD_VALUE = -5000000);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="code" href="structGG_1_1EnumMapBase.html#a9f18a08e3400d35330361deb188be840"> 46</a></span>  <span class="keyword">virtual</span> <a class="code" href="structGG_1_1EnumMapBase.html#a9f18a08e3400d35330361deb188be840" title="Virtual dtor.">~EnumMapBase</a>() {} </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> std::string& <a class="code" href="structGG_1_1EnumMapBase.html#a04cbc636bf1b7798b42b3e467c224907">FromEnum</a>(<span class="keywordtype">long</span> <span class="keywordtype">int</span> i) <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">virtual</span> <span class="keywordtype">long</span> <span class="keywordtype">int</span> <a class="code" href="structGG_1_1EnumMapBase.html#a726de246b498b73aba5359c8a7e5e6fd">FromString</a> (<span class="keyword">const</span> std::string& str) <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> };</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="code" href="structGG_1_1EnumMap.html"> 62</a></span> <span class="keyword">template</span> <<span class="keyword">class</span> E> <span class="keyword">struct </span><a class="code" href="structGG_1_1EnumMap.html" title="A mapping between the values of an enum and the string representations of the enum's values...">EnumMap</a> : <a class="code" href="structGG_1_1EnumMapBase.html" title="A base type for all templated EnumMap types.">EnumMapBase</a></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> {</div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="code" href="structGG_1_1EnumMap.html#a499ccb881ed5a5f4d5f2cdaaee779127"> 64</a></span>  <span class="keyword">virtual</span> <a class="code" href="structGG_1_1EnumMap.html#a499ccb881ed5a5f4d5f2cdaaee779127" title="Virtual dtor.">~EnumMap</a>() {} </div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="code" href="structGG_1_1EnumMap.html#aae7ed1339695ffa83ace609ab61fe95f"> 65</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> std::string& <a class="code" href="structGG_1_1EnumMap.html#aae7ed1339695ffa83ace609ab61fe95f">FromEnum</a>(<span class="keywordtype">long</span> <span class="keywordtype">int</span>)<span class="keyword"> const</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keyword"> </span>{ <span class="keyword">static</span> std::string empty; <span class="keywordflow">return</span> empty; }</div>
<div class="line"><a name="l00067"></a><span class="lineno"><a class="code" href="structGG_1_1EnumMap.html#ab3002d6df0f711960e5b7a6f31d9ed2e"> 67</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">long</span> <span class="keywordtype">int</span> <a class="code" href="structGG_1_1EnumMap.html#ab3002d6df0f711960e5b7a6f31d9ed2e">FromString</a> (<span class="keyword">const</span> std::string&)<span class="keyword"> const </span>{<span class="keywordflow">return</span> 0;}</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> };</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="code" href="namespaceGG.html#ae7ae6563930ab8e329b2526aa18c9eb3"> 72</a></span> <span class="keyword">template</span> <<span class="keyword">class</span> E> <a class="code" href="structGG_1_1EnumMap.html" title="A mapping between the values of an enum and the string representations of the enum's values...">EnumMap<E></a> <a class="code" href="namespaceGG.html#ae7ae6563930ab8e329b2526aa18c9eb3">GetEnumMap</a>()</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> {</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">static</span> <a class="code" href="structGG_1_1EnumMap.html" title="A mapping between the values of an enum and the string representations of the enum's values...">EnumMap<E></a> enum_map;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">return</span> enum_map;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> }</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="code" href="Enum_8h.html#a4d0a16fd972ecd9aeb9d1f410dfe4685"> 88</a></span> <span class="preprocessor">#define GG_ENUM_MAP_BEGIN( name ) \</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">template <> struct EnumMap< name > : EnumMapBase \</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor">{ \</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor"> typedef name EnumType; \</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor"> typedef std::map<EnumType, std::string> MapType; \</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor"> EnumMap () \</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="preprocessor"> {</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00098"></a><span class="lineno"><a class="code" href="Enum_8h.html#abd261e84febc33093021ec284a870bfe"> 98</a></span> <span class="preprocessor">#define GG_ENUM_MAP_INSERT( value ) m_map[ value ] = #value ;</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00102"></a><span class="lineno"><a class="code" href="Enum_8h.html#a8491f1bc4e9dd8f62489dab7eac662ca"> 102</a></span> <span class="preprocessor">#define GG_ENUM_MAP_END \</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor"> } \</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor"> virtual const std::string& FromEnum(long int i) const \</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor"> { \</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor"> static const std::string ERROR_STR; \</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor"> std::map<EnumType, std::string>::const_iterator it = \</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor"> m_map.find(EnumType(i)); \</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor"> return it == m_map.end() ? ERROR_STR : it->second; \</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor"> } \</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor"> long int FromString (const std::string &str) const \</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor"> { \</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor"> for (MapType::const_iterator it = m_map.begin(); \</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor"> it != m_map.end(); \</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor"> ++it) { \</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor"> if (it->second == str) \</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor"> return it->first; \</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor"> } \</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor"> return BAD_VALUE; \</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor"> } \</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor"> MapType m_map; \</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="preprocessor">};</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00126"></a><span class="lineno"><a class="code" href="Enum_8h.html#aeaf16da5e849135eb60ba1e18e8d11f8"> 126</a></span> <span class="preprocessor">#define GG_ENUM_STREAM_IN( name ) \</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="preprocessor"> inline std::istream& operator>>(std::istream& is, name& v) \</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="preprocessor"> { \</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="preprocessor"> std::string str; \</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="preprocessor"> is >> str; \</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor"> v = name (GG::GetEnumMap< name >().FromString(str)); \</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="preprocessor"> return is; \</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor"> }</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00137"></a><span class="lineno"><a class="code" href="Enum_8h.html#a2860ea0bc28af5ef1a48ace97d4c4683"> 137</a></span> <span class="preprocessor">#define GG_ENUM_STREAM_OUT( name ) \</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="preprocessor"> inline std::ostream& operator<<(std::ostream& os, name v) \</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="preprocessor"> { \</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="preprocessor"> os << GG::GetEnumMap< name >().FromEnum(v); \</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="preprocessor"> return os; \</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="preprocessor"> }</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> } <span class="comment">// namespace GG</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 15 2012 15:13:30 for GG by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1
</small></address>
</body>
</html>
