Differential D758 Diff 1799 outputview/ifilterstrategy.h

Changeset View

Standalone View

View Options

outputview/ifilterstrategy.h

1/* 1​/*
2 Interface description for KDevelop OutputView Filter strategies 2​ Interface description for KDevelop OutputView Filter strategies
3 Copyright (C) 2012 Morten Danielsen Volden mvolden2@gmail.com 3​ Copyright (C) 2012 Morten Danielsen Volden mvolden2@gmail.com
4​ Copyright (C) 2016 Kevin Funk <kfunk@kde.org>
4 5​
5 This program is free software: you can redistribute it and/or modify 6​ This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by 7​ it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 2 of the License, or 8​ the Free Software Foundation, either version 2 of the License, or
8 (at your option) any later version. 9​ (at your option) any later version.
9 10​
10 This program is distributed in the hope that it will be useful, 11​ This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of 12​ but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details. 14​ GNU General Public License for more details.
14 15​
15 You should have received a copy of the GNU General Public License 16​ You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. 17​ along with this program. If not, see <http://www.gnu.org/licenses/>.
17*/ 18​*/
18 19​
19 20​
20#ifndef KDEVPLATFORM_IFILTERSTRATEGY_H 21​#ifndef KDEVPLATFORM_IFILTERSTRATEGY_H
21#define KDEVPLATFORM_IFILTERSTRATEGY_H 22​#define KDEVPLATFORM_IFILTERSTRATEGY_H
22 23​
23#include "outputviewexport.h" 24​#include "outputviewexport.h"
24 25​
25class QString; 26​#include <QMetaType>
27​#include <QString>
26 28​
27namespace KDevelop 29​namespace KDevelop
28{ 30​{
29 31​
30struct FilteredItem; 32​struct FilteredItem;
31 33​
32/** 34​/**
33* Interface class for filtering output. Filtered output is divided into two catagories: Errors 35​* Interface class for filtering output. Filtered output is divided into two catagories: Errors
34* and Actions. Use this interface if you want to write a filter for the outputview. 36​* and Actions. Use this interface if you want to write a filter for the outputview.
35* 37​*
36* @author Morten Danielsen Volden 38​* @author Morten Danielsen Volden
37*/ 39​*/
38class KDEVPLATFORMOUTPUTVIEW_EXPORT IFilterStrategy 40​class KDEVPLATFORMOUTPUTVIEW_EXPORT IFilterStrategy
39{ 41​{
40public: 42​public:
41 ​
42 IFilterStrategy(); 43​ IFilterStrategy();
43 virtual ~IFilterStrategy(); 44​ virtual ~IFilterStrategy();
44 45​
46​ struct Progress
mwolffUnsubmitted
Not Done

struct

mwolff: struct
47​ {
48​ QString status; /// Status message (example: "Building foo.cpp")
49​ int percent; /// Percentage from 0-100; -1 indicates no progress could be parsed
mwolffUnsubmitted
Not Done

float percent?

also save a few chars via

const QString& status = {}
mwolff: float percent? also save a few chars via const QString& status = {}
mwolffUnsubmitted
Not Done

int percent = -1;

i.e. default construct it right here.

mwolff: int percent = -1; i.e. default construct it right here.
50​ };
51​
45 /** 52​ /**
46 * Examine if a given line contains output that is defined as an error (E.g. from a script or from a compiler, or other). 53​ * Examine if a given line contains output that is defined as an error (E.g. from a script or from a compiler, or other).
47 * @param line the line to examine 54​ * @param line the line to examine
48 * @return FilteredItem with associated metadata if an error is found, an item of type InvalidItem otherwise 55​ * @return FilteredItem with associated metadata if an error is found, an item of type InvalidItem otherwise
49 **/ 56​ **/
50 virtual FilteredItem errorInLine(QString const& line) = 0; 57​ virtual FilteredItem errorInLine(QString const& line) = 0;
51 58​
52 /** 59​ /**
53 * Examine if a given line contains output that is defined as an action (E.g. from a script or from a compiler, or other). 60​ * Examine if a given line contains output that is defined as an action (E.g. from a script or from a compiler, or other).
54 * @param line the line to examine 61​ * @param line the line to examine
55 * @return Filtered of type ActionItem with associated metadata if an action is found, an item of type InvalidItem otherwise 62​ * @return Filtered of type ActionItem with associated metadata if an action is found, an item of type InvalidItem otherwise
56 **/ 63​ **/
57 virtual FilteredItem actionInLine(QString const& line) = 0; 64​ virtual FilteredItem actionInLine(QString const& line) = 0;
58 65​
59}; 66​ /**
60 67​ * Examine if a given line contains output which reports progress information
68​ *
69​ * E.g. `make` reports progress like this:
70​ * @code
71​ * [ 5%] Doing something
72​ * [ 6%] Doing something
73​ * @encode
74​ *
75​ * @return Processed percent & status of the output, default implementation returns default-constructed value
mwolffUnsubmitted
Not Done

how do you differentiate between invalid and valid progress? 0% can be valid, no?

mwolff: how do you differentiate between invalid and valid progress? 0% can be valid, no?
76​ */
77​ virtual Progress progressInLine(const QString& line);
61 78​
79​};
62 80​
63} // namespace KDevelop 81​} // namespace KDevelop
64 82​
83​Q_DECLARE_METATYPE(KDevelop::IFilterStrategy*)
84​Q_DECLARE_METATYPE(KDevelop::IFilterStrategy::Progress);
85​
65#endif // KDEVPLATFORM_IFILTERSTRATEGY_H 86​#endif // KDEVPLATFORM_IFILTERSTRATEGY_H