source: OGRE/trunk/ogrenew/Docs/api/html/OgreException_8h-source.html @ 657

Revision 657, 16.5 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>OgreException.h Source File - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>OgreException.h</h1><a href="OgreException_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span>
1100002 <span class="comment">-----------------------------------------------------------------------------</span>
1200003 <span class="comment">This source file is part of OGRE</span>
1300004 <span class="comment">(Object-oriented Graphics Rendering Engine)</span>
1400005 <span class="comment">For the latest info, see http://www.ogre3d.org/</span>
1500006 <span class="comment"></span>
1600007 <span class="comment">Copyright (c) 2000-2005 The OGRE Team</span>
1700008 <span class="comment">Also see acknowledgements in Readme.html</span>
1800009 <span class="comment"></span>
1900010 <span class="comment">This program is free software; you can redistribute it and/or modify it under</span>
2000011 <span class="comment">the terms of the GNU Lesser General Public License as published by the Free Software</span>
2100012 <span class="comment">Foundation; either version 2 of the License, or (at your option) any later</span>
2200013 <span class="comment">version.</span>
2300014 <span class="comment"></span>
2400015 <span class="comment">This program is distributed in the hope that it will be useful, but WITHOUT</span>
2500016 <span class="comment">ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
2600017 <span class="comment">FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</span>
2700018 <span class="comment"></span>
2800019 <span class="comment">You should have received a copy of the GNU Lesser General Public License along with</span>
2900020 <span class="comment">this program; if not, write to the Free Software Foundation, Inc., 59 Temple</span>
3000021 <span class="comment">Place - Suite 330, Boston, MA 02111-1307, USA, or go to</span>
3100022 <span class="comment">http://www.gnu.org/copyleft/lesser.txt.</span>
3200023 <span class="comment">-----------------------------------------------------------------------------</span>
3300024 <span class="comment">*/</span>
3400025 <span class="preprocessor">#ifndef __Exception_H_</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define __Exception_H_</span>
3600027 <span class="preprocessor"></span>
3700028 <span class="comment">// Precompiler options</span>
3800029 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
3900030
4000031 <span class="preprocessor">#include "<a class="code" href="OgreString_8h.html">OgreString.h</a>"</span>
4100032
42<a name="l00033"></a><a class="code" href="OgreException_8h.html#a0">00033</a> <span class="preprocessor">#define OGRE_EXCEPT( num, desc, src ) throw( Ogre::Exception( num, desc, src, __FILE__, __LINE__ ) )</span>
4300034 <span class="preprocessor"></span>
4400035 <span class="comment">// Stack unwinding options</span>
4500036 <span class="comment">// OgreUnguard and OgreUnguardRet are deprecated</span>
4600037 <span class="preprocessor">#if OGRE_STACK_UNWINDING == 1</span>
4700038 <span class="preprocessor"></span><span class="preprocessor">#   if OGRE_COMPILER != OGRE_COMPILER_BORL</span>
4800039 <span class="preprocessor"></span><span class="preprocessor">#       define OgreGuard( a ) Ogre::AutomaticGuardUnguard _auto_guard_object( (a) )</span>
4900040 <span class="preprocessor"></span><span class="preprocessor">#   else</span>
5000041 <span class="preprocessor"></span><span class="preprocessor">#       define OgreGuard( a ) Ogre::AutomaticGuardUnguard _auto_guard_object( __FUNC__ )</span>
5100042 <span class="preprocessor"></span><span class="preprocessor">#   endif</span>
5200043 <span class="preprocessor"></span>
5300044 <span class="preprocessor">#   define OgreUnguard() </span>
5400045 <span class="preprocessor"></span><span class="preprocessor">#   define OgreUnguardRet( a ) return a</span>
5500046 <span class="preprocessor"></span>
5600047 <span class="preprocessor">#else</span>
57<a name="l00048"></a><a class="code" href="OgreException_8h.html#a1">00048</a> <span class="preprocessor"></span><span class="preprocessor">#   define OgreGuard( a )</span>
58<a name="l00049"></a><a class="code" href="OgreException_8h.html#a2">00049</a> <span class="preprocessor"></span><span class="preprocessor">#   define OgreUnguard()</span>
59<a name="l00050"></a><a class="code" href="OgreException_8h.html#a3">00050</a> <span class="preprocessor"></span><span class="preprocessor">#   define OgreUnguardRet( a ) return a</span>
6000051 <span class="preprocessor"></span>
6100052 <span class="preprocessor">#endif</span>
6200053 <span class="preprocessor"></span>
6300054 <span class="comment">// Backwards compatibility with old assert mode definitions</span>
6400055 <span class="preprocessor">#if OGRE_RELEASE_ASSERT == 1</span>
6500056 <span class="preprocessor"></span><span class="preprocessor">#   define OGRE_ASSERT_MODE 1</span>
6600057 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
6700058 <span class="preprocessor"></span>
6800059 <span class="comment">// Check for OGRE assert mode</span>
6900060
7000061 <span class="comment">// RELEASE_EXCEPTIONS mode</span>
7100062 <span class="preprocessor">#if OGRE_ASSERT_MODE == 1</span>
7200063 <span class="preprocessor"></span><span class="preprocessor">#   ifdef _DEBUG</span>
7300064 <span class="preprocessor"></span><span class="preprocessor">#       define OgreAssert( a, b ) assert( (a) &amp;&amp; (b) )</span>
7400065 <span class="preprocessor"></span>
7500066 <span class="preprocessor">#   else</span>
7600067 <span class="preprocessor"></span><span class="preprocessor">#       if OGRE_COMP != OGRE_COMPILER_BORL</span>
7700068 <span class="preprocessor"></span><span class="preprocessor">#           define OgreAssert( a, b ) if( !(a) ) OGRE_EXCEPT( Ogre::Exception::ERR_RT_ASSERTION_FAILED, (b), "no function info")</span>
7800069 <span class="preprocessor"></span><span class="preprocessor">#       else</span>
7900070 <span class="preprocessor"></span><span class="preprocessor">#           define OgreAssert( a, b ) if( !(a) ) OGRE_EXCEPT( Ogre::Exception::ERR_RT_ASSERTION_FAILED, (b), __FUNC__ )</span>
8000071 <span class="preprocessor"></span><span class="preprocessor">#       endif</span>
8100072 <span class="preprocessor"></span>
8200073 <span class="preprocessor">#   endif</span>
8300074 <span class="preprocessor"></span>
8400075 <span class="comment">// EXCEPTIONS mode</span>
8500076 <span class="preprocessor">#elif OGRE_ASSERT_MODE == 2</span>
8600077 <span class="preprocessor"></span><span class="preprocessor">#   if OGRE_COMP != OGRE_COMPILER_BORL</span>
8700078 <span class="preprocessor"></span><span class="preprocessor">#       define OgreAssert( a, b ) if( !(a) ) OGRE_EXCEPT( Ogre::Exception::ERR_RT_ASSERTION_FAILED, (b), "no function info")</span>
8800079 <span class="preprocessor"></span><span class="preprocessor">#   else</span>
8900080 <span class="preprocessor"></span><span class="preprocessor">#       define OgreAssert( a, b ) if( !(a) ) OGRE_EXCEPT( Ogre::Exception::ERR_RT_ASSERTION_FAILED, (b), __FUNC__ )</span>
9000081 <span class="preprocessor"></span><span class="preprocessor">#   endif</span>
9100082 <span class="preprocessor"></span>
9200083 <span class="comment">// STANDARD mode</span>
9300084 <span class="preprocessor">#else</span>
94<a name="l00085"></a><a class="code" href="OgreException_8h.html#a4">00085</a> <span class="preprocessor"></span><span class="preprocessor">#   define OgreAssert( a, b ) assert( (a) &amp;&amp; (b) )</span>
9500086 <span class="preprocessor"></span>
9600087 <span class="preprocessor">#endif</span>
9700088 <span class="preprocessor"></span>
98<a name="l00089"></a><a class="code" href="OgreException_8h.html#a5">00089</a> <span class="preprocessor">#define OGRE_CALL_STACK_DEPTH 512</span>
9900090 <span class="preprocessor"></span>
10000091 <span class="keyword">namespace </span>Ogre {
101<a name="l00105"></a><a class="code" href="classOgre_1_1Exception.html">00105</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> Exception
10200106     {
10300107     <span class="keyword">protected</span>:
104<a name="l00108"></a><a class="code" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp0">00108</a>         <span class="keywordtype">long</span> line;
105<a name="l00109"></a><a class="code" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp1">00109</a>         <span class="keywordtype">int</span> number;
106<a name="l00110"></a><a class="code" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp2">00110</a>         <a class="code" href="namespaceOgre.html#a426">String</a> description;
107<a name="l00111"></a><a class="code" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp3">00111</a>         <a class="code" href="namespaceOgre.html#a426">String</a> source;
108<a name="l00112"></a><a class="code" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp4">00112</a>         <a class="code" href="namespaceOgre.html#a426">String</a> file;
109<a name="l00113"></a><a class="code" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp5">00113</a>         <a class="code" href="namespaceOgre.html#a422">ushort</a> stackDepth;
110<a name="l00114"></a><a class="code" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiont0">00114</a>         <span class="keyword">static</span> Exception* last;
11100115
112<a name="l00116"></a><a class="code" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiont1">00116</a>         <span class="keyword">static</span> <a class="code" href="namespaceOgre.html#a426">String</a> msFunctionStack[ <a class="code" href="OgreException_8h.html#a5">OGRE_CALL_STACK_DEPTH</a> ];
113<a name="l00117"></a><a class="code" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiont2">00117</a>         <span class="keyword">static</span> <a class="code" href="namespaceOgre.html#a422">ushort</a>   msStackDepth;
11400118     <span class="keyword">public</span>:
115<a name="l00124"></a><a class="code" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionw11">00124</a>         <span class="keyword">enum</span> ExceptionCodes {
11600125             UNIMPLEMENTED_FEATURE,
11700126             ERR_CANNOT_WRITE_TO_FILE,
11800127             ERR_NO_RENDERSYSTEM_SELECTED,
11900128             ERR_DIALOG_OPEN_ERROR,
12000129             ERR_INVALIDPARAMS,
12100130             ERR_RENDERINGAPI_ERROR,
12200131             ERR_DUPLICATE_ITEM,
12300132             ERR_ITEM_NOT_FOUND,
12400133             ERR_FILE_NOT_FOUND,
12500134             ERR_INTERNAL_ERROR,
12600135             ERR_RT_ASSERTION_FAILED
12700136         };
12800137
12900140         Exception( <span class="keywordtype">int</span> number, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; description, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; source );
13000141
13100144         Exception( <span class="keywordtype">int</span> number, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; description, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; source, <span class="keywordtype">char</span>* file, <span class="keywordtype">long</span> line );
13200145
13300148         Exception(<span class="keyword">const</span> Exception&amp; rhs);
13400149
13500152         <span class="keywordtype">void</span> operator = (<span class="keyword">const</span> Exception&amp; rhs);
13600153
13700164         <a class="code" href="namespaceOgre.html#a426">String</a> getFullDescription(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
13800165
13900168         <span class="keywordtype">int</span> getNumber(<span class="keywordtype">void</span>) <span class="keyword">const</span> <span class="keywordflow">throw</span>();
14000169
141<a name="l00172"></a><a class="code" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiona6">00172</a>         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a> &amp;getSource()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> source; }
14200173
143<a name="l00176"></a><a class="code" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiona7">00176</a>         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a> &amp;getFile()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> file; }
14400177
145<a name="l00180"></a><a class="code" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiona8">00180</a>         <span class="keywordtype">long</span> getLine()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> line; }
14600181
147<a name="l00186"></a><a class="code" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiona9">00186</a>         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a> &amp;getDescription(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> description; }
14800187
14900190         <span class="keyword">static</span> Exception* getLastException(<span class="keywordtype">void</span>) <span class="keywordflow">throw</span>();
15000191
15100194         <span class="keyword">static</span> <span class="keywordtype">void</span> _pushFunction( <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; strFuncName ) <span class="keywordflow">throw</span>();
15200197         <span class="keyword">static</span> <span class="keywordtype">void</span> _popFunction() <span class="keywordflow">throw</span>();
15300198
15400199         
15500200     };
15600201
157<a name="l00203"></a><a class="code" href="classOgre_1_1AutomaticGuardUnguard.html">00203</a>     <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> AutomaticGuardUnguard {
15800204     <span class="keyword">public</span>:
159<a name="l00205"></a><a class="code" href="classOgre_1_1AutomaticGuardUnguard.html#Ogre_1_1AutomaticGuardUnguarda0">00205</a>         AutomaticGuardUnguard(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; funcName) <span class="keywordflow">throw</span>()
16000206         {
16100207             Exception::_pushFunction(funcName);
16200208         }
163<a name="l00209"></a><a class="code" href="classOgre_1_1AutomaticGuardUnguard.html#Ogre_1_1AutomaticGuardUnguarda1">00209</a>         ~AutomaticGuardUnguard() <span class="keywordflow">throw</span>()
16400210         {
16500211             Exception::_popFunction();
16600212         }
16700213     };
16800214
16900215 } <span class="comment">// Namespace Ogre</span>
17000216 <span class="preprocessor">#endif</span>
171</pre></div><hr>
172<p>
173Copyright &copy; 2000-2005 by The OGRE Team<br />
174<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
175This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
176                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
177                <Work rdf:about="">
178                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
179        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
180                </Work>
181                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
182
183Last modified Sun Feb 12 12:59:44 2006
184</p>
185</body>
186</html>
Note: See TracBrowser for help on using the repository browser.