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

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

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

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

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

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

Ограничения 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)));

При нажатии на QPushButton в консоль выводится 'QML received: "Hello from C++!"'. Аналогично, при нажатии на Rectangle в консоль выводится '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
    connect(slider, &QSlider::valueChanged,
            lcd, qOverload<int>(&QLCDNumber::display));

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