NoRefPtrRegisterEx.h

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

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

#ifndef CNTM_NOREFPTRREGISTEREX_H
#define CNTM_NOREFPTRREGISTEREX_H
#include <Cntm/RefCount/Internal/NoRefPtrStorage.h>
#include <Cntm/RefCount/RefPtr.h>
#include <Cntm/Containers/RegisterEx.h>

namespace Cntm
{

        /**
         * Это шаблонный класс перечня, хранящий не ссылочные (обычные) указатели на объекты, однако принимающий и перечисляющий ссылочные указатели. Когда происходит сохранение значения в перечне, ссылочный указатель преобразуется в обычный, когда происходит перечисление эл-тов - наоборот - из обычного в ссылочный. При этом следует учитывать, что если ссылочный объект находится в удаляемом состоянии, то в результате преобразования обычного указателя к ссылочному, последний примет значение NULL, однако перечислитель автоматически пропускает указатели на NULL, т.о. текущее значение перечислителя никогда не будет равняться NULL. В качестве параметра шаблона указывается тип объекта.
         *
         * Данный класс может использоваться, когда требуется такая регистрация ссылочных объектов, которая не приводила бы к хранению ссылок на объекты. В этом случае при создании объект регистрирует себя в перечне, а перед уничтожением - уничтожает регистрацию (например, в деструкторе). В какой бы момент не происходило перечисление, если на объект есть ссылки, то будет возвращен ссылочный указатель на этот объект, если объект находится в удаляемом состоянии, но он еще не изъял свой указатель из перечня, то при перечислении он будет пропущен, если же объект изъял свой указатель из перечня, то он уже не будет перечислен.
         *
         * Отличие данного класса от Cntm::NoRefPtrRegister состоит в том, что он является объектом с подсчетом ссылок, а эл-ты перечня и перечислители используют ссылочные указатели. Т.о. имеется гарантия того, что перечень будет существовать, пока существует хоть один перечислитель или эл-т, зарегистрировавший свое значение в данном перечне.
         *
         * Класс обеспечивает многопоточность.
         * @author Овсеевич Р.
         * \ingroup Containers
         */
        template < typename T >
        class NoRefPtrRegisterEx : public RegisterEx < RefPtr < T >, SpecUtils::NoRefPtrStorage < T > >
        {
        public:
        
                typedef RefPtr < NoRefPtrRegisterEx > Ptr;
                
                typedef RegisterEx < RefPtr < T >, SpecUtils::NoRefPtrStorage < T > > RegisterType;
                
                /**
                 * Класс перечислителя. Наследует класс перечислителя перечня.
                 * 
                 * Переопределяет метод Next() и операторы ->() и ++().
                 * \ingroup Containers
                 */
                class Enumerator: public RegisterEx < RefPtr < T >, SpecUtils::NoRefPtrStorage < T > > ::Enumerator
                {
                public:

                        /**
                         * Оператор позволяет получить доступ к членам объекта, на который указывает текущее значение перечислителя.
                         * 
                         * Следует помнить, что если при перечислении метод Next() вернул true, то гарантируется, что текущее значение перечислителя не содержит NULL.
                         */
                        const RefPtr < T > &  operator-> () const { return Enumerator::Current(); }

                        /**
                         * Перейти к следующему эл-ту. Вызывает функцию Next(). См. функцию Next().
                         */
                        Enumerator& operator++ ()
                        {
                                Next();
                                return *this;
                        }

                        /**
                         * Практически во всем совпадает с функцией Next() предка (Register::Enumerator::Next()) за исключением того, что ссылочные указатели, содержащие NULL, автоматически пропускаются при перечислении, т.о. текущее значение никогда не будет содержать указатель на NULL.
                         */
                        bool Next()
                        {
                                while (RegisterType::Enumerator::Next())
                                        if (Enumerator::Current()) return true;
                                return false;
                        }

                protected:
                        
                        friend class NoRefPtrRegisterEx;
                                
                        /**
                         * Конструктор. Используется перечнем для инициализации перечислителя.
                         */
                        Enumerator(const NoRefPtrRegisterEx::Ptr& Reg, bool DynamicExpanded): 
                                RegisterType::Enumerator(Reg, DynamicExpanded) {}
                };

                /**
                 * Получить объект перечислителя для доступа к эл-там. 
                 * @param DynamicExpanded - true (значение по умолчанию) - перечислитель будет перечислять эл-ты, добавленные в перечень после создания перечислителя, false - перечислитель будет переслять только те эл-ты, которые были в перечне на момент создания перечислителя (удаленные эл-ты перечислитель не перечисляет в любом случае).
                 */
                Enumerator GetEnumerator(bool DynamicExpanded = true) const
                { 
                        return Enumerator(this, DynamicExpanded);
                }               
        };

}

#endif //CNTM_NOREFPTRREGISTEREX_H

---