gitgrep.cpp 7.79 KB
Newer Older
Orgad Shaneh's avatar
Orgad Shaneh committed
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
/****************************************************************************
**
** Copyright (C) 2016 Orgad Shaneh <orgads@gmail.com>.
** 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.
**
****************************************************************************/

#include "gitgrep.h"
#include "gitclient.h"
#include "gitplugin.h"

#include <coreplugin/vcsmanager.h>
31
#include <texteditor/findinfiles.h>
Orgad Shaneh's avatar
Orgad Shaneh committed
32
33
34
35
36
37
38
39
#include <vcsbase/vcsbaseconstants.h>

#include <utils/filesearch.h>
#include <utils/fileutils.h>
#include <utils/qtcassert.h>
#include <utils/qtcprocess.h>
#include <utils/runextensions.h>

40
41
#include <QCheckBox>
#include <QCoreApplication>
Orgad Shaneh's avatar
Orgad Shaneh committed
42
43
44
45
46
47
48
49
50
51
52
53
54
55
#include <QEventLoop>
#include <QFuture>
#include <QFutureWatcher>
#include <QSettings>

using namespace Utils;

namespace Git {
namespace Internal {

using namespace Core;

namespace {

56
57
const char EnableGitGrep[] = "EnableGitGrep";

Orgad Shaneh's avatar
Orgad Shaneh committed
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
class GitGrepRunner : public QObject
{
    using FutureInterfaceType = QFutureInterface<FileSearchResultList>;

public:
    GitGrepRunner(FutureInterfaceType &fi,
                  const TextEditor::FileFindParameters &parameters) :
        m_fi(fi),
        m_parameters(parameters)
    {
        m_directory = parameters.additionalParameters.toString();
    }

    void processLine(const QByteArray &line, FileSearchResultList *resultList) const
    {
        if (line.isEmpty())
            return;
        static const char boldRed[] = "\x1b[1;31m";
        static const char resetColor[] = "\x1b[m";
        FileSearchResult single;
        const int lineSeparator = line.indexOf('\0');
        single.fileName = m_directory + QLatin1Char('/')
                + QString::fromLocal8Bit(line.left(lineSeparator));
        const int textSeparator = line.indexOf('\0', lineSeparator + 1);
        single.lineNumber = line.mid(lineSeparator + 1, textSeparator - lineSeparator - 1).toInt();
        QByteArray text = line.mid(textSeparator + 1);
        QVector<QPair<int, int>> matches;
        for (;;) {
            const int matchStart = text.indexOf(boldRed);
            if (matchStart == -1)
                break;
            const int matchTextStart = matchStart + int(sizeof(boldRed)) - 1;
            const int matchEnd = text.indexOf(resetColor, matchTextStart);
            QTC_ASSERT(matchEnd != -1, break);
            const int matchLength = matchEnd - matchTextStart;
            matches.append(qMakePair(matchStart, matchLength));
            text = text.left(matchStart) + text.mid(matchTextStart, matchLength)
                    + text.mid(matchEnd + int(sizeof(resetColor)) - 1);
        }
        single.matchingLine = QString::fromLocal8Bit(text);
        foreach (auto match, matches) {
            single.matchStart = match.first;
            single.matchLength = match.second;
            resultList->append(single);
        }
    }

    void read()
    {
        FileSearchResultList resultList;
        while (m_process.canReadLine() && !m_fi.isCanceled())
            processLine(m_process.readLine().trimmed(), &resultList);
        if (!resultList.isEmpty())
            m_fi.reportResult(resultList);
    }

    void exec()
    {
        m_fi.setProgressRange(0, 1);
        m_fi.setProgressValue(0);

        QStringList arguments;
        arguments << QLatin1String("-c") << QLatin1String("color.grep.match=bold red")
                  << QLatin1String("grep") << QLatin1String("-zn")
                  << QLatin1String("--color=always");
        if (!(m_parameters.flags & FindCaseSensitively))
            arguments << QLatin1String("-i");
        if (m_parameters.flags & FindWholeWords)
            arguments << QLatin1String("-w");
        if (m_parameters.flags & FindRegularExpression)
            arguments << QLatin1String("-P");
        else
            arguments << QLatin1String("-F");
        arguments << m_parameters.text;
        arguments << QLatin1String("--") << m_parameters.nameFilters;
        QString args;
        m_process.addArgs(&args, arguments);
        m_process.setWorkingDirectory(m_directory);
        m_process.setCommand(GitPlugin::instance()->client()->vcsBinary().toString(), args);
        QFutureWatcher<FileSearchResultList> watcher;
        watcher.setFuture(m_fi.future());
        connect(&watcher, &QFutureWatcher<FileSearchResultList>::canceled,
                &m_process, &QtcProcess::kill);
        connect(&m_process, &QProcess::readyRead,
                this, &GitGrepRunner::read);
        m_process.start();
        if (!m_process.waitForStarted())
            return;
Orgad Shaneh's avatar
Orgad Shaneh committed
146
147
148
149
150
151
        QEventLoop eventLoop;
        connect(&m_process, static_cast<void(QProcess::*)(int)>(&QProcess::finished),
                this, [this, &eventLoop]() {
            read();
            eventLoop.quit();
        });
Orgad Shaneh's avatar
Orgad Shaneh committed
152
        eventLoop.exec();
Orgad Shaneh's avatar
Orgad Shaneh committed
153
        m_fi.setProgressValue(1);
Orgad Shaneh's avatar
Orgad Shaneh committed
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
    }

    static void run(QFutureInterface<FileSearchResultList> &fi,
                    TextEditor::FileFindParameters parameters)
    {
        GitGrepRunner runner(fi, parameters);
        runner.exec();
    }

private:
    QtcProcess m_process;
    FutureInterfaceType m_fi;
    QString m_directory;
    const TextEditor::FileFindParameters &m_parameters;
};

} // namespace

172
static bool validateDirectory(const QString &path)
Orgad Shaneh's avatar
Orgad Shaneh committed
173
{
174
175
176
    static IVersionControl *gitVc = VcsManager::versionControl(VcsBase::Constants::VCS_ID_GIT);
    QTC_ASSERT(gitVc, return false);
    return gitVc == VcsManager::findVersionControlForDirectory(path, 0);
Orgad Shaneh's avatar
Orgad Shaneh committed
177
178
}

179
GitGrep::GitGrep()
Orgad Shaneh's avatar
Orgad Shaneh committed
180
{
181
182
183
184
185
186
187
188
189
190
    m_widget = new QCheckBox(tr("&Use Git Grep"));
    m_widget->setToolTip(tr("Use Git Grep for searching. This includes only files "
                            "that are managed by source control."));
    TextEditor::FindInFiles *findInFiles = TextEditor::FindInFiles::instance();
    QTC_ASSERT(findInFiles, return);
    QObject::connect(findInFiles, &TextEditor::FindInFiles::pathChanged,
                     m_widget.data(), [this](const QString &path) {
        m_widget->setEnabled(validateDirectory(path));
    });
    findInFiles->setFindExtension(this);
Orgad Shaneh's avatar
Orgad Shaneh committed
191
192
}

193
GitGrep::~GitGrep()
Orgad Shaneh's avatar
Orgad Shaneh committed
194
{
195
    delete m_widget.data();
Orgad Shaneh's avatar
Orgad Shaneh committed
196
197
}

198
QString GitGrep::title() const
Orgad Shaneh's avatar
Orgad Shaneh committed
199
{
200
    return tr("Git Grep");
Orgad Shaneh's avatar
Orgad Shaneh committed
201
202
}

203
QWidget *GitGrep::widget() const
Orgad Shaneh's avatar
Orgad Shaneh committed
204
{
205
    return m_widget.data();
Orgad Shaneh's avatar
Orgad Shaneh committed
206
207
}

208
bool GitGrep::isEnabled() const
Orgad Shaneh's avatar
Orgad Shaneh committed
209
{
210
    return m_widget->isEnabled() && m_widget->isChecked();
Orgad Shaneh's avatar
Orgad Shaneh committed
211
212
}

213
bool GitGrep::isEnabled(const TextEditor::FileFindParameters &parameters) const
Orgad Shaneh's avatar
Orgad Shaneh committed
214
{
215
    return parameters.extensionParameters.toBool();
Orgad Shaneh's avatar
Orgad Shaneh committed
216
217
}

218
QVariant GitGrep::parameters() const
Orgad Shaneh's avatar
Orgad Shaneh committed
219
{
220
    return isEnabled();
Orgad Shaneh's avatar
Orgad Shaneh committed
221
222
223
224
}

void GitGrep::readSettings(QSettings *settings)
{
225
    m_widget->setChecked(settings->value(QLatin1String(EnableGitGrep), false).toBool());
Orgad Shaneh's avatar
Orgad Shaneh committed
226
227
}

228
void GitGrep::writeSettings(QSettings *settings) const
Orgad Shaneh's avatar
Orgad Shaneh committed
229
{
230
    settings->setValue(QLatin1String(EnableGitGrep), m_widget->isChecked());
Orgad Shaneh's avatar
Orgad Shaneh committed
231
232
}

233
234
QFuture<FileSearchResultList> GitGrep::executeSearch(
        const TextEditor::FileFindParameters &parameters)
Orgad Shaneh's avatar
Orgad Shaneh committed
235
{
236
    return Utils::runAsync<FileSearchResultList>(GitGrepRunner::run, parameters);
Orgad Shaneh's avatar
Orgad Shaneh committed
237
238
239
240
}

} // Internal
} // Git