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
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef PERFORCESETTINGS_H
#define PERFORCESETTINGS_H
#include <QString>
#include <QScopedPointer>
QT_BEGIN_NAMESPACE
class QSettings;
class QDir;
QT_END_NAMESPACE
namespace Perforce {
namespace Internal {
struct Settings {
Settings();
bool equals(const Settings &s) const;
QStringList commonP4Arguments() const;
// Checks. On success, errorMessage will contains the client root.
bool check(QString *repositoryRoot /* = 0*/, QString *errorMessage) const;
static bool doCheck(const QString &binary, const QStringList &basicArgs,
QString *repositoryRoot /* = 0 */,
QString *errorMessage);
QString p4Command;
QString p4BinaryPath;
QString p4Port;
QString p4Client;
QString p4User;
QString errorString;
int logCount;
bool defaultEnv;
int timeOutS;
bool promptToSubmit;
bool autoOpen;
};
inline bool operator==(const Settings &s1, const Settings &s2) { return s1.equals(s2); }
inline bool operator!=(const Settings &s1, const Settings &s2) { return !s1.equals(s2); }
/* PerforceSettings: Aggregates settings struct and toplevel directory
* which is determined externally by background checks and provides a convenience
* for determining the common arguments.
* Those must contain (apart from server connection settings) the working directory
* with the "-d" option. This is because the p4 command line client detects its path
* from the PWD environment variable which breaks relative paths since that is set by
* the shell running Creator and is not necessarily that of the working directory
* (see p4 documentation).
* An additional complication is that the repository might be a symbolic link on Unix,
* say "$HOME/dev" linked to "/depot". If the p4 client specification contains
* "$HOME/dev", paths containing "/depot" will be refused as "not under client's view" by
* p4. This is why the client root portion of working directory must be mapped for the
* "-d" option, so that running p4 in "/depot/dev/foo" results in "-d $HOME/dev/foo". */
class PerforceSettings
{
Q_DISABLE_COPY(PerforceSettings)
public:
PerforceSettings();
~PerforceSettings();
inline bool isValid() const
{
return !m_topLevel.isEmpty() && !m_settings.p4BinaryPath.isEmpty();
}
void fromSettings(QSettings *settings);
void toSettings(QSettings *) const;
void setSettings(const Settings &s);
Settings settings() const;
inline int timeOutS() const { return m_settings.timeOutS; }
inline int timeOutMS() const { return m_settings.timeOutS * 1000; }
inline int longTimeOutMS() const { return m_settings.timeOutS * 10000; }
inline int logCount() const { return m_settings.logCount; }
QString topLevel() const;
QString topLevelSymLinkTarget() const;
void setTopLevel(const QString &);
// Return relative path to top level. Returns "" if it is the same directory,
// ".." if it is not within.
QString relativeToTopLevel(const QString &dir) const;
// Return argument list relative to top level (empty meaning,
// it is the same directory).
QString relativeToTopLevelArguments(const QString &dir) const;
// Map p4 path back to file system in case of a symlinked top-level
QString mapToFileSystem(const QString &perforceFilePath) const;
QString p4Command() const;
QString p4BinaryPath() const;
QString p4Port() const;
QString p4Client() const;
QString p4User() const;
bool defaultEnv() const;
bool promptToSubmit() const;
void setPromptToSubmit(bool p);
bool autoOpen() const;
void setAutoOpen(bool p);
// Return basic arguments, including -d and server connection parameters.
QStringList commonP4Arguments(const QString &workingDir) const;
private:
inline QStringList workingDirectoryArguments(const QString &workingDir) const;
void clearTopLevel();
Settings m_settings;
QString m_topLevel;
QString m_topLevelSymLinkTarget;
QScopedPointer<QDir> m_topLevelDir;
};
} // Internal
} // Perforce
#endif // PERFORCESETTINGS_H
|
