feat: using Qt with 3rd Party Signals and Slots (#17067)

Replace signals,slots and emit with Q_SIGNALS,Q_SLOTS and Q_EMIT Because these names will be used by a 3rd party library
OpenAPITools · Jan 10, 2024 · cfe7dcc · cfe7dcc
1 parent e3c0a3e
commit cfe7dcc
Show file tree

Hide file tree

Showing 37 changed files with 271 additions and 271 deletions.
diff --git a/modules/openapi-generator/src/main/resources/cpp-qt-client/HttpRequest.cpp.mustache b/modules/openapi-generator/src/main/resources/cpp-qt-client/HttpRequest.cpp.mustache
@@ -409,7 +409,7 @@ void {{prefix}}HttpRequestWorker::on_reply_finished(QNetworkReply *reply) {
     }
     process_response(reply);
     reply->deleteLater();
-    emit on_execution_finished(this);
+    Q_EMIT on_execution_finished(this);
 }
 
 void {{prefix}}HttpRequestWorker::on_reply_timeout(QNetworkReply *reply) {
@@ -419,7 +419,7 @@ void {{prefix}}HttpRequestWorker::on_reply_timeout(QNetworkReply *reply) {
     disconnect(reply, nullptr, nullptr, nullptr);
     reply->abort();
     reply->deleteLater();
-    emit on_execution_finished(this);
+    Q_EMIT on_execution_finished(this);
 }
 
 void {{prefix}}HttpRequestWorker::process_response(QNetworkReply *reply) {

diff --git a/modules/openapi-generator/src/main/resources/cpp-qt-client/HttpRequest.h.mustache b/modules/openapi-generator/src/main/resources/cpp-qt-client/HttpRequest.h.mustache
@@ -72,7 +72,7 @@ public:
     void setRequestCompressionEnabled(bool enable);
     int  getHttpResponseCode() const;
 
-signals:
+Q_SIGNALS:
     void on_execution_finished({{prefix}}HttpRequestWorker *worker);
 
 private:

diff --git a/modules/openapi-generator/src/main/resources/cpp-qt-client/README.mustache b/modules/openapi-generator/src/main/resources/cpp-qt-client/README.mustache
@@ -42,7 +42,7 @@ class Example : public QObject {
   {{#allParams}}
     {{{dataType}}} create();
   {{/allParams}}
-public slots:
+public Q_SLOTS:
    void exampleFunction1();
 };
 {{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}}

diff --git a/modules/openapi-generator/src/main/resources/cpp-qt-client/api-body.mustache b/modules/openapi-generator/src/main/resources/cpp-qt-client/api-body.mustache
@@ -163,7 +163,7 @@ void {{classname}}::enableResponseCompression() {
 }
 
 void {{classname}}::abortRequests() {
-    emit abortRequestsSignal();
+    Q_EMIT abortRequestsSignal();
 }
 
 QString {{classname}}::getParamStylePrefix(const QString &style) {
@@ -676,7 +676,7 @@ void {{classname}}::{{nickname}}({{#allParams}}{{#required}}const {{{dataType}}}
     connect(this, &{{classname}}::abortRequestsSignal, worker, &QObject::deleteLater);
     connect(worker, &QObject::destroyed, this, [this]() {
         if (findChildren<{{prefix}}HttpRequestWorker*>().count() == 0) {
-            emit allPendingRequestsCompleted();
+            Q_EMIT allPendingRequestsCompleted();
         }
     });{{#authMethods}}{{#isOAuth}}{{#isCode}}
     _OauthMethod = 2;
@@ -702,7 +702,7 @@ void {{classname}}::{{nickname}}({{#allParams}}{{#required}}const {{{dataType}}}
     connect(this, &{{classname}}::abortRequestsSignal, _latestWorker, &QObject::deleteLater);
     connect(_latestWorker, &QObject::destroyed, [this](){
         if(findChildren<{{prefix}}HttpRequestWorker*>().count() == 0){
-            emit allPendingRequestsCompleted();
+            Q_EMIT allPendingRequestsCompleted();
         }
     });
 
@@ -732,7 +732,7 @@ void {{classname}}::{{nickname}}({{#allParams}}{{#required}}const {{{dataType}}}
     connect(this, &{{classname}}::abortRequestsSignal, _latestWorker, &QObject::deleteLater);
     connect(_latestWorker, &QObject::destroyed, [this](){
         if(findChildren<{{prefix}}HttpRequestWorker*>().count() == 0){
-            emit allPendingRequestsCompleted();
+            Q_EMIT allPendingRequestsCompleted();
         }
     });
 
@@ -762,7 +762,7 @@ void {{classname}}::{{nickname}}({{#allParams}}{{#required}}const {{{dataType}}}
     connect(this, &{{classname}}::abortRequestsSignal, _latestWorker, &QObject::deleteLater);
     connect(_latestWorker, &QObject::destroyed, [this](){
         if(findChildren<{{prefix}}HttpRequestWorker*>().count() == 0){
-            emit allPendingRequestsCompleted();
+            Q_EMIT allPendingRequestsCompleted();
         }
     });
 
@@ -792,7 +792,7 @@ void {{classname}}::{{nickname}}({{#allParams}}{{#required}}const {{{dataType}}}
     connect(this, &{{classname}}::abortRequestsSignal, _latestWorker, &QObject::deleteLater);
     connect(_latestWorker, &QObject::destroyed, [this](){
         if(findChildren<{{prefix}}HttpRequestWorker*>().count() == 0){
-            emit allPendingRequestsCompleted();
+            Q_EMIT allPendingRequestsCompleted();
         }
     });
 
@@ -857,8 +857,8 @@ void {{classname}}::{{nickname}}Callback({{prefix}}HttpRequestWorker *worker) {
     worker->deleteLater();
 
     if (worker->error_type == QNetworkReply::NoError) {
-        emit {{nickname}}Signal({{#returnType}}output{{/returnType}});
-        emit {{nickname}}SignalFull(worker{{#returnType}}, output{{/returnType}});{{#authMethods}}{{#isOAuth}}{{#isCode}}
+        Q_EMIT {{nickname}}Signal({{#returnType}}output{{/returnType}});
+        Q_EMIT {{nickname}}SignalFull(worker{{#returnType}}, output{{/returnType}});{{#authMethods}}{{#isOAuth}}{{#isCode}}
     } else if(worker->error_type == QNetworkReply::AuthenticationRequiredError){
         connect(&_authFlow, SIGNAL(tokenReceived()), this, SLOT(tokenAvailable()));
         QStringList scope;
@@ -870,7 +870,7 @@ void {{classname}}::{{nickname}}Callback({{prefix}}HttpRequestWorker *worker) {
         QString tokenUrl("{{tokenUrl}}");
         //TODO get clientID and Secret and state in the config? https://swagger.io/docs/specification/authentication/oauth2/ states that you should do as you like
         _authFlow.setVariables(authorizationUrl, tokenUrl, scopeStr, "state" , "http://127.0.0.1:9999", "clientId", "clientSecret");
-        emit _authFlow.authenticationNeeded();{{/isCode}}
+        Q_EMIT _authFlow.authenticationNeeded();{{/isCode}}
         {{#isImplicit}}
     } else if(worker->error_type == QNetworkReply::AuthenticationRequiredError){
         connect(&_implicitFlow, SIGNAL(tokenReceived()), this, SLOT(tokenAvailable()));
@@ -882,7 +882,7 @@ void {{classname}}::{{nickname}}Callback({{prefix}}HttpRequestWorker *worker) {
         QString authorizationUrl("{{authorizationUrl}}");
         //TODO get clientID and Secret and state in the config? https://swagger.io/docs/specification/authentication/oauth2/ states that you should do as you like
         _implicitFlow.setVariables(authorizationUrl, scopeStr, "state" , "http://127.0.0.1:9999", "clientId");
-        emit _implicitFlow.authenticationNeeded();{{/isImplicit}}
+        Q_EMIT _implicitFlow.authenticationNeeded();{{/isImplicit}}
         {{#isApplication}}
     } else if(worker->error_type == QNetworkReply::AuthenticationRequiredError){
         connect(&_credentialFlow, SIGNAL(tokenReceived()), this, SLOT(tokenAvailable()));
@@ -894,7 +894,7 @@ void {{classname}}::{{nickname}}Callback({{prefix}}HttpRequestWorker *worker) {
         QString tokenUrl("{{tokenUrl}}");
         //TODO get clientID and Secret and state in the config? https://swagger.io/docs/specification/authentication/oauth2/ states that you should do as you like
         _credentialFlow.setVariables(tokenUrl , scopeStr, "clientId", "clientSecret");
-        emit _credentialFlow.authenticationNeeded();{{/isApplication}}
+        Q_EMIT _credentialFlow.authenticationNeeded();{{/isApplication}}
         {{#isPassword}}
     } else if(worker->error_type == QNetworkReply::AuthenticationRequiredError){
         connect(&_passwordFlow, SIGNAL(tokenReceived()), this, SLOT(tokenAvailable()));
@@ -906,7 +906,7 @@ void {{classname}}::{{nickname}}Callback({{prefix}}HttpRequestWorker *worker) {
         QString tokenUrl("{{tokenUrl}}");
         //TODO get clientID and Secret and state in the config? https://swagger.io/docs/specification/authentication/oauth2/ states that you should do as you like
         _passwordFlow.setVariables(tokenUrl , scopeStr ,"clientId", "clientSecret", "username", "password");
-        emit _passwordFlow.authenticationNeeded();
+        Q_EMIT _passwordFlow.authenticationNeeded();
         {{/isPassword}}{{/isOAuth}}{{/authMethods}}
     } else {
 
@@ -924,8 +924,8 @@ void {{classname}}::{{nickname}}Callback({{prefix}}HttpRequestWorker *worker) {
 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
 #endif
 
-        emit {{nickname}}SignalE({{#returnType}}output, {{/returnType}}error_type, error_str);
-        emit {{nickname}}SignalEFull(worker, error_type, error_str);
+        Q_EMIT {{nickname}}SignalE({{#returnType}}output, {{/returnType}}error_type, error_str);
+        Q_EMIT {{nickname}}SignalEFull(worker, error_type, error_str);
 
 #if defined(_MSC_VER)
 #pragma warning(pop)
@@ -935,8 +935,8 @@ void {{classname}}::{{nickname}}Callback({{prefix}}HttpRequestWorker *worker) {
 #pragma GCC diagnostic pop
 #endif
 
-        emit {{nickname}}SignalError({{#returnType}}output, {{/returnType}}error_type, error_str);
-        emit {{nickname}}SignalErrorFull(worker, error_type, error_str);
+        Q_EMIT {{nickname}}SignalError({{#returnType}}output, {{/returnType}}error_type, error_str);
+        Q_EMIT {{nickname}}SignalErrorFull(worker, error_type, error_str);
     }
 }
 

diff --git a/modules/openapi-generator/src/main/resources/cpp-qt-client/api-header.mustache b/modules/openapi-generator/src/main/resources/cpp-qt-client/api-header.mustache
@@ -85,7 +85,7 @@ private:
 {{#operations}}{{#operation}}
     void {{nickname}}Callback({{prefix}}HttpRequestWorker *worker);{{/operation}}{{/operations}}
 
-signals:
+Q_SIGNALS:
 {{#operations}}{{#operation}}
     void {{nickname}}Signal({{#returnType}}{{{.}}} summary{{/returnType}});{{/operation}}{{/operations}}
 {{#operations}}{{#operation}}
@@ -102,7 +102,7 @@ signals:
     void abortRequestsSignal();
     void allPendingRequestsCompleted();
 
-public slots:
+public Q_SLOTS:
     void tokenAvailable();
 };
 

diff --git a/modules/openapi-generator/src/main/resources/cpp-qt-client/oauth.cpp.mustache b/modules/openapi-generator/src/main/resources/cpp-qt-client/oauth.cpp.mustache
@@ -31,7 +31,7 @@ oauthToken OauthBase::getToken(QString scope)
 void OauthBase::addToken(oauthToken token)
 {
     m_oauthTokenMap.insert(token.getScope(),token);
-    emit tokenReceived();
+    Q_EMIT tokenReceived();
 
 }
 
@@ -341,7 +341,7 @@ void ReplyServer::read()
     }
     socket->close();
 
-    emit dataReceived(queryParams);
+    Q_EMIT dataReceived(queryParams);
 }
 
 {{#cppNamespaceDeclarations}}

diff --git a/modules/openapi-generator/src/main/resources/cpp-qt-client/oauth.h.mustache b/modules/openapi-generator/src/main/resources/cpp-qt-client/oauth.h.mustache
@@ -58,10 +58,10 @@ public:
 private:
     QByteArray m_reply;
 
-signals:
+Q_SIGNALS:
     void dataReceived(QMap<QString, QString>);
 
-public slots:
+public Q_SLOTS:
     void onConnected();
     void read();
     void start();
@@ -88,11 +88,11 @@ protected:
     QString m_scope, m_accessType, m_state, m_redirectUri, m_clientId, m_clientSecret;
     bool m_linked;
 
-public slots:
+public Q_SLOTS:
     virtual void authenticationNeededCallback()=0;
     void onFinish(QNetworkReply *rep);
 
-signals:
+Q_SIGNALS:
     void authenticationNeeded();
     void tokenReceived();
 };
@@ -110,7 +110,7 @@ public:
 private:
     ReplyServer m_server;
 
-public slots:
+public Q_SLOTS:
     void authenticationNeededCallback() override;
     void onVerificationReceived(const QMap<QString, QString> response);
 
@@ -129,7 +129,7 @@ public:
 private:
     ReplyServer m_server;
 
-public slots:
+public Q_SLOTS:
     void authenticationNeededCallback() override;
     void ImplicitTokenReceived(const QMap<QString, QString> response);
 };
@@ -144,7 +144,7 @@ public:
     void unlink() override;
     void setVariables(QString tokenUrl, QString scope, QString clientId, QString clientSecret);
 
-public slots:
+public Q_SLOTS:
     void authenticationNeededCallback() override;
 
 };
@@ -162,7 +162,7 @@ public:
 private:
     QString m_username, m_password;
 
-public slots:
+public Q_SLOTS:
     void authenticationNeededCallback() override;
 
 };

diff --git a/modules/openapi-generator/src/main/resources/cpp-qt-qhttpengine-server/apihandler.h.mustache b/modules/openapi-generator/src/main/resources/cpp-qt-qhttpengine-server/apihandler.h.mustache
@@ -20,7 +20,7 @@ public:
     virtual ~{{classname}}Handler();
 
 
-public slots:
+public Q_SLOTS:
     {{#operations}}{{#operation}}virtual void {{nickname}}({{#allParams}}{{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}});
     {{/operation}}{{/operations}}
 

diff --git a/...es/openapi-generator/src/main/resources/cpp-qt-qhttpengine-server/apirequest.cpp.mustache b/...es/openapi-generator/src/main/resources/cpp-qt-qhttpengine-server/apirequest.cpp.mustache
@@ -108,7 +108,7 @@ void {{classname}}Request::{{nickname}}Request({{#hasPathParams}}{{#pathParams}}
     {{/isArray}}
     {{/bodyParam}}{{/bodyParams}}
 
-    emit {{nickname}}({{#allParams}}{{paramName}}{{^-last}}, {{/-last}}{{/allParams}});
+    Q_EMIT {{nickname}}({{#allParams}}{{paramName}}{{^-last}}, {{/-last}}{{/allParams}});
 }
 
 {{/operation}}{{/operations}}

diff --git a/modules/openapi-generator/src/main/resources/cpp-qt-qhttpengine-server/apirequest.h.mustache b/modules/openapi-generator/src/main/resources/cpp-qt-qhttpengine-server/apirequest.h.mustache
@@ -44,7 +44,7 @@ public:
 
     void setResponseHeaders(const QMultiMap<QString,QString>& headers);
 
-signals:
+Q_SIGNALS:
     {{#operations}}{{#operation}}void {{nickname}}({{#allParams}}{{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}});
     {{/operation}}{{/operations}}
 

diff --git a/modules/openapi-generator/src/main/resources/cpp-qt-qhttpengine-server/apirouter.h.mustache b/modules/openapi-generator/src/main/resources/cpp-qt-qhttpengine-server/apirouter.h.mustache
@@ -24,7 +24,7 @@ namespace {{this}} {
 class {{prefix}}ApiRequestHandler : public  QHttpEngine::QObjectHandler
 {
     Q_OBJECT
-signals:
+Q_SIGNALS:
     void requestReceived(QHttpEngine::Socket *socket);
 
 protected:
@@ -34,10 +34,10 @@ protected:
         // If the slot requires all data to be received, check to see if this is
         // already the case, otherwise, wait until the rest of it arrives
         if (socket->bytesAvailable() >= socket->contentLength()) {
-            emit requestReceived(socket);
+            Q_EMIT requestReceived(socket);
         } else {
             connect(socket, &QHttpEngine::Socket::readChannelFinished, [this, socket]() {
-                emit requestReceived(socket);
+                Q_EMIT requestReceived(socket);
             });
         }
     }

diff --git a/samples/client/petstore/cpp-qt/PetStore/PetApiTests.h b/samples/client/petstore/cpp-qt/PetStore/PetApiTests.h
@@ -9,7 +9,7 @@ class PetApiTests : public QObject {
 
     PFXPet createRandomPet();
 
-private slots:
+private Q_SLOTS:
     void findPetsByStatusTest();
     void createAndGetPetTest();
     void updatePetTest();

diff --git a/samples/client/petstore/cpp-qt/PetStore/StoreApiTests.h b/samples/client/petstore/cpp-qt/PetStore/StoreApiTests.h
@@ -7,7 +7,7 @@ using namespace test_namespace;
 class StoreApiTests : public QObject {
     Q_OBJECT
 
-private slots:
+private Q_SLOTS:
     void placeOrderTest();
     void getOrderByIdTest();
     void getInventoryTest();

diff --git a/samples/client/petstore/cpp-qt/PetStore/UserApiTests.h b/samples/client/petstore/cpp-qt/PetStore/UserApiTests.h
@@ -9,7 +9,7 @@ class UserApiTests : public QObject {
 
     PFXUser createRandomUser();
 
-private slots:
+private Q_SLOTS:
     void createUserTest();
     void createUsersWithArrayInputTest();
     void createUsersWithListInputTest();

diff --git a/samples/client/petstore/cpp-qt/README.md b/samples/client/petstore/cpp-qt/README.md
@@ -33,7 +33,7 @@ using namespace test_namespace;
 class Example : public QObject {
     Q_OBJECT
     PFXPet create();
-public slots:
+public Q_SLOTS:
    void exampleFunction1();
 };
 

diff --git a/samples/client/petstore/cpp-qt/client/PFXHttpRequest.cpp b/samples/client/petstore/cpp-qt/client/PFXHttpRequest.cpp
@@ -416,7 +416,7 @@ void PFXHttpRequestWorker::on_reply_finished(QNetworkReply *reply) {
     }
     process_response(reply);
     reply->deleteLater();
-    emit on_execution_finished(this);
+    Q_EMIT on_execution_finished(this);
 }
 
 void PFXHttpRequestWorker::on_reply_timeout(QNetworkReply *reply) {
@@ -426,7 +426,7 @@ void PFXHttpRequestWorker::on_reply_timeout(QNetworkReply *reply) {
     disconnect(reply, nullptr, nullptr, nullptr);
     reply->abort();
     reply->deleteLater();
-    emit on_execution_finished(this);
+    Q_EMIT on_execution_finished(this);
 }
 
 void PFXHttpRequestWorker::process_response(QNetworkReply *reply) {

diff --git a/samples/client/petstore/cpp-qt/client/PFXHttpRequest.h b/samples/client/petstore/cpp-qt/client/PFXHttpRequest.h
@@ -80,7 +80,7 @@ class PFXHttpRequestWorker : public QObject {
     void setRequestCompressionEnabled(bool enable);
     int  getHttpResponseCode() const;
 
-signals:
+Q_SIGNALS:
     void on_execution_finished(PFXHttpRequestWorker *worker);
 
 private:

diff --git a/samples/client/petstore/cpp-qt/client/PFXOauth.cpp b/samples/client/petstore/cpp-qt/client/PFXOauth.cpp
@@ -29,7 +29,7 @@ oauthToken OauthBase::getToken(QString scope)
 void OauthBase::addToken(oauthToken token)
 {
     m_oauthTokenMap.insert(token.getScope(),token);
-    emit tokenReceived();
+    Q_EMIT tokenReceived();
 
 }
 
@@ -339,7 +339,7 @@ void ReplyServer::read()
     }
     socket->close();
 
-    emit dataReceived(queryParams);
+    Q_EMIT dataReceived(queryParams);
 }
 
 } // namespace test_namespace