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
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#pragma once
#include <coreplugin/dialogs/ioptionspage.h>
#include <utils/aspects.h>
QT_BEGIN_NAMESPACE
class QDir;
QT_END_NAMESPACE
namespace Perforce {
namespace Internal {
/* PerforceSettings: Aggregates settings items 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 : public Utils::AspectContainer
{
Q_DECLARE_TR_FUNCTIONS(Perforce::Internal::SettingsPage)
public:
PerforceSettings();
~PerforceSettings();
bool isValid() 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);
int longTimeOutS() const { return timeOutS.value() * 10; }
int timeOutMS() const { return timeOutS.value() * 1000; }
Utils::FilePath topLevel() const;
Utils::FilePath 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;
bool defaultEnv() const;
// Return basic arguments, including -d and server connection parameters.
QStringList commonP4Arguments() const;
QStringList commonP4Arguments(const QString &workingDir) const;
void clearTopLevel();
Utils::StringAspect p4BinaryPath;
Utils::StringAspect p4Port;
Utils::StringAspect p4Client;
Utils::StringAspect p4User;
Utils::IntegerAspect logCount;
Utils::BoolAspect customEnv;
Utils::IntegerAspect timeOutS;
Utils::BoolAspect promptToSubmit;
Utils::BoolAspect autoOpen;
private:
QStringList workingDirectoryArguments(const QString &workingDir) const;
QString m_topLevel;
QString m_topLevelSymLinkTarget;
QDir *m_topLevelDir = nullptr;
};
class PerforceSettingsPage final : public Core::IOptionsPage
{
public:
explicit PerforceSettingsPage(PerforceSettings *settings);
};
} // namespace Internal
} // namespace Perforce
|
