singleapplication.h

// Copyright (c) Itay Grudev 2015 - 2023
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// Permission is not granted to use this software or any of the associated files
// as sample data for the purposes of building machine learning models.
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
 
#ifndef SINGLE_APPLICATION_H
#define SINGLE_APPLICATION_H
 
#include <QtCore/QtGlobal>
#include <QtNetwork/QLocalSocket>
 
#ifndef QAPPLICATION_CLASS
  #define QAPPLICATION_CLASS QCoreApplication
#endif
 
#include QT_STRINGIFY(QAPPLICATION_CLASS)
 
class SingleApplicationPrivate;
 
class SingleApplication : public QAPPLICATION_CLASS
{
    Q_OBJECT
 
    using app_t = QAPPLICATION_CLASS;
 
public:
    enum Mode {
        User = 1 << 0,
        System = 1 << 1,
        SecondaryNotification = 1 << 2,
        ExcludeAppVersion = 1 << 3,
        ExcludeAppPath = 1 << 4
    };
    Q_DECLARE_FLAGS(Options, Mode)
 
    
    explicit SingleApplication( int &argc, char *argv[], bool allowSecondary = false, Options options = Mode::User, int timeout = 1000, const QString &userData = {} );
    ~SingleApplication() override;
 
    bool isPrimary() const;
 
    bool isSecondary() const;
 
    quint32 instanceId() const;
 
    qint64 primaryPid() const;
 
    QString primaryUser() const;
 
    QString currentUser() const;
 
    enum SendMode {
        NonBlocking,  
        BlockUntilPrimaryExit,  
    };
 
    bool sendMessage( const QByteArray &message, int timeout = 100, SendMode sendMode = NonBlocking );
 
    QStringList userData() const;
 
Q_SIGNALS:
    void instanceStarted();
 
    void receivedMessage( quint32 instanceId, QByteArray message );
 
private:
    SingleApplicationPrivate *d_ptr;
    Q_DECLARE_PRIVATE(SingleApplication)
    void abortSafely();
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS(SingleApplication::Options)
 
#endif // SINGLE_APPLICATION_H