OGRE: OgreSingleton.h Source File - OGRE Documentation

# OgreSingleton.h

Go to the documentation of this file.

    00001 /*
    00002 -----------------------------------------------------------------------------
    00003 This source file is part of OGRE
    00004     (Object-oriented Graphics Rendering Engine)
    00005 For the latest info, see http://www.ogre3d.org/
    00006
    00007 Copyright (c) 2000-2009 Torus Knot Software Ltd
    00008
    00009 Permission is hereby granted, free of charge, to any person obtaining a copy
    00010 of this software and associated documentation files (the "Software"), to deal
    00011 in the Software without restriction, including without limitation the rights
    00012 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    00013 copies of the Software, and to permit persons to whom the Software is
    00014 furnished to do so, subject to the following conditions:
    00015
    00016 The above copyright notice and this permission notice shall be included in
    00017 all copies or substantial portions of the Software.
    00018
    00019 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00020 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00021 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    00022 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00023 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    00024 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    00025 THE SOFTWARE.
    00026 -----------------------------------------------------------------------------
    00027 */
    00028 /* Original version Copyright (C) Scott Bilas, 2000.
    00029  * All rights reserved worldwide.
    00030  *
    00031  * This software is provided "as is" without express or implied
    00032  * warranties. You may freely copy and compile this source into
    00033  * applications you distribute provided that the copyright text
    00034  * below is included in the resulting source code, for example:
    00035  * "Portions Copyright (C) Scott Bilas, 2000"
    00036  */
    00037 #ifndef _SINGLETON_H__
    00038 #define _SINGLETON_H__
    00039
    00040 // Added by Steve Streeting for Ogre
    00041 #include "OgrePrerequisites.h"
    00042 #include "OgreHeaderPrefix.h"
    00043
    00044 #if OGRE_COMPILER == OGRE_COMPILER_MSVC
    00045 // Turn off warnings generated by this singleton implementation
    00046 #   pragma warning (disable : 4311)
    00047 #   pragma warning (disable : 4312)
    00048 #endif
    00049
    00050 #if defined ( OGRE_GCC_VISIBILITY )
    00051 #   pragma GCC visibility push(default)
    00052 #endif
    00053 namespace Ogre {
    00061 // End SJS additions
    00064     template <typename T> class Singleton
    00065     {
    00066     private:
    00068         Singleton(const Singleton<T> &);
    00069
    00071         Singleton& operator=(const Singleton<T> &);
    00072
    00073     protected:
    00074
    00075         static T* ms_Singleton;
    00076
    00077     public:
    00078         Singleton( void )
    00079         {
    00080             assert( !ms_Singleton );
    00081 #if defined( _MSC_VER ) && _MSC_VER < 1200
    00082             int offset = (int)(T*)1 - (int)(Singleton <T>*)(T*)1;
    00083             ms_Singleton = (T*)((int)this + offset);
    00084 #else
    00085         ms_Singleton = static_cast< T* >( this );
    00086 #endif
    00087         }
    00088         ~Singleton( void )
    00089             {  assert( ms_Singleton );  ms_Singleton = 0;  }
    00090         static T& getSingleton( void )
    00091         {   assert( ms_Singleton );  return ( *ms_Singleton ); }
    00092         static T* getSingletonPtr( void )
    00093         { return ms_Singleton; }
    00094     };
    00098 }
    00099 #if defined ( OGRE_GCC_VISIBILITY )
    00100 #   pragma GCC visibility pop
    00101 #endif
    00102
    00103 #include "OgreHeaderSuffix.h"
    00104 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:52