summaryrefslogtreecommitdiff
path: root/src/singleinstance.h
blob: d500a056644bc9c36c2094b39a29835911f2b5f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
/*
Copyright (C) 2012 Sebastian Herbord. All rights reserved.

This file is part of Mod Organizer.

Mod Organizer is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Mod Organizer is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Mod Organizer.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef SINGLEINSTANCE_H
#define SINGLEINSTANCE_H

#include <QObject>
#include <QSharedMemory>
#include <QLocalServer>


/**
 * used to ensure only a single instance of Mod Organizer is started and to
 * allow ephemeral instances to send messages to the primary (visible) one.
 * This way, other instances can start a download in the primary one
 **/
class SingleInstance : public QObject
{

  Q_OBJECT

public:
  enum Flag
  {
    NoFlags      = 0x00,

    // if another instance is running, run this one disconnected from the
    // shared memory
    AllowMultiple = 0x01
  };

	using Flags = QFlags<Flag>;


  explicit SingleInstance(Flags flags, QObject *parent = 0);

  /**
   * @return true if this instance's job is to forward data to the primary
   *              instance through shared memory
   **/
  bool ephemeral() const
  {
    return m_Ephemeral;
  }

  // returns true if this is not the primary instance, but was allowed because
  // of the AllowMultiple flag
  //
  bool secondary() const
  {
    return !m_Ephemeral && !m_OwnsSM;
  }

  /**
   * send a message to the primary instance. This can be used to transmit download urls
   *
   * @param message message to send
   **/
  void sendMessage(const QString &message);

signals:

  /**
   * @brief emitted when an ephemeral instance has sent a message (to us)
   *
   * @param message the message we received
   **/
  void messageSent(const QString &message);

public slots:

private slots:

  void receiveMessage();

private:
  bool m_Ephemeral;
  bool m_OwnsSM;
  QSharedMemory m_SharedMem;
  QLocalServer m_Server;

};

Q_DECLARE_OPERATORS_FOR_FLAGS(SingleInstance::Flags);

#endif // SINGLEINSTANCE_H