Checking if running as command-line (QCoreApplication) or GUI
-
@Christian-Ehrlicher Well that's quite a surprise - from the documentation I had expected the macro to use a dynamic_cast<>
@Perdrix said in Checking if running as command-line (QCoreApplication) or GUI:
from the documentation I had expected the macro to use a dynamic_cast<>Why? It's clearly stated:
"so only valid when the unique application object is a QApplication."
-
Which clearly said to me that it would be null if the application object is just a QCoreApplication...
So the docs really could be clearer (state that is it using a static_cast<>), or change the code to use a dynamic_cast<>!
@Perdrix said in Checking if running as command-line (QCoreApplication) or GUI:
Which clearly said to me that it would be null if the application object is just a QCoreApplication...
undefined and a nullptr are two completely different things in c++ - the docs are very clear here.
https://en.cppreference.com/cpp/language/ub -
"only valid" = undefined if the precondition is not met.
/edit:
valid pointer - a pointer to an object which is not yet deleted and has the correct class
invalid / not valid pointer - a pointer to an object which was already deleted or has an incorrect class
nullptr - a pointer to null -
I still think the wording is open to my interpretation, however I have now defined my own convenience macro:
// // Define a convenience macro for checking if we're using a Qt GUI or command line application // #define qtGUI (dynamic_cast<QApplication *>(QCoreApplication::instance())) -
@Perdrix
I imagine that is a reasonable test if you want to do a Qt call, as in: "is there aQApplicationobject?"A global pointer referring to the unique application object. It is equivalent to QCoreApplication::instance(), but cast as a QApplication pointer, so only valid when the unique application object is a QApplication.
However, are you intending to use single-source with two separate compilations/links, one for GUI and one for console? Because if you are thinking you can do just one compilation/link and decide at runtime whether to run as GUI or command line you are going to stall. Under Windows at least --- which ISTR you use --- an executable is linked as either "windows" (GUI) or "console" (command-line) and you are stuck with that at runtime.
After further experiments this seems to be a non-starter. I wanted to use a message box for GUI and cout for command line, but of course the command line code isn't going to be linked with the libraries necessary to use QMessageBox.
Hey ho! Compile time checks ...
-
After further experiments this seems to be a non-starter. I wanted to use a message box for GUI and cout for command line, but of course the command line code isn't going to be linked with the libraries necessary to use QMessageBox.
Hey ho! Compile time checks ...
@Perdrix
This is the sort of thing I was trying to discuss with you once you start trying to useqAppfrom a command-line executable.I wanted to use a message box for GUI and cout for command line, but of course the command line code isn't going to be linked with the libraries necessary to use QMessageBox.
You implement this requirement via pointers-to-functions or subclassing-virtual-methods. It's a common paradigm. So that your code calls something like
utilty.alert("Message")and that ends up calling either the GUI or the command-line implementation depending what functionalert()pointer/virtual resolves to as set in construction/start-up. That keeps the command-line from needing to include/link with anything GUI. -
What about this:
QCoreApplication* createApplication(int &argc, char *argv[]) { for (int i = 1; i < argc; ++i) { if (!qstrcmp(argv[i], "-no-gui")) return new QCoreApplication(argc, argv); } return new QApplication(argc, argv); } int main(int argc, char* argv[]) { QScopedPointer<QCoreApplication> app(createApplication(argc, argv)); if (qobject_cast<QApplication *>(app.data())) { // start GUI version... } else { // start non-GUI version... } return app->exec(); } -
What about this:
QCoreApplication* createApplication(int &argc, char *argv[]) { for (int i = 1; i < argc; ++i) { if (!qstrcmp(argv[i], "-no-gui")) return new QCoreApplication(argc, argv); } return new QApplication(argc, argv); } int main(int argc, char* argv[]) { QScopedPointer<QCoreApplication> app(createApplication(argc, argv)); if (qobject_cast<QApplication *>(app.data())) { // start GUI version... } else { // start non-GUI version... } return app->exec(); }@Pl45m4
Has anyone tried this, especially under Windows, to see what kind of "non-GUI version" you get? My understanding/suspicion is it will be awindowsapplication (even if it opens no windows/widgets) which does not use/cannot access the console from which it is run, does not have open stdin/out/err and so on? Based on how MSVC non-Qt applications work. -
If I remember correctly, there are ways to reattach the console for a GUI application. I have found some old code of mine like this:
void openConsole() { AllocConsole(); std::freopen( "CON", "w", stdout ); std::freopen( "CON", "w", stderr ); std::freopen( "CON", "r", stdin ); }This function is called if the GUI application is started in non-GUI mode.
However, my solution for an app that works both as command line and GUI application on Windows is to compile two separate binaries. The GUI is the .exe file and the command line version is the .com file (command file). On the command line a .com file is preferred to a .exe file if you just type in the file name without the suffix. Also, I tend to make the non-GUI version the default because the GUI .exe is usually started through a shortcut and the shortcut can be set to always provide a command line paramter
-gui. Depending on the flags, both .exe and .com can start the other program if the other mode is requested explicitly. BTW, I learned this behavior von Visual Studio: They ship both a devenv.exe (the regular Visual Studio GUI application) and a devenv.com (to be used by build tools). -
If I remember correctly, there are ways to reattach the console for a GUI application. I have found some old code of mine like this:
void openConsole() { AllocConsole(); std::freopen( "CON", "w", stdout ); std::freopen( "CON", "w", stderr ); std::freopen( "CON", "r", stdin ); }This function is called if the GUI application is started in non-GUI mode.
However, my solution for an app that works both as command line and GUI application on Windows is to compile two separate binaries. The GUI is the .exe file and the command line version is the .com file (command file). On the command line a .com file is preferred to a .exe file if you just type in the file name without the suffix. Also, I tend to make the non-GUI version the default because the GUI .exe is usually started through a shortcut and the shortcut can be set to always provide a command line paramter
-gui. Depending on the flags, both .exe and .com can start the other program if the other mode is requested explicitly. BTW, I learned this behavior von Visual Studio: They ship both a devenv.exe (the regular Visual Studio GUI application) and a devenv.com (to be used by build tools).@SimonSchroeder said in Checking if running as command-line (QCoreApplication) or GUI:
If I remember correctly, there are ways to reattach the console for a GUI application. I have found some old code of mine like this:
No! You use AllocConsole() which
Allocates a new [my bold] console for the calling process.
which does not access the Command Prompt/console from which you invoke it ("reattach the console"), nor can it be used in pipe sequences or with redirection etc. It is simply a Windows/GUI executable which happens to open its own console for some purpose.
VS ships
devenv.exeas awindowsexecutable and a completely separate executable,devenv.comas aconsoleone. Which is precisely what I have been saying/suggesting all along: you need a separate executable, linked asconsolenotwindows, for a proper "command line" executable. And I am suggesting that if code you link with has#include <QApplication> if (qApp) ...it will have to bewindowsand therefore not a proper command line, regardless of whether it creates aQApplicationor aQCoreApplicationat runtime. Which somebody (perhaps the OP?) who is interested and has Qt for Windows might just like to test.... -
@Pl45m4
Has anyone tried this, especially under Windows, to see what kind of "non-GUI version" you get? My understanding/suspicion is it will be awindowsapplication (even if it opens no windows/widgets) which does not use/cannot access the console from which it is run, does not have open stdin/out/err and so on? Based on how MSVC non-Qt applications work.I also referenced it in my topic (here) already, where I was playing with hybrid app approaches, because I had the idea of making one app binary in total that would work in CLI and GUI mode.
But it turned out, that you have to add quite some platform specific code (directing IO from/to the console, etc...) to make it look smooth without any bugs and "blinking console windows" in the background.
So I went for a launcher (3-way targets). One GUI binary, one CLI binary and one launcher for convenience where you can select (manually or by arg to make it default ->myAppLauncher.exe -gui) the mode you want to run. Then it starts the right program. -
I also referenced it in my topic (here) already, where I was playing with hybrid app approaches, because I had the idea of making one app binary in total that would work in CLI and GUI mode.
But it turned out, that you have to add quite some platform specific code (directing IO from/to the console, etc...) to make it look smooth without any bugs and "blinking console windows" in the background.
So I went for a launcher (3-way targets). One GUI binary, one CLI binary and one launcher for convenience where you can select (manually or by arg to make it default ->myAppLauncher.exe -gui) the mode you want to run. Then it starts the right program.@Pl45m4
I entirely agree. And the conclusion you seem to have come to there is indeed that things either do not quite work or they are at best tricky if you try to make awindows-linked executable behave as a "proper" command-line executable at runtime.Also I cannot spot it but I believe we had another topic discussing this at length recently/a while back and coming to the conclusion that you need a "wrapper" command -line executable to launch the underlying GUI versus command line code executables if you want a single program "entry point". It may have been your topic but I have a feeling it was a more recent one.
-
@Pl45m4
I entirely agree. And the conclusion you seem to have come to there is indeed that things either do not quite work or they are at best tricky if you try to make awindows-linked executable behave as a "proper" command-line executable at runtime.Also I cannot spot it but I believe we had another topic discussing this at length recently/a while back and coming to the conclusion that you need a "wrapper" command -line executable to launch the underlying GUI versus command line code executables if you want a single program "entry point". It may have been your topic but I have a feeling it was a more recent one.
There's also the difference between the nowadays common "headless" mode for GUI apps and console applications.
Every console app can be considered "headless", but not every headless-capable app is console only... some just don't show any toplevel window, but are still built as aWIN32executable target while running in the background (or as SysTray app process).
So yeah, I think one executable for both worlds is pretty hard to build and maintain [maintain pun not intended :)) ]
-> Speaking of entry pointsWinMain()vs.main(), console io redirection, window handling etc.There were quite some discussions, but also can't find them right now :))
-
As far as I (the OP) am concerned this issue is closed. Build for GUI, build separate code for CL, have common base class for issuing messages and subclass for either GUI or CL as needed.
D.
@Perdrix said in Checking if running as command-line (QCoreApplication) or GUI:
As far as I (the OP) am concerned this issue is closed. Build for GUI, build separate code for CL, have common base class for issuing messages and subclass for either GUI or CL as needed.
And I asked you whether you had actually tried building/linking your code, with the
qAppmodule, at least under Windows if that is what you use, to see whether it is truly "command line", e.g. does it do redirection likeecho abc | yourexecutable > file? Maybe you don't care, maybe you're not under Windows, whatever: I have said what I can, i leave it to you now.