<!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: Exception.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">Exception.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="Exception_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="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#ifndef _GG_Exception_h_</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"></span><span class="preprocessor">#define _GG_Exception_h_</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <<a class="code" href="Export_8h.html" title="Contains the GG_API macro, which is used to specify which class and function symbols will be exported...">GG/Export.h</a>></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <stdexcept></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</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> <span class="keyword">namespace </span>GG {</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="classGG_1_1ExceptionBase.html"> 45</a></span> <span class="keyword">class </span>GG_API <a class="code" href="classGG_1_1ExceptionBase.html" title="The base class for all GG exceptions.">ExceptionBase</a> : <span class="keyword">public</span> std::exception</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> {</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="code" href="classGG_1_1ExceptionBase.html#a1b05c41f4d02e2cd909c98e4649b6cff"> 48</a></span>  <a class="code" href="classGG_1_1ExceptionBase.html#a1b05c41f4d02e2cd909c98e4649b6cff" title="default ctor">ExceptionBase</a>() throw() {} </div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="code" href="classGG_1_1ExceptionBase.html#a6259628a356085bad3f84d333c8d2c9d"> 49</a></span>  <a class="code" href="classGG_1_1ExceptionBase.html#a6259628a356085bad3f84d333c8d2c9d" title="a ctor that allows the throwing code to include a text message">ExceptionBase</a>(<span class="keyword">const</span> std::string& msg) <span class="keywordflow">throw</span>() : m_msg(msg) {} </div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="classGG_1_1ExceptionBase.html#a2e7ee241d114ad221393845a34b00e02"> 50</a></span>  <a class="code" href="classGG_1_1ExceptionBase.html#a2e7ee241d114ad221393845a34b00e02" title="dtor required by std::exception">~ExceptionBase</a>() throw() {} </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* type() <span class="keyword">const</span> throw() = 0; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  virtual const <span class="keywordtype">char</span>* what() const throw() {<span class="keywordflow">return</span> m_msg.c_str();}</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  std::string m_msg; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> };</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="code" href="Exception_8h.html#a2c6d1319984159292a38a0661aac0fc5"> 61</a></span> <span class="preprocessor">#define GG_EXCEPTION( name ) \</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor"> class GG_API name : public ExceptionBase \</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor"> { \</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor"> public: \</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor"> name () throw() : ExceptionBase() {} \</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor"> name (const std::string& msg) throw() : ExceptionBase(msg) {} \</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor"> virtual const char* type() const throw() \</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor"> {return "GG::" # name ;} \</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor"> };</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="code" href="Exception_8h.html#a5f0411ffac5a6574423999f74c1a4bad"> 74</a></span> <span class="preprocessor">#define GG_ABSTRACT_EXCEPTION( name ) \</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"> class GG_API name : public ExceptionBase \</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor"> { \</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor"> public: \</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor"> name () throw() : ExceptionBase() {} \</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor"> name (const std::string& msg) throw() : ExceptionBase(msg) {} \</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor"> virtual const char* type() const throw() = 0; \</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor"> };</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00086"></a><span class="lineno"><a class="code" href="Exception_8h.html#a682a3fa1018b805ef5461feed2540863"> 86</a></span> <span class="preprocessor">#define GG_CONCRETE_EXCEPTION( name, class_name, superclass ) \</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor"> class GG_API name : public superclass \</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor"> { \</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor"> public: \</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor"> name () throw() : superclass () {} \</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor"> name (const std::string& msg) throw() : superclass (msg) {} \</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor"> virtual const char* type() const throw() \</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor"> {return # class_name "::" # name ;} \</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="l00096"></a><span class="lineno"> 96</span> } <span class="comment">// namespace GG</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</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>
