Differential D8709 Diff 41228 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-2018 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 <util/activetooltip.h>
25​#include <vcsannotation.h>
26​#include <debug.h>
27​
28​#include <KTextEditor/AnnotationInterface>
29​#include <KTextEditor/View>
30​#include <KTextEditor/ConfigInterface>
31​#include <KTextEditor/Attribute>
32​#include <KLocalizedString>
33​
34​#include <QHelpEvent>
35​#include <QPainter>
36​#include <QAction>
37​#include <QMenu>
38​#include <QFontMetricsF>
39​#include <QDate>
40​#include <QStyle>
41​#include <QApplication>
42​#include <QVBoxLayout>
43​#include <QLabel>
44​
45​#include <math.h>
46​
47​using namespace KDevelop;
48​
49​VcsAnnotationItemDelegate::VcsAnnotationItemDelegate(KTextEditor::View* view, KTextEditor::AnnotationModel* model,
50​ QObject* parent)
51​ : KTextEditor::AbstractAnnotationItemDelegate(parent)
52​ , m_model(model)
53​{
54​ // dump background brushes on schema change
55​ Q_ASSERT(qobject_cast<KTextEditor::ConfigInterface*>(view));
56​ connect(view, SIGNAL(configChanged()), this, SLOT(resetBackgrounds()));
57​
58​ view->installEventFilter(this);
59​}
60​
61​VcsAnnotationItemDelegate::~VcsAnnotationItemDelegate() = default;
62​
63​static QString ageOfDate(const QDate& date)
64​{
65​ const auto now = QDate::currentDate();
66​ int ageInYears = now.year() - date.year();
67​ if (now < date.addYears(ageInYears)) {
68​ --ageInYears;
69​ }
70​ if (ageInYears > 0) {
71​ return i18ncp("age", "%1 year", "%1 years", ageInYears);
72​ }
73​ int ageInMonths = now.month() - date.month();
74​ if (ageInMonths < 0) {
75​ ageInMonths += 12;
76​ }
77​ if (ageInMonths > 0) {
78​ return i18ncp("age", "%1 month", "%1 months", ageInMonths);
79​ }
80​ const int ageInDays = date.daysTo(now);
81​ if (ageInDays > 0) {
82​ return i18ncp("age", "%1 day", "%1 days", ageInDays);
83​ }
84​ return i18n("Today");
85​}
86​
87​void VcsAnnotationItemDelegate::doMessageLineLayout(const KTextEditor::StyleOptionAnnotationItem& option,
88​ QRect* messageRect, QRect* ageRect) const
89​{
90​ Q_ASSERT(messageRect && messageRect->isValid());
91​ Q_ASSERT(ageRect);
92​
93​ const QWidget* const widget = option.view;
94​ QStyle* const style = widget ? widget->style() : QApplication::style();
95​ const bool hasAge = ageRect->isValid();
96​ // "+ 1" as used in QItemDelegate
97​ const int textMargin = style->pixelMetric(QStyle::PM_FocusFrameHMargin, nullptr, widget) + 1;
98​ const int ageMargin = hasAge ? textMargin : 0;
99​
100​ const int x = option.rect.left();
101​ const int y = option.rect.top();
102​ const int w = option.rect.width();
103​ const int h = option.rect.height();
104​
105​ // add margins for fixed elements
106​ QSize ageSize(0, 0); // ageRect could be invalid, so use separate object for calculation
107​ if (hasAge) {
108​ ageSize = ageRect->size();
109​ ageSize.rwidth() += 2 * ageMargin;
110​ }
111​
112​ // distribute space among layout items
113​ QRect message;
114​ QRect age;
115​ if (option.direction == Qt::LeftToRight) {
116​ message.setRect(x, y, w - ageSize.width(), h);
117​ age.setRect(message.right() + 1, y, ageSize.width(), h);
118​ } else {
119​ age.setRect(x, y, ageSize.width(), h);
120​ message.setRect(age.right() + 1, y, w - ageSize.width(), h);
121​ }
122​ // remove margins here, so renderMessageAndAge does not have to
123​ message.adjust(textMargin, 0, -textMargin, 0);
124​ age.adjust(ageMargin, 0, -ageMargin, 0);
125​
126​ // return result
127​ *ageRect = age;
128​ *messageRect = QStyle::alignedRect(option.direction, Qt::AlignLeading,
129​ messageRect->size().boundedTo(message.size()), message);
130​}
131​
132​void VcsAnnotationItemDelegate::doAuthorLineLayout(const KTextEditor::StyleOptionAnnotationItem& option,
133​ QRect* authorRect) const
134​{
135​ Q_ASSERT(authorRect);
136​
137​ // if invalid, nothing to be done, keep as is
138​ if (!authorRect->isValid()) {
139​ return;
140​ }
141​
142​ const QWidget* const widget = option.view;
143​ QStyle* const style = widget ? widget->style() : QApplication::style();
144​ // "+ 1" as used in QItemDelegate
145​ const int authorMargin = style->pixelMetric(QStyle::PM_FocusFrameHMargin, nullptr, widget) + 1;
146​
147​ QRect author = option.rect;
148​ // remove margins here, so renderAuthor does not have to
149​ author.adjust(authorMargin, 0, -authorMargin, 0);
150​
151​ // return result
152​ *authorRect = QStyle::alignedRect(option.direction, Qt::AlignLeading,
153​ authorRect->size().boundedTo(author.size()), author);
154​}
155​
156​void VcsAnnotationItemDelegate::renderBackground(QPainter* painter,
157​ const KTextEditor::StyleOptionAnnotationItem& option,
158​ const VcsAnnotationLine& annotationLine) const
159​{
160​ Q_UNUSED(option);
161​
162​ const auto revision = annotationLine.revision();
163​ auto brushIt = m_backgrounds.find(revision);
164​ if (brushIt == m_backgrounds.end()) {
165​ KTextEditor::Attribute::Ptr normalStyle = option.view->defaultStyleAttribute(KTextEditor::dsNormal);
166​ const auto background = (normalStyle->hasProperty(QTextFormat::BackgroundBrush)) ? normalStyle->background().color() : QColor(Qt::white);
167​ const int background_y = background.red()*0.299 + 0.587*background.green()
168​ + 0.114*background.blue();
169​ // get random, but reproducable 8-bit values from last two bytes of the revision hash
170​ const uint revisionHash = qHash(revision);
171​ const int u = static_cast<int>((0xFF & revisionHash));
172​ const int v = static_cast<int>((0xFF00 & revisionHash) >> 8);
173​ const int r = qRound(qMin(255.0, qMax(0.0, background_y + 1.402*(v-128))));
174​ const int g = qRound(qMin(255.0, qMax(0.0, background_y - 0.344*(u-128) - 0.714*(v-128))));
175​ const int b = qRound(qMin(255.0, qMax(0.0, background_y + 1.772*(u-128))));
176​ brushIt = m_backgrounds.insert(revision, QBrush(QColor(r, g, b)));
177​ }
178​
179​ painter->fillRect(option.rect, brushIt.value());
180​}
181​
182​void VcsAnnotationItemDelegate::renderMessageAndAge(QPainter* painter,
183​ const KTextEditor::StyleOptionAnnotationItem& option,
184​ const QRect& messageRect, const QString& messageText,
185​ const QRect& ageRect, const QString& ageText) const
186​{
187​ Q_UNUSED(option);
188​
189​ painter->save();
190​
191​ KTextEditor::Attribute::Ptr normalStyle = option.view->defaultStyleAttribute(KTextEditor::dsNormal);
192​ painter->setPen(normalStyle->foreground().color());
193​ painter->drawText(messageRect, Qt::AlignLeading | Qt::AlignVCenter,
194​ painter->fontMetrics().elidedText(messageText, Qt::ElideRight, messageRect.width()));
195​
196​ // TODO: defaultStyleAttribute only returns relyably for dsNormal, so what to do for a comment-like color?
197​ KTextEditor::Attribute::Ptr commentStyle = option.view->defaultStyleAttribute(KTextEditor::dsNormal);
198​ painter->setPen(commentStyle->foreground().color());
199​ painter->drawText(ageRect, Qt::AlignTrailing | Qt::AlignVCenter, ageText);
200​
201​ painter->restore();
202​}
203​
204​void VcsAnnotationItemDelegate::renderAuthor(QPainter* painter,
205​ const KTextEditor::StyleOptionAnnotationItem& option,
206​ const QRect& authorRect, const QString& authorText) const
207​{
208​ Q_UNUSED(option);
209​
210​ painter->save();
211​
212​ // TODO: defaultStyleAttribute only returns relyably for dsNormal, so what to do for a comment-like color?
213​ KTextEditor::Attribute::Ptr commentStyle = option.view->defaultStyleAttribute(KTextEditor::dsNormal);
214​ painter->setPen(commentStyle->foreground().color());
215​ painter->drawText(authorRect, Qt::AlignLeading | Qt::AlignVCenter,
216​ painter->fontMetrics().elidedText(authorText, Qt::ElideRight, authorRect.width()));
217​
218​ painter->restore();
219​}
220​
221​void VcsAnnotationItemDelegate::renderHighlight(QPainter* painter,
222​ const KTextEditor::StyleOptionAnnotationItem& option) const
223​{
224​ // Draw a border around all adjacent entries that have the same text as the currently hovered one
225​ if ((option.state & QStyle::State_MouseOver) &&
226​ (option.annotationItemGroupingPosition & KTextEditor::StyleOptionAnnotationItem::InGroup)) {
227​ KTextEditor::Attribute::Ptr style = option.view->defaultStyleAttribute(KTextEditor::dsNormal);
228​ painter->setPen(style->foreground().color());
229​ // draw left and right highlight borders
230​ painter->drawLine(option.rect.topLeft(), option.rect.bottomLeft());
231​ painter->drawLine(option.rect.topRight(), option.rect.bottomRight());
232​
233​ if ((option.annotationItemGroupingPosition & KTextEditor::StyleOptionAnnotationItem::GroupBegin) &&
234​ (option.wrappedLine == 0)) {
235​ painter->drawLine(option.rect.topLeft(), option.rect.topRight());
236​ }
237​
238​ if ((option.annotationItemGroupingPosition & KTextEditor::StyleOptionAnnotationItem::GroupEnd) &&
239​ (option.wrappedLine == (option.wrappedLineCount-1))) {
240​ painter->drawLine(option.rect.bottomLeft(), option.rect.bottomRight());
241​ }
242​ }
243​}
244​
245​void VcsAnnotationItemDelegate::paint(QPainter* painter, const KTextEditor::StyleOptionAnnotationItem& option,
246​ KTextEditor::AnnotationModel* model, int line) const
247​{
248​ Q_ASSERT(painter);
249​ // we cannot use custom roles and data() API (cmp. VcsAnnotationModel dox), so accessing custom API instead
250​ VcsAnnotationModel* vcsModel = qobject_cast<VcsAnnotationModel*>(model);
251​ Q_ASSERT(vcsModel);
252​ if (!painter || !vcsModel) {
253​ return;
254​ }
255​ // test of line just for sake of completeness skipped here
256​
257​ // Fetch data from the model
258​ const VcsAnnotationLine annotationLine = vcsModel->annotationLine(line);
259​
260​ if (annotationLine.revision().revisionType() == VcsRevision::Invalid) {
261​ return;
262​ }
263​
264​ // prepare
265​ painter->save();
266​
267​ renderBackground(painter, option, annotationLine);
268​
269​ // We use the normal UI font here, which usually is a proportimal one,
270​ // so more text fits into the available space.
271​ // Though we do this at the cost of not adapting to any scaled content font size,
272​ // as there is no zooming state info available, so we cannot adapt.
273​ // Tooltip font also is not scaled, and annotations could be considered to fall into
274​ // that category, so might be fine.
275​ painter->setFont(option.view->font());
276​
277​ if (option.visibleWrappedLineInGroup == 0) {
278​ QRect ageRect;
279​ QString ageText;
280​ const auto date = annotationLine.date();
281​ if (date.isValid()) {
282​ ageText = ageOfDate(date.date());
283​ ageRect = QRect(QPoint(0, 0),
284​ QSize(option.fontMetrics.width(ageText), option.rect.height()));
285​ }
286​ const auto messageText = annotationLine.commitMessage();
287​ auto messageRect = QRect(QPoint(0, 0),
288​ QSize(option.fontMetrics.width(messageText), option.rect.height()));
289​
290​ doMessageLineLayout(option, &messageRect, &ageRect);
291​
292​ renderMessageAndAge(painter, option, messageRect, messageText, ageRect, ageText);
293​ } else if (option.visibleWrappedLineInGroup == 1) {
294​ const auto author = annotationLine.author();
295​ if (!author.isEmpty()) {
296​ const auto authorText = i18nc("By: commit author", "By: %1", author);
297​ auto authorRect = QRect(QPoint(0, 0),
298​ QSize(option.fontMetrics.width(authorText), option.rect.height()));
299​
300​ doAuthorLineLayout(option, &authorRect);
301​
302​ renderAuthor(painter, option, authorRect, authorText);
303​ }
304​ }
305​
306​ renderHighlight(painter, option);
307​
308​ // done
309​ painter->restore();
310​}
311​
312​bool VcsAnnotationItemDelegate::helpEvent(QHelpEvent* event, KTextEditor::View* view,
313​ const KTextEditor::StyleOptionAnnotationItem& option,
314​ KTextEditor::AnnotationModel* model, int line)
315​{
316​ Q_UNUSED(option);
317​ if (!model || event->type() != QEvent::ToolTip) {
318​ return false;
319​ }
320​
321​ const QString annotationGroupId = model->data(line, (Qt::ItemDataRole)KTextEditor::AnnotationModel::GroupIdentifierRole).toString();
322​
323​ if (m_tooltip) {
324​ if (m_tooltippedAnnotationGroupId == annotationGroupId) {
325​ // we do not update the handleRect of the tooltip here.
326​ // because the tooltip is kept at the original location
327​ // close to the original rect, and setting the new here
328​ // would potentially result in a too large merged not-close-tooltip region
329​ return true;
330​ }
331​ m_tooltip->close();
332​ m_tooltip.clear();
333​ }
334​
335​ const QVariant data = model->data(line, Qt::ToolTipRole);
336​ if (!data.isValid()) {
337​ return false;
338​ }
339​
340​ const QString toolTipText = data.toString();
341​ if (toolTipText.isEmpty()) {
342​ return false;
343​ }
344​
345​ m_tooltippedAnnotationGroupId = annotationGroupId;
346​ m_tooltip = new ActiveToolTip(view, event->globalPos() + QPoint(2, 16));
347​ auto* layout = new QVBoxLayout(m_tooltip);
348​ layout->setMargin(0);
349​ auto* widget = new QLabel(m_tooltip);
350​ // "+ 1" as used in QToolTip
351​ const int tooltipMargin = view->style()->pixelMetric(QStyle::PM_ToolTipLabelFrameWidth, nullptr, widget) + 1;
352​ widget->setMargin(tooltipMargin);
353​ widget->setFrameStyle(QFrame::NoFrame);
354​ widget->setAlignment(Qt::AlignLeft);
355​ widget->setIndent(1);
356​ widget->setTextInteractionFlags(Qt::TextBrowserInteraction);
357​ widget->setOpenExternalLinks(true);
358​ widget->setText(toolTipText);
359​ layout->addWidget(widget);
360​ m_tooltip->resize(m_tooltip->sizeHint());
361​ auto rect = option.rect;
362​ rect.moveTopLeft(view->mapToGlobal(rect.topLeft()));
363​ m_tooltip->setHandleRect(rect);
364​ ActiveToolTip::showToolTip(m_tooltip);
365​
366​ return true;
367​}
368​
369​void VcsAnnotationItemDelegate::hideTooltip(KTextEditor::View *view)
370​{
371​ Q_UNUSED(view);
372​ if (m_tooltip) {
373​ m_tooltip->close();
374​ m_tooltip.clear();
375​ }
376​}
377​
378​QSize VcsAnnotationItemDelegate::sizeHint(const KTextEditor::StyleOptionAnnotationItem& option,
379​ KTextEditor::AnnotationModel* model, int line) const
380​{
381​ Q_UNUSED(line);
382​ Q_ASSERT(model);
383​ if (!model) {
384​ return QSize(0, 0);
385​ }
386​
387​ // Ideally the user could configure the width of the annotations, best interactively.
388​ // Until this is possible, the sizehint is: roughly 40 chars, but maximal 25 % of the view
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…
389​ // See eventFilter for making sure we adapt the max 25 % to a changed width.
390​
391​ const QFontMetricsF& fm(option.fontMetrics);
392​ // if only averageCharWidth would yield sane values,
393​ // multiply by 40 in average seemed okayish at least with english, showing enough of message
394​ m_lastCharBasedWidthHint = ceil(40 * fm.averageCharWidth());
395​ m_lastViewBasedWidthHint = widthHintFromViewWidth(option.view->width());
396​ return QSize(qMin(m_lastCharBasedWidthHint, m_lastViewBasedWidthHint), fm.height());
397​}
398​
399​bool VcsAnnotationItemDelegate::eventFilter(QObject* object, QEvent* event)
400​{
401​ if (event->type() == QEvent::Resize) {
402​ QResizeEvent* resizeEvent = static_cast<QResizeEvent*>(event);
403​ const int viewBasedWidthHint = widthHintFromViewWidth(resizeEvent->size().width());
404​ if ((viewBasedWidthHint < m_lastCharBasedWidthHint) &&
405​ (viewBasedWidthHint != m_lastViewBasedWidthHint)) {
406​ // emit for first line only, assuming uniformAnnotationItemSizes is set to true
407​ emit sizeHintChanged(m_model, 0);
408​ }
409​ }
410​
411​ return KTextEditor::AbstractAnnotationItemDelegate::eventFilter(object, event);
412​}
413​
414​void VcsAnnotationItemDelegate::resetBackgrounds()
415​{
416​ m_backgrounds.clear();
417​}
418​
419​int VcsAnnotationItemDelegate::widthHintFromViewWidth(int viewWidth) const
420​{
421​ return viewWidth / 4;
422​}