Отличия между основанными на строках и основанными на функторах подключениями

Начиная с Qt 5.0, Qt предлагает два разных способа написания подключений «сигнал-слот» в C++: синтаксис подключения на основе строк и синтаксис подключения на основе функтора. Оба синтаксиса имеют свои плюсы и минусы. В таблице ниже обобщены их различия.

В следующих разделах подробно описываются эти различия и демонстрируется использование функций, уникальных для каждого синтаксиса подключения.

Проверка типов и неявные преобразования типов

Подключения на основе строк проверяют типы, сравнивая строки во время выполнения. Этот подход имеет три ограничения:

1. Ошибки подключения могут быть обнаружены только после запуска программы.
2. Неявные преобразования не могут выполняться между сигналами и слотами.
3. Не могут быть разрешены псевдонимы типов и пространства имен.

Ограничения 2 и 3 существуют, потому что компаратор строк не имеет доступа к информации о типах C++, поэтому он полагается на точное соответствие строк.

В отличие от этого, подключения на основе функторов проверяются компилятором. Компилятор обнаруживает ошибки на этапе компиляции, позволяет выполнять неявные преобразования между совместимыми типами и распознаёт разные имена одного и того же типа.

Например, только синтаксис на основе функторов может использоваться для подключения сигнала, который переносит int, к слоту, который принимает double. QSlider содержит значение int, а QDoubleSpinBox содержит значение double. Следующий фрагмент кода показывает, как их синхронизировать:

    auto slider = new QSlider(this);
    auto doubleSpinBox = new QDoubleSpinBox(this);

    // OK: The compiler can convert an int into a double
    connect(slider, &QSlider::valueChanged,
            doubleSpinBox, &QDoubleSpinBox::setValue);

    // ERROR: The string table doesn't contain conversion information
    connect(slider, SIGNAL(valueChanged(int)),
            doubleSpinBox, SLOT(setValue(double)));

Следующий пример иллюстрирует отсутствие разрешения имен. QAudioInput::stateChanged() объявляется с аргументом типа "QAudio::State". Таким образом, подключения на основе строк также должны указывать "QAudio::State", даже если "State" уже видно. Эта проблема не относится к подключениям на основе функторов, поскольку типы аргументов не являются частью подключения.

    auto audioInput = new QAudioInput(QAudioFormat(), this);
    auto widget = new QWidget(this);

    // OK
    connect(audioInput, SIGNAL(stateChanged(QAudio::State)),
            widget, SLOT(show()));

    // ERROR: The strings "State" and "QAudio::State" don't match
    using namespace QAudio;
    connect(audioInput, SIGNAL(stateChanged(State)),
            widget, SLOT(show()));

    // ...

Подключение к лямбда-выражениям

Синтаксис подключения на основе функторов позволяет подключать сигналы к лямбда-выражениям C++11, которые являются эффективными встроенными слотами. Эта функция недоступна с синтаксисом подключения на основе строк.

В следующем примере класс TextSender испускает сигнал textCompleted(), который переносит параметр QString. Вот объявление класса:

class TextSender : public QWidget {
    Q_OBJECT

    QLineEdit *lineEdit;
    QPushButton *button;

signals:
    void textCompleted(const QString& text) const;

public:
    TextSender(QWidget *parent = nullptr);
};

Вот подключение, которое испускает TextSender::textCompleted() при нажатии на кнопку:

TextSender::TextSender(QWidget *parent) : QWidget(parent) {
    lineEdit = new QLineEdit(this);
    button = new QPushButton("Send", this);

    connect(button, &QPushButton::clicked, [=] {
        emit textCompleted(lineEdit->text());
    });

    // ...
}

В этом примере лямбда-функция упростила подключение, даже несмотря на то, что QPushButton::clicked() и TextSender::textCompleted() имеют несовместимые параметры. В отличие от этого, реализация на основе строк потребовала бы дополнительного кода.

Примечание: синтаксис подключения на основе функторов принимает указатели на все функции, включая автономные функции и обычные методы-члены. Однако для улучшения читабельности сигналы следует подключать только к слотам, лямбда-выражениям и другим сигналам.

Подключение C++ объектов к QML объектам

Синтаксис на основе строк может подключать C++ объекты к QML объектам, но синтаксис на основе функторов не может. Это связано с тем, что типы QML разрешаются во время выполнения, поэтому они недоступны компилятору C++.

В следующем примере при нажатии на QML объект C++ объект печатает сообщение, и наоборот. Вот тип QML (в QmlGui.qml):

Rectangle {
    width: 100; height: 100

    signal qmlSignal(string sentMsg)
    function qmlSlot(receivedMsg) {
        console.log("QML received: " + receivedMsg)
    }

    MouseArea {
        anchors.fill: parent
        onClicked: qmlSignal("Hello from QML!")
    }
}

Вот класс C++:

class CppGui : public QWidget {
    Q_OBJECT

    QPushButton *button;

signals:
    void cppSignal(const QVariant& sentMsg) const;

public slots:
    void cppSlot(const QString& receivedMsg) const {
        qDebug() << "C++ received:" << receivedMsg;
    }

public:
    CppGui(QWidget *parent = nullptr) : QWidget(parent) {
        button = new QPushButton("Click Me!", this);
        connect(button, &QPushButton::clicked, [=] {
            emit cppSignal("Hello from C++!");
        });
    }
};

Вот код, который выполняет подключения сигнал-слот:

    auto cppObj = new CppGui(this);
    auto quickWidget = new QQuickWidget(QUrl("QmlGui.qml"), this);
    auto qmlObj = quickWidget->rootObject();

    // Connect QML signal to C++ slot
    connect(qmlObj, SIGNAL(qmlSignal(QString)),
            cppObj, SLOT(cppSlot(QString)));

    // Connect C++ signal to QML slot
    connect(cppObj, SIGNAL(cppSignal(QVariant)),
            qmlObj, SLOT(qmlSlot(QVariant)));

Примечание: Все функции JavaScript в QML принимают параметры типа var, который соответствует типу QVariant в C++.

При нажатии на QPushButton в консоль выводится 'QML received: "Hello from C++!"'. Аналогично, при нажатии на прямоугольник в консоль выводится 'C++ received: "Hello from QML!"'.

См. Взаимодействие с QML объектами из C++ для других способов взаимодействия C++ объектов с QML объектами.

Использование параметров по умолчанию в слотах для подключения к сигналам с меньшим количеством параметров

Обычно подключение возможно только в том случае, если у слота такое же количество аргументов, как у сигнала (или меньше), и если все типы аргументов совместимы.

Синтаксис подключения на основе строк предоставляет обходной путь для этого правила: если у слота есть параметры по умолчанию, эти параметры можно опустить из сигнала. Когда сигнал испускается с меньшим количеством аргументов, чем слот, Qt выполняет слот, используя значения параметров по умолчанию.

Подключения на основе функторов не поддерживают эту функцию.

Предположим, есть класс под названием DemoWidget со слотом printNumber(), у которого есть аргумент по умолчанию:

public slots:
    void printNumber(int number = 42) {
        qDebug() << "Lucky number" << number;
    }

Используя подключение на основе строк, можно подключить DemoWidget::printNumber() к QApplication::aboutToQuit(), даже если последний не имеет аргументов. Подключение на основе функторов вызовет ошибку компиляции:

DemoWidget::DemoWidget(QWidget *parent) : QWidget(parent) {

    // OK: printNumber() will be called with a default value of 42
    connect(qApp, SIGNAL(aboutToQuit()),
            this, SLOT(printNumber()));

    // ERROR: Compiler requires compatible arguments
    connect(qApp, &QCoreApplication::aboutToQuit,
            this, &DemoWidget::printNumber);
}

Для решения этой проблемы с синтаксисом на основе функторов подключите сигнал к лямбда-функции, которая вызывает слот. См. раздел выше Подключение к лямбда-выражениям.

Выбор перегруженных сигналов и слотов

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

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

Например, QLCDNumber имеет три версии слота display():

1. QLCDNumber::display(int)
2. QLCDNumber::display(double)
3. QLCDNumber::display(QString)

Для подключения версии int к QSlider::valueChanged() эти два синтаксиса выглядят так:

    auto slider = new QSlider(this);
    auto lcd = new QLCDNumber(this);

    // String-based syntax
    connect(slider, SIGNAL(valueChanged(int)),
            lcd, SLOT(display(int)));

    // Functor-based syntax, first alternative
    connect(slider, &QSlider::valueChanged,
            lcd, static_cast<void (QLCDNumber::*)(int)>(&QLCDNumber::display));

    // Functor-based syntax, second alternative
    void (QLCDNumber::*mySlot)(int) = &QLCDNumber::display;
    connect(slider, &QSlider::valueChanged,
            lcd, mySlot);

    // Functor-based syntax, third alternative
    connect(slider, &QSlider::valueChanged,
            lcd, QOverload<int>::of(&QLCDNumber::display));

    // Functor-based syntax, fourth alternative (requires C++14)
    connect(slider, &QSlider::valueChanged,
            lcd, qOverload<int>(&QLCDNumber::display));

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