isingleton.h

Go to the documentation of this file.

/*
    Sheep - A Rigid Body Dynamics Engine
    Copyright (C) 2001-2004 Francois Beaune
    Contact: http://toxicengine.sourceforge.net/

    This file is part of Sheep.

    Sheep is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    Sheep is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Sheep; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef SHEEP_MISC_ISINGLETON_H
#define SHEEP_MISC_ISINGLETON_H

#include "config.h"

namespace sheep {

    /*

    Sample declaration:

        class C : public ISingleton<C> {
            friend class ISingleton<C>;
        public:
            ...

        private:
            C() { ... }
            virtual ~C() { ... }
        };

    Sample use:

        C::Instance().Foo();

    */

    template<typename T>
    class ISingleton {
    public:
        static T &Instance();

    protected:
        ISingleton() {}

        virtual ~ISingleton() = 0 {}    //!< Make this class abstract.

    private:
        ISingleton(const ISingleton<T> &);                  //!< Forbid use of copy constructor.
        ISingleton<T> &operator=(const ISingleton<T> &);    //!< Forbid use of '=' operator.
    };

#include "isingleton.inl"

}

#endif  // !SHEEP_MISC_ISINGLETON_H

---