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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
/*
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 EXECUTABLESLIST_H
#define EXECUTABLESLIST_H
#include <vector>
#include <QFileInfo>
#include <QMetaType>
#include <gameinfo.h>
#include <iplugingame.h>
/*!
* @brief Information about an executable
**/
struct Executable {
QString m_Title;
QFileInfo m_BinaryInfo;
QString m_Arguments;
MOBase::ExecutableInfo::CloseMOStyle m_CloseMO;
QString m_SteamAppID;
QString m_WorkingDirectory;
enum Flag {
CustomExecutable = 0x01,
ShowInToolbar = 0x02,
UseApplicationIcon = 0x04
};
Q_DECLARE_FLAGS(Flags, Flag)
Flags m_Flags;
bool isCustom() const { return m_Flags.testFlag(CustomExecutable); }
bool shownOnToolbar() const { return m_Flags.testFlag(ShowInToolbar); }
void showOnToolbar(bool state);
bool usesOwnIcon() const { return m_Flags.testFlag(UseApplicationIcon); }
};
/*!
* @brief List of executables configured to by started from MO
**/
class ExecutablesList {
public:
/**
* @brief constructor
*
**/
ExecutablesList();
~ExecutablesList();
/**
* @brief initialise the list with the executables preconfigured for this game
**/
void init(MOBase::IPluginGame *game);
/**
* @brief retrieve an executable by index
*
* @param index index of the executable to look up
* @return reference to the executable
* @exception out_of_range will throw an exception if the index is invalid
**/
const Executable &get(int index) const { return m_Executables.at(index); }
/**
* @brief find an executable by its name
*
* @param title the title of the executable to look up
* @return the executable
* @exception runtime_error will throw an exception if the name is not correct
**/
const Executable &find(const QString &title) const;
/**
* @brief find an executable by its name
*
* @param title the title of the executable to look up
* @return the executable
* @exception runtime_error will throw an exception if the name is not correct
**/
Executable &find(const QString &title);
/**
* @brief find an executable by a fileinfo structure
* @param info the info object to search for
* @return the executable
* @exception runtime_error will throw an exception if the name is not correct
*/
Executable &findByBinary(const QFileInfo &info);
/**
* @brief determine if an executable exists
* @param title the title of the executable to look up
* @return true if the executable exists, false otherwise
**/
bool titleExists(const QString &title) const;
/**
* @brief add a new executable to the list
* @param executable
*/
void addExecutable(const Executable &executable);
/**
* @brief add a new executable to the list
*
* @param title name displayed in the UI
* @param executableName the actual filename to execute
* @param arguments arguments to pass to the executable
* @param closeMO if true, MO will be closed when the binary is started
**/
void addExecutable(const QString &title,
const QString &executableName,
const QString &arguments,
const QString &workingDirectory,
MOBase::ExecutableInfo::CloseMOStyle closeMO,
const QString &steamAppID,
Executable::Flags flags);
/**
* @brief remove the executable with the specified file name. This needs to be an absolute file path
*
* @param title title of the executable to remove
* @note if the executable name is invalid, nothing happens. There is no way to determine if this was successful
**/
void remove(const QString &title);
/**
* @brief retrieve begin and end iterators of the configured executables
*
* @param begin iterator to the first executable
* @param end iterator one past the last executable
**/
void getExecutables(std::vector<Executable>::const_iterator &begin, std::vector<Executable>::const_iterator &end) const;
/**
* @brief retrieve begin and end iterators of the configured executables
*
* @param begin iterator to the first executable
* @param end iterator one past the last executable
**/
void getExecutables(std::vector<Executable>::iterator &begin, std::vector<Executable>::iterator &end);
/**
* @brief get the number of executables (custom or otherwise)
**/
size_t size() const {
return m_Executables.size();
}
private:
std::vector<Executable>::iterator findExe(const QString &title);
void addExecutableInternal(const QString &title, const QString &executableName, const QString &arguments,
const QString &workingDirectory, MOBase::ExecutableInfo::CloseMOStyle closeMO,
const QString &steamAppID);
private:
std::vector<Executable> m_Executables;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(Executable::Flags)
#endif // EXECUTABLESLIST_H
|
