Page MenuHomePhabricator (Chris)

No OneTemporary

Size
4 KB
Referenced Files
None
Subscribers
None
diff --git a/README.md b/README.md
index 87d08ba..d458de5 100644
--- a/README.md
+++ b/README.md
@@ -1,69 +1,69 @@
SingleApplication
=================
This is a replacement of the QSingleApplication for ```Qt5```.
Keeps the Primary Instance of your Application and kills each subsequent instance.
Usage
-----
The ```SingleApplication``` class inherits from ```QApplication```. Use it as if you are using the ```QApplication``` class.
The library uses your ```Organization Name``` and ```Application Name``` to set up a ```QLocalServer``` and a ```QSharedMemory``` block. The first instance of your Application would check if the shared memory block exists and if not it will start a ```QLocalServer``` and then listen for connections on it. Each subsequent instance of your application would check if the shared memory block exists and if it does, it will connect to the QLocalServer to notify it that a new instance had been started, after which would terminate the new instance with status code ```0```. The Primary Instance, ```SingleApplication``` would emmit the ```showUp()``` signal upon detecting that a new instance had been started.
The library uses ```stdlib``` to terminate the program with the ```exit()``` function.
Here is an example usage of the library:
```cpp
#include "singleapplication.h"
int main(int argc, char *argv[])
{
QApplication::setApplicationName("{Your App Name}");
QApplication::setOrganizationName("{Your Organization Name}");
SingleApplication app(argc, argv);
return app.exec();
}
```
The ```Show Up``` signal
------------------------
The SingleApplication class implements a ```showUp()``` signal. You can bind to that signal to raise your application's window when a new instance had been started.
Note that since ```SingleApplication``` extends the ```QApplication``` class you can do the following:
```cpp
QObject::connect(QApplication::instance(), SIGNAL(showUp()), window, SLOT(raise())); // window is your QWindow instance
```
Using ```QApplication::instance()``` is a neat way to get the ```SingleApplication``` instance at any place in your program.
Extending from other application classes
-----------------------
-```SingleApplication``` extends from the ```QApplication``` class by default , but you can easily change that to ```QGuiApplication``` or ```QCoreApplication``` from the ```singleapplication.h``` file, using the ```QAPPLICATION_CLASS``` macro.
+`SingleApplication` extends from the `QApplication` class by default , but you can easily change that to `QGuiApplication` or `QCoreApplication` with the `QAPPLICATION_CLASS` macro. Define it before the include statement of `singleapplication.h` or change the default value in the file.
__Example:__
```cpp
#define QAPPLICATION_CLASS QCoreApplication
```
Implementation
--------------
The library is implemented with a QSharedMemory block which is thread safe and guarantees a race condition will not occur. It also uses a QLocalSocket to notify the main process that a new instance had been spawned and thus invoke the ```showUp()``` signal.
To handle an issue with ```Unix``` systems, where the operating system owns the shared memory block and if the program crashes the memory remains untouched, the library binds to the following signals and closes the program with error code = ```128 + signum``` where signum is the number representation of the signal listed below. Handling the signal is required in order to safely delete the ```QSharedMemory``` block.
* ```SIGINT ``` - ```2```
* ```SIGILL ``` - ```4```
* ```SIGABRT``` - ```6```
* ```SIGFPE ``` - ```8```
* ```SIGSEGV``` - ```11```
* ```SIGTERM``` - ```15```
License
-------
This library and it's supporting documentation are released under ```The MIT License (MIT)```.
diff --git a/singleapplication.h b/singleapplication.h
index 3766d61..1fe5c12 100644
--- a/singleapplication.h
+++ b/singleapplication.h
@@ -1,34 +1,36 @@
#ifndef SINGLE_APPLICATION_H
#define SINGLE_APPLICATION_H
// Change this to inherit from QGuiApplication or QCoreApplication
-#define QAPPLICATION_CLASS QApplication
+#ifndef QAPPLICATION_CLASS
+ #define QAPPLICATION_CLASS QCoreApplication
+#endif
#define QUOTE(C) #C
#define INCLUDE_FILE(C) QUOTE(C)
#include INCLUDE_FILE(QAPPLICATION_CLASS)
class SingleApplicationPrivate;
/**
* @brief The SingleApplication class handles multipe instances of the same Application
* @see QApplication
*/
class SingleApplication : public QAPPLICATION_CLASS
{
Q_OBJECT
public:
explicit SingleApplication(int&, char *[]);
~SingleApplication();
signals:
void showUp();
private slots:
void slotConnectionEstablished();
private:
SingleApplicationPrivate *d_ptr;
};
#endif // SINGLE_APPLICATION_H

File Metadata

Mime Type
text/x-diff
Expires
Fri, Sep 12, 10:31 AM (1 d, 4 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
42851
Default Alt Text
(4 KB)

Event Timeline