RefBase.h

См. документацию.

/*
 * CntmLib - Подсчет ссылок, потоки, синхронизация, асинхронные процедуры, события
 * Copyright (c) 2005, Овсеевич Роман, CntmLib@mail.ru
 * _______________________________________________________________________________
 * Разрешено свободное использование, копирование, распространение, изменение
 * (изменение сведений об авторских правах запрещено). Запрещена продажа и 
 * включение всей библиотеки или ее частей в другие библиотеки. В сведениях об
 * авторских правах на программу (или сведениях о программе, об авторах, 
 * использованных средствах разработки и т.д.) должна быть указана информация
 * о библиотеке CntmLib, ее авторе и, возможно, сайте или email'е.
 * Библиотека поставляется "как есть", без каких-либо гарантий со стороны автора.
 */ 

#ifndef CNTM_REFBASE_H
#define CNTM_REFBASE_H
#include <Cntm/RefCount/IRefObject.h>
#include <Cntm/RefCount/RefObjectUsedException.h>

namespace Cntm
{

        namespace SpecUtils
        {
                template <typename T> class RefBasePtrProxy;
                template <typename T> class RefBasePtrPtrProxy;
        }

        /**
         * Основная реализация подсчета ссылок. Применяется в качестве базового класса или примеси для пользовательских классов, которые управляются подсчетом ссылок.
         * 
         * Обеспечивает подсчет кол-ва ссылок и самоуничтожение при их отсутствии. Конструктор устанавливает кол-во ссылок в 0. Деструктор данного класса объевлен виртуальным, что обеспечивает вызовы деструкторов производных классов.
         * 
         * Данный класс следует использовать когда в деструкторе не требуется работа с ссылочными указателями на данный объект (она невозможна, т.к. при выполнении деструктора объект уже находится в удаляемом состоянии). Данный класс подходит для большинства случаев реализации подсчета ссылок.
         * 
         * Ограничения:
         * - в конструкторах производных классов запрещено использовать ссылочные указатели на конструируемый объект.
         * - если объект был создан в статической памяти или в стеке, то использование ссылочных указателей с объектом запрещено (это ограничение можно обойти, используя метод RefPtr::SetPointerWithoutRefCounting()).
         * 
         * Данный класс обеспечивает многопоточность.
         * @author Овсеевич Р.
         * \ingroup RefCount
         */
        class RefBase: virtual public IRefObject
        {
        protected:

        /**
         * Конструктор. Устанавливает кол-во ссылок в 0. 
         */
                RefBase(): referenceCounter(0) {}

                /**
                 * Виртуальный деструктор. Проверяет кол-во ссылок на уничтожаемый объект.
                 * 
                 * Исключение: RefObjectUsedException - когда на объект еще имеются ссылки. Это исключение обрабатывается самой библиотекой и служит отладочным целям.
                 */
                virtual ~RefBase()
                {
                        // Если при уничтожении объекта на него еще сохраняются ссылки, то
                        // возбуждаем спец. исключение для информирования об этом, которое
                        // сами же и перехватываем (деструктор не должен использ. исключения).
                        if (!IsDeleteState())
                        {
                                try
                                {
                                        if (referenceCounter > 0 or referenceCounter < -1)
                                                throw RefObjectUsedException("Cntm::RefBase::~RefBase");
                                }
                                catch (...)
                                {                               
                                }
                        }
                }

        /**
         * Реализация IRefObject::DeleteInstance.
         * 
         * Уничтожает объект. 
         */
                void DeleteInstance() 
                { 
                        delete this;
                }
        
        private:

                friend class RefBaseEx;
                template <typename T> friend class SpecUtils::RefBasePtrProxy;
                template <typename T> friend class SpecUtils::RefBasePtrPtrProxy;

                /**
                 * Счетчик ссылок.
                 */
                int referenceCounter;

        /**
                 * Реализация IRefObject::IncRefCount. Метод синхронизирован критической секцией подсчета ссылок.
                 * 
                 * Увеличить кол-во ссылок. Возвращает true, если объект не находится в удаляемом состоянии и кол-во ссылок увеличено, иначе возвращается false.
         */
                bool IncRefCount() { return IncRefCountImpl(); }

        /**
         * Реализация IRefObject::DecRefCount. Метод синхронизирован критической секцией подсчета ссылок.
         * 
         * Уменьшить кол-во ссылок. Если счетчик ссылок достиг 0, то возвращается true, иначе возвращается false.
         */
                bool DecRefCount() { return DecRefCountImpl(); }

        /**
         * Специальная инлайн реализация увеличения кол-ва ссылок для оптимизации. Вызывается из IRefObject::IncRefCount. Метод синхронизирован критической секцией подсчета ссылок.
         * 
         * Увеличить кол-во ссылок. Возвращает true, если объект не находится в удаляемом состоянии и кол-во ссылок увеличено, иначе возвращается false.
         */
                bool IncRefCountImpl() 
                { 
                        // Т.к. изменения счетчика ссылок защищены глобальной критической секцией,
                        // то изменения счетчика можно выполнять в несколько действий.
                        if (++referenceCounter == 0)
                        {
                                // Объект был в удаляемом состоянии, возвращаем его туда обратно.
                                referenceCounter = -1;
                                return false;
                        }
                        return true;
                }
                
        /**
         * Специальная инлайн реализация уменьшения кол-ва ссылок для оптимизации. Вызывается из IRefObject::DecRefCount. Метод синхронизирован критической секцией подсчета ссылок.
         * 
         * Уменьшить кол-во ссылок. Если счетчик ссылок достиг 0, то возвращается true, иначе возвращается false.
         */
                bool DecRefCountImpl() 
                {
                        // Т.к. изменения счетчика ссылок защищены глобальной критической секцией,
                        // то изменения счетчика можно выполнять в несколько действий.
                        if (--referenceCounter == 0)
                        {
                                // Ссылок больше нет, переходим в удаляемое состояние.
                                referenceCounter = -1;
                                return true;
                        }
                        return false; 
                }
                
        /**
         * Возвращает true, если объект в удаляемом состоянии.
         */
                bool IsDeleteState() { return referenceCounter == -1; }

        /**
         * Установить счетчик ссылок в начальное значение, при условии, что
         * объект находится в удаляемом состоянии.
         */
                void ReinitReferenceCounter()
                {
                        SpecUtils::RefObjectImplUtils::CheckAndSetIntValue(
                                &referenceCounter, -1, 0);
                }
        };

}

#include <Cntm/RefCount/Internal/RefBaseOpsImpl.h>

#endif //CNTM_REFBASE_H

---