Класс QScopedPointer

Класс QScopedPointer хранит указатель на динамически выделенный объект и удаляет его при уничтожении. Подробнее...

• Список всех членов, включая наследуемые
• Устаревшие члены

Примечание: Все функции в этом классе являются реентерабельными.

Открытые функции

Связанные нечлены

Подробное описание

Управление объектами, выделенными на куче вручную, сложно и подвержено ошибкам, что обычно приводит к утечкам памяти и трудностям при обслуживании кода. QScopedPointer — это небольшой вспомогательный класс, который значительно упрощает это, назначая управление памятью на основе стека для выделения памяти на куче, что в более общем смысле называется приобретением ресурсов при инициализации (RAII).

QScopedPointer гарантирует, что объект, на который указывает указатель, будет удалён при исчезновении текущего блока кода.

Рассмотрим эту функцию, которая выполняет выделение памяти на куче и имеет различные точки выхода:

void myFunction(bool useSubClass)
{
    MyClass *p = useSubClass ? new MyClass() : new MySubClass;
    QIODevice *device = handsOverOwnership();

    if (m_value > 3) {
        delete p;
        delete device;
        return;
    }

    try {
        process(device);
    }
    catch (...) {
        delete p;
        delete device;
        throw;
    }

    delete p;
    delete device;
}

Она затруднена ручными вызовами delete. С QScopedPointer код можно упростить до:

void myFunction(bool useSubClass)
{
    // assuming that MyClass has a virtual destructor
    QScopedPointer<MyClass> p(useSubClass ? new MyClass() : new MySubClass);
    QScopedPointer<QIODevice> device(handsOverOwnership());

    if (m_value > 3)
        return;

    process(device);
}

Код, который генерирует компилятор для QScopedPointer, такой же, как и при написании вручную. Код, использующий delete, является кандидатом для использования QScopedPointer (а если нет, то, возможно, другого типа умного указателя, такого как QSharedPointer). QScopedPointer намеренно не имеет конструктора копирования или оператора присваивания, чтобы ясно передать владение и срок службы.

Квалификатор const для обычного указателя C++ также можно выразить с помощью QScopedPointer:

    const QWidget *const p = new QWidget();
    // is equivalent to:
    const QScopedPointer<const QWidget> p(new QWidget());

    QWidget *const p = new QWidget();
    // is equivalent to:
    const QScopedPointer<QWidget> p(new QWidget());

    const QWidget *p = new QWidget();
    // is equivalent to:
    QScopedPointer<const QWidget> p(new QWidget());

Пользовательские обработчики очистки

Массивы, а также указатели, которые были выделены с помощью malloc не должны удаляться с помощью delete. Второй шаблонный параметр QScopedPointer может использоваться для пользовательских обработчиков очистки.

Существуют следующие пользовательские обработчики очистки:

• QScopedPointerDeleter — по умолчанию, удаляет указатель с помощью delete
• QScopedPointerArrayDeleter — удаляет указатель с помощью delete []. Используйте этот обработчик для указателей, выделенных с помощью new [].
• QScopedPointerPodDeleter — удаляет указатель с помощью free(). Используйте этот обработчик для указателей, выделенных с помощью malloc().
• QScopedPointerDeleteLater — удаляет указатель, вызывая deleteLater() для него. Используйте этот обработчик для указателей на QObject, которые активно участвуют в QEventLoop.

Вы можете передавать свои собственные классы в качестве обработчиков, при условии, что у них есть публичная статическая функция void cleanup(T *pointer).

// this QScopedPointer deletes its data using the delete[] operator:
QScopedPointer<int, QScopedPointerArrayDeleter<int> > arrayPointer(new int[42]);

// this QScopedPointer frees its data using free():
QScopedPointer<int, QScopedPointerPodDeleter> podPointer(reinterpret_cast<int *>(malloc(42)));

// this struct calls "myCustomDeallocator" to delete the pointer
struct ScopedPointerCustomDeleter
{
    static inline void cleanup(MyCustomClass *pointer)
    {
        myCustomDeallocator(pointer);
    }
};

// QScopedPointer using a custom deleter:
QScopedPointer<MyCustomClass, ScopedPointerCustomDeleter> customPointer(new MyCustomClass);

Указатели с предварительной декларацией

Классы, которые объявлены предварительно, могут использоваться в QScopedPointer, если деструктор класса с предварительной декларацией доступен всякий раз, когда QScopedPointer необходимо очистить.

Конкретно, это означает, что все классы, содержащие QScopedPointer, указывающие на класс с предварительной декларацией, должны иметь нелинейные конструкторы, деструкторы и операторы присваивания:

class MyPrivateClass; // forward declare MyPrivateClass

class MyClass
{
private:
    QScopedPointer<MyPrivateClass> privatePtr; // QScopedPointer to forward declared class

public:
    MyClass(); // OK
    inline ~MyClass() {} // VIOLATION - Destructor must not be inline

private:
    Q_DISABLE_COPY(MyClass) // OK - copy constructor and assignment operators
                             // are now disabled, so the compiler won't implicitly
                             // generate them.
};

В противном случае компилятор выведет предупреждение о невозможности уничтожения MyPrivateClass.

См. также QSharedPointer.

Документация по членам функций

QScopedPointer::QScopedPointer(T *p = nullptr)

Конструирует экземпляр QScopedPointer и устанавливает его указатель на p.

QScopedPointer::~QScopedPointer()

Уничтожает этот объект QScopedPointer. Удаляет объект, на который указывает его указатель.

T *QScopedPointer::data() const

Возвращает значение указателя, на который ссылается этот объект. QScopedPointer по-прежнему владеет объектом, на который указывает указатель.

T *QScopedPointer::get() const

То же, что и data().

Эта функция была представлена в Qt 5.11.

bool QScopedPointer::isNull() const

Возвращает true если этот объект ссылается на nullptr.

void QScopedPointer::reset(T *other = nullptr)

Удаляет существующий объект, на который он указывает (если таковой имеется), и устанавливает свой указатель на other. QScopedPointer теперь владеет other и удалит его в своём деструкторе.

bool QScopedPointer::operator bool() const

Возвращает true если содержащийся указатель не nullptr. Эта функция подходит для использования в if-constructs, например:

if (scopedPointer) {
    ...
}

См. также isNull().

bool QScopedPointer::operator!() const

Возвращает true если этот объект ссылается на nullptr.

См. также isNull().

T &QScopedPointer::operator*() const

Обеспечивает доступ к объекту, на который указывает указатель.

Если содержащийся указатель nullptr, поведение неопределено.

См. также isNull().

T *QScopedPointer::operator->() const

Обеспечивает доступ к объекту, на который указывает указатель.

Если содержащийся указатель nullptr, поведение неопределено.

См. также isNull().