beautifierplugin.h 3.66 KB
Newer Older
Lorenz Haas's avatar
Lorenz Haas committed
1
2
/**************************************************************************
**
Eike Ziller's avatar
Eike Ziller committed
3
4
** Copyright (C) 2015 Lorenz Haas
** Contact: http://www.qt.io/licensing
Lorenz Haas's avatar
Lorenz Haas committed
5
6
7
8
9
10
11
**
** 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
Eike Ziller's avatar
Eike Ziller committed
12
13
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
14
** use the contact form at http://www.qt.io/contact-us.
Lorenz Haas's avatar
Lorenz Haas committed
15
16
17
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18
19
20
21
22
23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
Lorenz Haas's avatar
Lorenz Haas committed
24
**
Eike Ziller's avatar
Eike Ziller committed
25
26
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
Lorenz Haas's avatar
Lorenz Haas committed
27
28
29
30
31
32
33
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#ifndef BEAUTIFIER_BEAUTIFIER_H
#define BEAUTIFIER_BEAUTIFIER_H

34
35
#include "command.h"

Lorenz Haas's avatar
Lorenz Haas committed
36
37
#include <extensionsystem/iplugin.h>

38
39
#include <QFutureInterface>
#include <QPlainTextEdit>
40
#include <QPointer>
41
42
#include <QSignalMapper>

Lorenz Haas's avatar
Lorenz Haas committed
43
44
45
46
47
48
namespace Core { class IEditor; }

namespace Beautifier {
namespace Internal {

class BeautifierAbstractTool;
49
50
51
52

struct FormatTask
{
    FormatTask(QPlainTextEdit *_editor, const QString &_filePath, const QString &_sourceData,
53
               const Command &_command, int _startPos = -1, int _endPos = 0) :
54
55
56
57
        editor(_editor),
        filePath(_filePath),
        sourceData(_sourceData),
        command(_command),
58
59
        startPos(_startPos),
        endPos(_endPos),
60
61
62
63
64
65
        timeout(false) {}

    QPointer<QPlainTextEdit> editor;
    QString filePath;
    QString sourceData;
    Command command;
66
67
    int startPos;
    int endPos;
68
    bool timeout;
69
    QString formattedData;
70
};
Lorenz Haas's avatar
Lorenz Haas committed
71
72
73
74
75
76
77
78
79

class BeautifierPlugin : public ExtensionSystem::IPlugin
{
    Q_OBJECT
    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QtCreatorPlugin" FILE "Beautifier.json")

public:
    BeautifierPlugin();
    ~BeautifierPlugin();
80
81
82
    bool initialize(const QStringList &arguments, QString *errorString) override;
    void extensionsInitialized() override;
    ShutdownFlag aboutToShutdown() override;
Lorenz Haas's avatar
Lorenz Haas committed
83

84
85
    QString format(const QString &text, const Command &command, const QString &fileName,
                   bool *timeout = 0);
86
    void formatCurrentFile(const Command &command, int startPos = -1, int endPos = 0);
87
    void formatAsync(QFutureInterface<FormatTask> &future, FormatTask task);
Lorenz Haas's avatar
Lorenz Haas committed
88

89
90
91
92
93
    static QString msgCannotGetConfigurationFile(const QString &command);
    static QString msgFormatCurrentFile();
    static QString msgFormatSelectedText();
    static QString msgCommandPromptDialogTitle(const QString &command);

94
95
96
public slots:
    static void showError(const QString &error);

Lorenz Haas's avatar
Lorenz Haas committed
97
98
private slots:
    void updateActions(Core::IEditor *editor = 0);
99
100
101
102
    void formatCurrentFileContinue(QObject *watcher = 0);

signals:
    void pipeError(QString);
Lorenz Haas's avatar
Lorenz Haas committed
103
104
105

private:
    QList<BeautifierAbstractTool *> m_tools;
106
    QSignalMapper *m_asyncFormatMapper;
Lorenz Haas's avatar
Lorenz Haas committed
107
108
109
110
111
112
113
};

} // namespace Internal
} // namespace Beautifier

#endif // BEAUTIFIER_BEAUTIFIER_H