Source: kstaticdeleter.h

# Source: kstaticdeleter.h |
Annotated List
Files
Globals
Hierarchy
Index

    /*
     * This file is part of the KDE Libraries
     * Copyright (C) 2000 Stephan Kulow
     *               2001 KDE Team
     *
     * This library is free software; you can redistribute it and/or
     * modify it under the terms of the GNU Library General Public
     * License as published by the Free Software Foundation; either
     * version 2 of the License, or (at your option) any later version.
     *
     * This library 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
     * Library General Public License for more details.
     *
     * You should have received a copy of the GNU Library General Public License
     * along with this library; see the file COPYING.LIB.  If not, write to
     * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
     * Boston, MA 02111-1307, USA.
     *
     */

    #ifndef _KSTATIC_DELETER_H_
    #define _KSTATIC_DELETER_H_

    #include

    /**
     * Static deleters are used to manage static resources. They can register
     * themselves with @KGlobal. KGlobal will call @ref destructObject() when
     * @ref KGlobal::deleteStaticDeleters() is called or when it the process
     * finishes.
     *
     * @see KStaticDeleter
     * @see KGlobal::registerStaticDeleter()
     * @see KGlobal::unregisterStaticDeleter()
     * @see KGlobal::deleteStaticDeleters()
     */
    class KStaticDeleterBase {
    public:
        virtual ~KStaticDeleterBase() { }
        /**
         * Should destruct the resources managed by this KStaticDeleterBase.
         * Usually you also want to call it in your destructor.
         * @see KGlobal::deleteStaticDeleters()
         */
        virtual void destructObject();
    };

    /**
     * Little helper class to clean up static objects that are
     * held as pointer.
     * When the library is unloaded, or the app terminated, all static deleters
     * are destroyed, which in turn destroys those static objects properly.
     *
     * A typical use is
     *
     * static KStaticDeleter sd;
     *
     * MyClass::self() {
     *   if (!_self) { sd.setObject(_self, new MyClass()); }
     * }
     *
     */
    template class KStaticDeleter : public KStaticDeleterBase {
    public:
        KStaticDeleter() { deleteit = 0; globalReference = 0; array = false; }
        /**
         * Sets the object to delete and registers the object to be
         * deleted to KGlobal. If the given object is 0, the former
         * registration is unregistered.
         * @param isArray tells the destructor to delete an array instead of an object
         * @deprecated See the other setObject variant.
         **/
        type *setObject( type *obj, bool isArray = false) {
            deleteit = obj;
            globalReference = 0;
    	array = isArray;
    	if (obj)
                KGlobal::registerStaticDeleter(this);
    	else
    	    KGlobal::unregisterStaticDeleter(this);
            return obj;
        }
        /**
         * Sets the object to delete and registers the object to be
         * deleted to KGlobal. If the given object is 0, the former
         * registration is unregistered.
         * @param globalRef the static pointer where this object is stored
         * This pointer will be reset to 0 after deletion of the object.
         * @param isArray tells the destructor to delete an array instead of an object
         **/
        type *setObject( type* & globalRef, type *obj, bool isArray = false) {
            globalReference = &globalRef;
            deleteit = obj;
    	array = isArray;
    	if (obj)
                KGlobal::registerStaticDeleter(this);
    	else
    	    KGlobal::unregisterStaticDeleter(this);
            globalRef = obj;
    	return obj;
        }

        /**
         * Destructs the object. This has the same effect as deleting
         * the KStaticDeleter.
         */
        virtual void destructObject() {
            if (globalReference)
               *globalReference = 0;
    	if (array)
    	   delete [] deleteit;
    	else
    	   delete deleteit;
        	deleteit = 0;
        }
        virtual ~KStaticDeleter() {
        	KGlobal::unregisterStaticDeleter(this);
    	destructObject();
        }
    private:
        type *deleteit;
        type **globalReference;
        bool array;
    };

    #endif

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:15 2003, using kdoc 2.0a54.