Differential D17971 Diff 54071 addons/externaltools/kateexternaltool.h

Changeset View

Standalone View

View Options

addons/externaltools/kateexternaltool.h

  • This file was added.
1​/* This file is part of the KDE project
2​ *
3​ * Copyright 2019 Dominik Haumann <dhaumann@kde.org>
4​ *
5​ * This library is free software; you can redistribute it and/or
6​ * modify it under the terms of the GNU Library General Public
7​ * License as published by the Free Software Foundation; either
8​ * version 2 of the License, or (at your option) any later version.
9​ *
10​ * This library is distributed in the hope that it will be useful,
11​ * but WITHOUT ANY WARRANTY; without even the implied warranty of
12​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13​ * Library General Public License for more details.
14​ *
15​ * You should have received a copy of the GNU Library General Public License
16​ * along with this library; see the file COPYING.LIB. If not, write to
17​ * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18​ * Boston, MA 02110-1301, USA.
19​ */
20​#ifndef KTEXTEDITOR_KATE_EXTERNALTOOL_H
21​#define KTEXTEDITOR_KATE_EXTERNALTOOL_H
22​
23​#include <QMetaType>
24​#include <QString>
25​#include <QStringList>
26​
27​class KConfigGroup;
28​
29​/**
30​ * This class defines a single external tool.
31​ */
32​class KateExternalTool
33​{
34​public:
35​ /**
36​ * Defines whether any document should be saved before running the tool.
37​ */
38​ enum class SaveMode {
39​ //! Do not save any document.
40​ None,
41​ //! Save current document.
42​ CurrentDocument,
43​ //! Save all documents
44​ AllDocuments
45​ };
46​
47​ /**
48​ * Defines where to redirect stdout from the tool.
49​ */
50​ enum class OutputMode {
51​ Ignore,
52​ InsertAtCursor,
53​ ReplaceSelectedText,
54​ ReplaceCurrentDocument,
55​ AppendToCurrentDocument,
56​ InsertInNewDocument,
57​ DisplayInPane
58​ };
59​
60​public:
61​ /// The category used in the menu to categorize the tool.
62​ QString category;
63​ /// The name used in the menu.
64​ QString name;
65​ /// the icon to use in the menu.
66​ QString icon;
loh.tarUnsubmitted
Not Done

T

loh.tar: T
67​ /// The name or path of the executable.
68​ QString executable;
69​ /// The command line arguments.
70​ QString arguments;
71​ /// The stdin input.
72​ QString input;
73​ /// The working directory, if specified.
74​ QString workingDir;
75​ /// Optional list of mimetypes for which this action is valid.
76​ QStringList mimetypes;
77​ /// The name for the action. This is generated first time the
78​ /// action is is created.
79​ QString actionName;
80​ /// The name for the commandline.
81​ QString cmdname;
loh.tarUnsubmitted
Not Done

command line ?

loh.tar: command line ?
82​ /// Possibly save documents prior to activating the tool command.
83​ SaveMode saveMode = SaveMode::None;
84​ /// Reload current document after execution
85​ bool reload = false;
86​ /// Defines where to redirect the tool's output
87​ OutputMode outputMode = OutputMode::Ignore;
loh.tarUnsubmitted
Not Done

you had always dots at the end, same one line above

loh.tar: you had always dots at the end, same one line above
88​
89​public:
90​ /// This is set when loading the Tool from disk.
91​ bool hasexec = false;
loh.tarUnsubmitted
Not Done

Is is set when load the tool from disk. ?

loh.tar: Is is set when load the tool from disk. ?
92​
93​ /**
94​ * @return true if mimetypes is empty, or the @p mimetype matches.
95​ */
96​ bool matchesMimetype(const QString& mimetype) const;
97​
98​ /**
99​ * @return true if "executable" exists and has the executable bit set, or is
100​ * empty.
101​ * This is run at least once, and the tool is disabled if it fails.
102​ */
103​ bool checkExec() const;
104​
105​ /**
106​ * Load tool data from the config group @p cg.
107​ */
108​ void load(const KConfigGroup& cg);
109​
110​ /**
111​ * Save tool data to the config group @p cg.
112​ */
113​ void save(KConfigGroup& cg) const;
114​};
115​
116​/**
117​ * Compares for equality. All fields have to match.
118​ */
119​bool operator==(const KateExternalTool & lhs, const KateExternalTool & rhs);
120​
121​// for use in QVariant (QAction::setData() and QAction::data())
122​Q_DECLARE_METATYPE(KateExternalTool*)
123​
124​#endif // KTEXTEDITOR_KATE_EXTERNALTOOL_H
125​
126​// kate: space-indent on; indent-width 4; replace-tabs on;