1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
|
/* This file is part of KDevelop
Copyright 2018 Anton Anikin <anton@anikin.xyz>
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; see the file COPYING. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#include "checkswidget.h"
#include "ui_checkswidget.h"
#include "checksdb.h"
#include "debug.h"
#include <KLocalizedString>
#include <QMenu>
namespace Clazy
{
enum DataRole {
CheckRole = Qt::UserRole + 1,
DescriptionRole = Qt::UserRole + 2
};
enum ItemType {
LevelType,
CheckType
};
ChecksWidget::ChecksWidget(QWidget* parent)
: QWidget(parent)
, m_ui(new Ui::ChecksWidget)
{
m_ui->setupUi(this);
m_ui->filterEdit->addTreeWidget(m_ui->checksTree);
m_ui->filterEdit->setPlaceholderText(i18nc("@info:placeholder", "Search checks..."));
connect(m_ui->filterEdit, &KTreeWidgetSearchLine::searchUpdated, this, &ChecksWidget::searchUpdated);
}
void ChecksWidget::setChecksDb(const QSharedPointer<const ChecksDB>& db)
{
auto resetMenu = new QMenu(this);
m_ui->resetButton->setMenu(resetMenu);
for (auto level : db->levels()) {
auto levelItem = new QTreeWidgetItem(m_ui->checksTree, { level->displayName }, LevelType);
levelItem->setData(0, CheckRole, level->name);
levelItem->setData(0, DescriptionRole, level->description);
levelItem->setCheckState(0, Qt::Unchecked);
m_items[level->name] = levelItem;
auto levelAction = resetMenu->addAction(level->displayName);
connect(levelAction, &QAction::triggered, this, [this, level, levelItem]() {
{
// Block QLineEdit::textChanged() signal, which is used by KTreeWidgetSearchLine to
// start delayed search.
QSignalBlocker blocker(m_ui->filterEdit);
m_ui->filterEdit->clear();
}
m_ui->filterEdit->updateSearch();
setChecks(level->name);
m_ui->checksTree->setCurrentItem(levelItem);
});
for (auto check : qAsConst(level->checks)) {
auto checkItem = new QTreeWidgetItem(levelItem, { check->name }, CheckType);
checkItem->setData(0, CheckRole, check->name);
checkItem->setData(0, DescriptionRole, check->description);
checkItem->setCheckState(0, Qt::Unchecked);
m_items[check->name] = checkItem;
}
}
connect(m_ui->checksTree, &QTreeWidget::itemChanged, this, [this](QTreeWidgetItem* item) {
setState(item, item->checkState(0));
updateChecks();
});
connect(m_ui->checksTree, &QTreeWidget::currentItemChanged, this, [this, db](QTreeWidgetItem* current) {
if (current) {
m_ui->descriptionView->setText(current->data(0, DescriptionRole).toString());
} else {
m_ui->descriptionView->clear();
}
});
}
ChecksWidget::~ChecksWidget() = default;
QString ChecksWidget::checks() const
{
return m_checks;
}
void ChecksWidget::setChecks(const QString& checks)
{
if (m_checks == checks) {
return;
}
// Clear all selections
for (int i = 0 ; i < m_ui->checksTree->topLevelItemCount(); ++i) {
setState(m_ui->checksTree->topLevelItem(i), Qt::Unchecked);
}
#if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
const auto checksList = checks.splitRef(QLatin1Char(','), Qt::SkipEmptyParts);
#else
const auto checksList = checks.splitRef(QLatin1Char(','), QString::SkipEmptyParts);
#endif
for (auto& rawCheckName : checksList) {
QString checkName = rawCheckName.trimmed().toString();
if (checkName == QLatin1String("manual")) {
continue;
}
auto state = Qt::Checked;
if (checkName.startsWith(QLatin1String("no-"))) {
checkName.remove(0, 3);
state = Qt::Unchecked;
}
if (auto checkItem = m_items.value(checkName, nullptr)) {
setState(checkItem, state);
}
}
updateChecks();
m_ui->checksTree->setCurrentItem(nullptr);
}
QStringList levelChecks(
const QTreeWidget* checksTree,
const QString& levelName,
const QList<const QTreeWidgetItem*>& levelItems)
{
QStringList checksList;
if (!levelName.isEmpty()) {
checksList += levelName;
}
for (int i = 0; i < checksTree->topLevelItemCount(); ++i) {
const auto levelItem = checksTree->topLevelItem(i);
const bool insideLevel = levelItems.contains(levelItem);
for (int j = 0; j < levelItem->childCount(); ++j) {
auto checkItem = levelItem->child(j);
auto checkName = checkItem->data(0, CheckRole).toString();
if (insideLevel) {
if (checkItem->checkState(0) == Qt::Unchecked) {
checksList += QStringLiteral("no-%1").arg(checkName);
}
} else {
if (checkItem->checkState(0) == Qt::Checked) {
checksList += checkName;
}
}
}
}
return checksList;
}
void ChecksWidget::updateChecks()
{
QStringList checksList;
QList<const QTreeWidgetItem*> levelItems;
// Here we try to find "best" (shortest) checks representation. To do this we build checks list
// for every level and test it's size.
for (int i = 0; i < m_ui->checksTree->topLevelItemCount(); ++i) {
auto levelItem = m_ui->checksTree->topLevelItem(i);
auto levelName = levelItem->data(0, CheckRole).toString();
if (levelName == QLatin1String("manual")) {
// Manual level is "fake level" so we clear the name and will store only
// selected checks.
levelItems.clear();
levelName.clear();
} else {
levelItems += levelItem;
}
auto levelList = levelChecks(m_ui->checksTree, levelName, levelItems);
if (checksList.isEmpty() || checksList.size() > levelList.size()) {
checksList = levelList;
}
}
m_ui->messageLabel->setVisible(checksList.isEmpty());
auto checks = checksList.join(QLatin1Char(','));
if (m_checks != checks) {
m_checks = checks;
emit checksChanged(m_checks);
}
}
void ChecksWidget::setState(QTreeWidgetItem* item, Qt::CheckState state, bool force)
{
Q_ASSERT(item);
QSignalBlocker blocker(m_ui->checksTree);
if (item->type() == LevelType) {
if (state == Qt::Checked) {
// When we enable some non-manual level item, we should also try to enable all
// upper level items. We enable upper item only when it's state is Qt::Unchecked.
// If the state is Qt::PartiallyChecked we assume that it was configured earlier and
// we should skip the item to keep user's checks selection.
const int index = m_ui->checksTree->indexOfTopLevelItem(item);
if (index > 0 && index < (m_ui->checksTree->topLevelItemCount() - 1)) {
setState(m_ui->checksTree->topLevelItem(index - 1), state, false);
}
if (item->checkState(0) != Qt::Unchecked && !force) {
return;
}
}
item->setCheckState(0, state);
if (state != Qt::PartiallyChecked) {
for (int i = 0; i < item->childCount(); ++i) {
item->child(i)->setCheckState(0, state);
}
}
return;
}
item->setCheckState(0, state);
auto levelItem = item->parent();
Q_ASSERT(levelItem);
const int childCount = levelItem->childCount();
int checkedCount = 0;
for (int i = 0; i < childCount; ++i) {
if (levelItem->child(i)->checkState(0) == Qt::Checked) {
++checkedCount;
}
}
if (checkedCount == 0) {
setState(levelItem, Qt::Unchecked);
} else if (checkedCount == childCount) {
setState(levelItem, Qt::Checked);
} else {
setState(levelItem, Qt::PartiallyChecked);
}
}
void ChecksWidget::searchUpdated(const QString& searchString)
{
if (searchString.isEmpty()) {
m_ui->checksTree->collapseAll();
m_ui->checksTree->setCurrentItem(nullptr);
return;
}
m_ui->checksTree->expandAll();
QTreeWidgetItem* firstVisibleLevel = nullptr;
for (int i = 0; i < m_ui->checksTree->topLevelItemCount(); ++i) {
auto levelItem = m_ui->checksTree->topLevelItem(i);
if (levelItem->isHidden()) {
continue;
}
if (!firstVisibleLevel) {
firstVisibleLevel = levelItem;
}
for (int j = 0; j < levelItem->childCount(); ++j) {
auto checkItem = levelItem->child(j);
if (!checkItem->isHidden()) {
m_ui->checksTree->setCurrentItem(checkItem);
return;
}
}
}
m_ui->checksTree->setCurrentItem(firstVisibleLevel);
}
void ChecksWidget::setEditable(bool editable)
{
if (m_isEditable == editable) {
return;
}
m_isEditable = editable;
m_ui->resetButton->setEnabled(editable);
for (auto* item : qAsConst(m_items)) {
auto flags = item->flags();
flags.setFlag(Qt::ItemIsUserCheckable, m_isEditable);
item->setFlags(flags);
}
}
}
|