Differential D8709 Diff 41113 kdevplatform/vcs/widgets/vcsannotationitemdelegate.cpp

Changeset View

Standalone View

View Options

kdevplatform/vcs/widgets/vcsannotationitemdelegate.cpp

  • This file was added.
1​/* This file is part of KDevelop
2​ *
3​ * Copyright 2017 Friedrich W. H. Kossebau <kossebau@kde.org>
4​ *
5​ * This program is free software; you can redistribute it and/or
6​ * modify it under the terms of the GNU General Public License
7​ * as published by the Free Software Foundation; either version 2
8​ * of the License, or (at your option) any later version.
9​ *
10​ * This program 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
13​ * GNU General Public License for more details.
14​ *
15​ * You should have received a copy of the GNU General Public License
16​ * along with this program; if not, write to the Free Software
17​ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18​ * 02110-1301, USA.
19​ */
20​
21​#include "vcsannotationitemdelegate.h"
22​
23​#include <models/vcsannotationmodel.h>
24​#include <vcsannotation.h>
25​#include <debug.h>
26​
27​#include <KTextEditor/AnnotationInterface>
28​#include <KTextEditor/View>
29​#include <KTextEditor/ConfigInterface>
30​#include <KTextEditor/Attribute>
31​#include <KLocalizedString>
32​
33​#include <QHelpEvent>
34​#include <QPainter>
35​#include <QAction>
36​#include <QMenu>
37​#include <QToolTip>
38​#include <QFontMetricsF>
39​#include <QDate>
40​#include <QStyle>
41​#include <QApplication>
42​
43​#include <math.h>
44​
45​using namespace KDevelop;
46​
47​VcsAnnotationItemDelegate::VcsAnnotationItemDelegate(KTextEditor::View* view, KTextEditor::AnnotationModel* model,
48​ QObject* parent)
49​ : KTextEditor::AbstractAnnotationItemDelegate(parent)
50​ , m_model(model)
51​{
52​ // dump background brushes on schema change
53​ Q_ASSERT(qobject_cast<KTextEditor::ConfigInterface*>(view));
54​ connect(view, SIGNAL(configChanged()), this, SLOT(resetBackgrounds()));
55​
56​ view->installEventFilter(this);
57​}
58​
59​VcsAnnotationItemDelegate::~VcsAnnotationItemDelegate() = default;
60​
61​// TODO: check if this is correct, was quickly done
62​static QString ageOfDate(const QDate& date)
63​{
64​ const auto now = QDate::currentDate();
65​ int ageInYears = now.year() - date.year();
66​ if (now < date.addYears(ageInYears)) {
67​ --ageInYears;
68​ }
69​ if (ageInYears > 0) {
70​ return i18ncp("age", "%1 year", "%1 years", ageInYears);
71​ }
72​ int ageInMonths = now.month() - date.month();
73​ if (ageInMonths < 0) {
74​ ageInMonths += 12;
75​ }
76​ if (ageInMonths > 0) {
77​ return i18ncp("age", "%1 month", "%1 months", ageInMonths);
78​ }
79​ const int ageInDays = date.daysTo(now);
80​ if (ageInDays > 0) {
81​ return i18ncp("age", "%1 day", "%1 days", ageInDays);
82​ }
83​ return i18n("Today");
84​}
85​
86​void VcsAnnotationItemDelegate::doMessageLineLayout(const KTextEditor::StyleOptionAnnotationItem& option,
87​ QRect* messageRect, QRect* ageRect) const
88​{
89​ Q_ASSERT(messageRect && messageRect->isValid());
90​ Q_ASSERT(ageRect);
91​
92​ const QWidget* const widget = option.view;
93​ QStyle* const style = widget ? widget->style() : QApplication::style();
94​ const bool hasAge = ageRect->isValid();
95​ // "+ 1" as used in QItemDelegate
96​ const int textMargin = style->pixelMetric(QStyle::PM_FocusFrameHMargin, nullptr, widget) + 1;
97​ const int ageMargin = hasAge ? textMargin : 0;
98​
99​ const int x = option.rect.left();
100​ const int y = option.rect.top();
101​ const int w = option.rect.width();
102​ const int h = option.rect.height();
103​
104​ // add margins for fixed elements
105​ QSize ageSize(0, 0); // ageRect could be invalid, so use separate object for calculation
106​ if (hasAge) {
107​ ageSize = ageRect->size();
108​ ageSize.rwidth() += 2 * ageMargin;
109​ }
110​
111​ // distribute space among layout items
112​ QRect message;
113​ QRect age;
114​ if (option.direction == Qt::LeftToRight) {
115​ message.setRect(x, y, w - ageSize.width(), h);
116​ age.setRect(message.right() + 1, y, ageSize.width(), h);
117​ } else {
118​ age.setRect(x, y, ageSize.width(), h);
119​ message.setRect(age.right() + 1, y, w - ageSize.width(), h);
120​ }
121​ // remove margins here, so renderMessageAndAge does not have to
122​ message.adjust(textMargin, 0, -textMargin, 0);
123​ age.adjust(ageMargin, 0, -ageMargin, 0);
124​
125​ // return result
126​ *ageRect = age;
127​ *messageRect = QStyle::alignedRect(option.direction, Qt::AlignLeading,
128​ messageRect->size().boundedTo(message.size()), message);
129​}
130​
131​void VcsAnnotationItemDelegate::doAuthorLineLayout(const KTextEditor::StyleOptionAnnotationItem& option,
132​ QRect* authorRect) const
133​{
134​ Q_ASSERT(authorRect);
135​
136​ // if invalid, nothing to be done, keep as is
137​ if (!authorRect->isValid()) {
138​ return;
139​ }
140​
141​ const QWidget* const widget = option.view;
142​ QStyle* const style = widget ? widget->style() : QApplication::style();
143​ // "+ 1" as used in QItemDelegate
144​ const int authorMargin = style->pixelMetric(QStyle::PM_FocusFrameHMargin, nullptr, widget) + 1;
145​
146​ QRect author = option.rect;
147​ // remove margins here, so renderAuthor does not have to
148​ author.adjust(authorMargin, 0, -authorMargin, 0);
149​
150​ // return result
151​ *authorRect = QStyle::alignedRect(option.direction, Qt::AlignLeading,
152​ authorRect->size().boundedTo(author.size()), author);
153​}
154​
155​void VcsAnnotationItemDelegate::renderBackground(QPainter* painter,
156​ const KTextEditor::StyleOptionAnnotationItem& option,
157​ const VcsAnnotationLine& annotationLine) const
158​{
159​ Q_UNUSED(option);
160​
161​ const auto revision = annotationLine.revision();
162​ auto brushIt = m_backgrounds.find(revision);
163​ if (brushIt == m_backgrounds.end()) {
164​ KTextEditor::Attribute::Ptr normalStyle = option.view->defaultStyleAttribute(KTextEditor::dsNormal);
165​ const auto background = (normalStyle->hasProperty(QTextFormat::BackgroundBrush)) ? normalStyle->background().color() : QColor(Qt::white);
166​ const int background_y = background.red()*0.299 + 0.587*background.green()
167​ + 0.114*background.blue();
168​ // get random, but reproducable 8-bit values from last two bytes of the revision hash
169​ const uint revisionHash = qHash(revision);
170​ const int u = static_cast<int>((0xFF & revisionHash));
171​ const int v = static_cast<int>((0xFF00 & revisionHash) >> 8);
172​ const int r = qRound(qMin(255.0, qMax(0.0, background_y + 1.402*(v-128))));
173​ const int g = qRound(qMin(255.0, qMax(0.0, background_y - 0.344*(u-128) - 0.714*(v-128))));
174​ const int b = qRound(qMin(255.0, qMax(0.0, background_y + 1.772*(u-128))));
175​ brushIt = m_backgrounds.insert(revision, QBrush(QColor(r, g, b)));
176​ }
177​
178​ painter->fillRect(option.rect, brushIt.value());
179​}
180​
181​void VcsAnnotationItemDelegate::renderMessageAndAge(QPainter* painter,
182​ const KTextEditor::StyleOptionAnnotationItem& option,
183​ const QRect& messageRect, const QString& messageText,
184​ const QRect& ageRect, const QString& ageText) const
185​{
186​ Q_UNUSED(option);
187​
188​ painter->save();
189​
190​ KTextEditor::Attribute::Ptr normalStyle = option.view->defaultStyleAttribute(KTextEditor::dsNormal);
191​ painter->setPen(normalStyle->foreground().color());
192​ painter->drawText(messageRect, Qt::AlignLeading | Qt::AlignVCenter,
193​ painter->fontMetrics().elidedText(messageText, Qt::ElideRight, messageRect.width()));
194​
195​ // TODO: defaultStyleAttribute only returns relyably for dsNormal, so what to do for a comment-like color?
196​ KTextEditor::Attribute::Ptr commentStyle = option.view->defaultStyleAttribute(KTextEditor::dsNormal);
197​ painter->setPen(commentStyle->foreground().color());
198​ painter->drawText(ageRect, Qt::AlignTrailing | Qt::AlignVCenter, ageText);
199​
200​ painter->restore();
201​}
202​
203​void VcsAnnotationItemDelegate::renderAuthor(QPainter* painter,
204​ const KTextEditor::StyleOptionAnnotationItem& option,
205​ const QRect& authorRect, const QString& authorText) const
206​{
207​ Q_UNUSED(option);
208​
209​ painter->save();
210​
211​ // TODO: defaultStyleAttribute only returns relyably for dsNormal, so what to do for a comment-like color?
212​ KTextEditor::Attribute::Ptr commentStyle = option.view->defaultStyleAttribute(KTextEditor::dsNormal);
213​ painter->setPen(commentStyle->foreground().color());
214​ painter->drawText(authorRect, Qt::AlignLeading | Qt::AlignVCenter,
215​ painter->fontMetrics().elidedText(authorText, Qt::ElideRight, authorRect.width()));
216​
217​ painter->restore();
218​}
219​
220​void VcsAnnotationItemDelegate::renderHighlight(QPainter* painter,
221​ const KTextEditor::StyleOptionAnnotationItem& option) const
222​{
223​ // Draw a border around all adjacent entries that have the same text as the currently hovered one
224​ if ((option.state & QStyle::State_MouseOver) &&
225​ (option.annotationItemGroupingPosition & KTextEditor::StyleOptionAnnotationItem::InGroup)) {
226​ KTextEditor::Attribute::Ptr style = option.view->defaultStyleAttribute(KTextEditor::dsNormal);
227​ painter->setPen(style->foreground().color());
228​ // draw left and right highlight borders
229​ painter->drawLine(option.rect.topLeft(), option.rect.bottomLeft());
230​ painter->drawLine(option.rect.topRight(), option.rect.bottomRight());
231​
232​ if ((option.annotationItemGroupingPosition & KTextEditor::StyleOptionAnnotationItem::GroupBegin) &&
233​ (option.wrappedLine == 0)) {
234​ painter->drawLine(option.rect.topLeft(), option.rect.topRight());
235​ }
236​
237​ if ((option.annotationItemGroupingPosition & KTextEditor::StyleOptionAnnotationItem::GroupEnd) &&
238​ (option.wrappedLine == (option.wrappedLineCount-1))) {
239​ painter->drawLine(option.rect.bottomLeft(), option.rect.bottomRight());
240​ }
241​ }
242​}
243​
244​void VcsAnnotationItemDelegate::paint(QPainter* painter, const KTextEditor::StyleOptionAnnotationItem& option,
245​ KTextEditor::AnnotationModel* model, int line) const
246​{
247​ Q_ASSERT(painter);
248​ // we cannot use custom roles and data() API (cmp. VcsAnnotationModel dox), so accessing custom API instead
249​ VcsAnnotationModel* vcsModel = qobject_cast<VcsAnnotationModel*>(model);
250​ Q_ASSERT(vcsModel);
251​ if (!painter || !vcsModel) {
252​ return;
253​ }
254​ // TODO: also test line for sake of completeness
255​
256​ // Fetch data from the model
257​ const VcsAnnotationLine annotationLine = vcsModel->annotationLine(line);
258​
259​ if (annotationLine.revision().revisionType() == VcsRevision::Invalid) {
260​ return;
261​ }
262​
263​ // prepare
264​ painter->save();
265​
266​ renderBackground(painter, option, annotationLine);
267​
268​ // TODO: we would like the normal UI font here, which usually is a proportimal one,
269​ // so more text fits into the available space.
270​ // how to ensure that one is scaled matching the zooming,
271​ // and how to ensure it fits into the content line height?
272​ painter->setFont(option.view->font());
273​
274​ if (option.visibleWrappedLineInGroup == 0) {
275​ QRect ageRect;
276​ QString ageText;
277​ const auto date = annotationLine.date();
278​ if (date.isValid()) {
279​ ageText = ageOfDate(date.date());
280​ ageRect = QRect(QPoint(0, 0),
281​ QSize(option.fontMetrics.width(ageText), option.rect.height()));
282​ }
283​ const auto messageText = annotationLine.commitMessage();
284​ auto messageRect = QRect(QPoint(0, 0),
285​ QSize(option.fontMetrics.width(messageText), option.rect.height()));
286​
287​ doMessageLineLayout(option, &messageRect, &ageRect);
288​
289​ renderMessageAndAge(painter, option, messageRect, messageText, ageRect, ageText);
290​ } else if (option.visibleWrappedLineInGroup == 1) {
291​ const auto author = annotationLine.author();
292​ if (!author.isEmpty()) {
293​ const auto authorText = i18nc("By: commit author", "By: %1", author);
294​ auto authorRect = QRect(QPoint(0, 0),
295​ QSize(option.fontMetrics.width(authorText), option.rect.height()));
296​
297​ doAuthorLineLayout(option, &authorRect);
298​
299​ renderAuthor(painter, option, authorRect, authorText);
300​ }
301​ }
302​
303​ renderHighlight(painter, option);
304​
305​ // done
306​ painter->restore();
307​}
308​
309​bool VcsAnnotationItemDelegate::helpEvent(QHelpEvent* event, KTextEditor::View* view,
310​ const KTextEditor::StyleOptionAnnotationItem& option,
311​ KTextEditor::AnnotationModel* model, int line)
312​{
313​ Q_UNUSED(option);
314​qDebug() << "HELPEVENT" << event->globalPos();
315​ if (!model || event->type() != QEvent::ToolTip) {
316​ return false;
317​ }
318​
319​ const QVariant data = model->data(line, Qt::ToolTipRole);
320​ if (!data.isValid()) {
321​ return false;
322​ }
323​
324​ const QString toolTipText = data.toString();
325​ if (toolTipText.isEmpty()) {
326​ return false;
327​ }
328​
329​ QToolTip::showText(event->globalPos(), toolTipText, view, option.rect);
330​ return true;
331​}
332​
333​void VcsAnnotationItemDelegate::hideTooltip(KTextEditor::View *view)
334​{
335​ Q_UNUSED(view);
336​ QToolTip::hideText();
337​}
338​
339​void VcsAnnotationItemDelegate::contextMenuRequested(KTextEditor::View* view, const QPoint& pos,
340​ const KTextEditor::StyleOptionAnnotationItem& option,
341​ KTextEditor::AnnotationModel* model, int line)
342​{
343​ Q_UNUSED(model);
344​ Q_UNUSED(option);
345​
346​ KTextEditor::AnnotationViewInterfaceV2* viewifaceV2 = qobject_cast<KTextEditor::AnnotationViewInterfaceV2*>(view);
347​
348​ if (!viewifaceV2) {
349​ return;
350​ }
351​
352​ QMenu menu;
353​ QAction a(i18n("Disable Annotation Bar"), &menu);
354​ a.setIcon(QIcon::fromTheme(QStringLiteral("dialog-close")));
355​ menu.addAction(&a);
356​ emit viewifaceV2->annotationContextMenuAboutToShow(view, &menu, line);
357​ if (menu.exec(view->mapToGlobal(pos)) == &a) {
358​ viewifaceV2->setAnnotationBorderVisible(false);
359​ }
360​}
361​
362​QSize VcsAnnotationItemDelegate::sizeHint(const KTextEditor::StyleOptionAnnotationItem& option,
363​ KTextEditor::AnnotationModel* model, int line) const
364​{
365​ Q_UNUSED(line);
366​ Q_ASSERT(model);
367​ if (!model) {
368​ return QSize(0, 0);
369​ }
370​ // TODO: find a proper calculation or allow user to configure this?
371​ // for now use some random hardcoded value which is at least fontMetrics based
372​ // idea might be to assume 79 chars for message and then widest age?
373​ // or really calculate for all real lines the needed width for the message + age line?
374​#if 0
375​ QRect ageRect =
376​ QRect messageRect = rect from message
377​ doMessageLineLayout(option, &messageRect, &ageRect); // would need margins kept with rects
378​ return (ageRect|messageRect).size();
379​#endif
380​ const QFontMetricsF& fm(option.fontMetrics);
381​ // if only averageCharWidth would yield sane values,
382​ // multiply by 40 in average seemed okayish at least with english, showing enough of message
383​ m_lastCharBasedWidthHint = ceil(40 * fm.averageCharWidth());
384​ m_lastViewBasedWidthHint = widthHintFromViewWidth(option.view->width());
385​ return QSize(qMin(m_lastCharBasedWidthHint, m_lastViewBasedWidthHint), fm.height());
386​}
387​
388​bool VcsAnnotationItemDelegate::eventFilter(QObject* object, QEvent* event)
389​{
croickUnsubmitted
Not Done

On a small screen, that's taking a little too much space in my opinion. I preferred 20%.

What would be necessary to make it resizable?

croick: On a small screen, that's taking a little too much space in my opinion. I preferred 20%. What…
kossebauAuthorUnsubmitted
Not Done

Myself I would actually prefer 30 % :) Guess that should be a value users want to customize in the general kdevelop settings. Will extend the patch to propose to add that.

For making it interactively resizeable, that will need some extension of KateView in KTextEditor. Have not yet thought further about this and how it should be as user experience and how it could be implemented

kossebau: Myself I would actually prefer 30 % :) Guess that should be a value users want to customize in…
390​ if (event->type() == QEvent::Resize) {
391​ QResizeEvent* resizeEvent = static_cast<QResizeEvent*>(event);
392​ const int viewBasedWidthHint = widthHintFromViewWidth(resizeEvent->size().width());
393​ if ((viewBasedWidthHint < m_lastCharBasedWidthHint) &&
394​ (viewBasedWidthHint != m_lastViewBasedWidthHint)) {
395​ // emit for first line only, assuming uniformAnnotationItemSizes is set to true
396​ emit sizeHintChanged(m_model, 0);
397​ }
398​ }
399​
400​ return KTextEditor::AbstractAnnotationItemDelegate::eventFilter(object, event);
401​}
402​
403​void VcsAnnotationItemDelegate::resetBackgrounds()
404​{
405​ m_backgrounds.clear();
406​}
407​
408​int VcsAnnotationItemDelegate::widthHintFromViewWidth(int viewWidth) const
409​{
410​ return viewWidth / 4;
411​}