KTextEditor

kateconfig.cpp
1/*
2 SPDX-FileCopyrightText: 2007, 2008 Matthew Woehlke <mw_triad@users.sourceforge.net>
3 SPDX-FileCopyrightText: 2003 Christoph Cullmann <cullmann@kde.org>
4
5 SPDX-License-Identifier: LGPL-2.0-or-later
6*/
7
8#include "kateconfig.h"
9
10#include "katedocument.h"
11#include "kateglobal.h"
12#include "katepartdebug.h"
13#include "katerenderer.h"
14#include "katesyntaxmanager.h"
15#include "kateview.h"
16
17#include <KConfigGroup>
18
19#include <KEncodingProber>
20#include <QGuiApplication>
21#include <QSettings>
22#include <QStringDecoder>
23#include <QStringEncoder>
24#include <QStringListModel>
25
26#include <Sonnet/GuessLanguage>
27#include <Sonnet/Speller>
28
29// BEGIN KateConfig
30KateConfig::KateConfig(const KateConfig *parent)
31 : m_parent(parent)
32 , m_configKeys(m_parent ? nullptr : new QStringList())
33 , m_configKeyToEntry(m_parent ? nullptr : new QHash<QString, const ConfigEntry *>())
34{
35}
36
37KateConfig::~KateConfig() = default;
38
39void KateConfig::addConfigEntry(ConfigEntry &&entry)
40{
41 // shall only be called for toplevel config
42 Q_ASSERT(isGlobal());
43
44 // There shall be no gaps in the entries; i.e. in KateViewConfig constructor
45 // addConfigEntry() is called on each value from the ConfigEntryTypes enum in
46 // the same order as the enumrators.
47 // we might later want to use a vector
48 // qDebug() << m_configEntries.size() << entry.enumKey;
49 Q_ASSERT(m_configEntries.size() == static_cast<size_t>(entry.enumKey));
50
51 // add new element
52 m_configEntries.emplace(entry.enumKey, entry);
53}
54
55void KateConfig::finalizeConfigEntries()
56{
57 // shall only be called for toplevel config
58 Q_ASSERT(isGlobal());
59
60 // compute list of all config keys + register map from key => config entry
61 //
62 // we skip entries without a command name, these config entries are not exposed ATM
63 for (const auto &entry : m_configEntries) {
64 if (!entry.second.commandName.isEmpty()) {
65 Q_ASSERT_X(!m_configKeys->contains(entry.second.commandName),
66 "finalizeConfigEntries",
67 (QLatin1String("KEY NOT UNIQUE: ") + entry.second.commandName).toLocal8Bit().constData());
68 m_configKeys->append(entry.second.commandName);
69 m_configKeyToEntry->insert(entry.second.commandName, &entry.second);
70 }
71 }
72}
73
74void KateConfig::readConfigEntries(const KConfigGroup &config)
75{
76 configStart();
77
78 // read all config entries, even the ones ATM not set in this config object but known in the toplevel one
79 for (const auto &entry : fullConfigEntries()) {
80 setValue(entry.second.enumKey, config.readEntry(entry.second.configKey, entry.second.defaultValue));
81 }
82
83 configEnd();
84}
85
86void KateConfig::writeConfigEntries(KConfigGroup &config) const
87{
88 // write all config entries, even the ones ATM not set in this config object but known in the toplevel one
89 for (const auto &entry : fullConfigEntries()) {
90 config.writeEntry(entry.second.configKey, value(entry.second.enumKey));
91 }
92}
93
94void KateConfig::configStart()
95{
96 configSessionNumber++;
97
98 if (configSessionNumber > 1) {
99 return;
100 }
101}
102
103void KateConfig::configEnd()
104{
105 if (configSessionNumber == 0) {
106 return;
107 }
108
109 configSessionNumber--;
110
111 if (configSessionNumber > 0) {
112 return;
113 }
114
115 updateConfig();
116}
117
118QVariant KateConfig::value(const int key) const
119{
120 // first: local lookup
121 const auto it = m_configEntries.find(key);
122 if (it != m_configEntries.end()) {
123 return it->second.value;
124 }
125
126 // else: fallback to parent config, if any
127 if (m_parent) {
128 return m_parent->value(key);
129 }
130
131 // if we arrive here, the key was invalid! => programming error
132 // for release builds, we just return invalid variant
133 Q_ASSERT(false);
134 return QVariant();
135}
136
137bool KateConfig::setValue(const int key, const QVariant &value)
138{
139 // check: is this key known at all?
140 const auto &knownEntries = fullConfigEntries();
141 const auto knownIt = knownEntries.find(key);
142 if (knownIt == knownEntries.end()) {
143 // if we arrive here, the key was invalid! => programming error
144 // for release builds, we just fail to set the value
145 Q_ASSERT(false);
146 return false;
147 }
148
149 // validator set? use it, if not accepting, abort setting
150 if (knownIt->second.validator && !knownIt->second.validator(value)) {
151 return false;
152 }
153
154 // check if value already there for this config
155 auto valueIt = m_configEntries.find(key);
156 if (valueIt != m_configEntries.end()) {
157 // skip any work if value is equal
158 if (valueIt->second.value == value) {
159 return true;
160 }
161
162 // else: alter value and be done
163 configStart();
164 valueIt->second.value = value;
165 configEnd();
166 return true;
167 }
168
169 // if not in this hash, we must copy the known entry and adjust the value
170 configStart();
171 auto res = m_configEntries.emplace(key, knownIt->second);
172 res.first->second.value = value;
173 configEnd();
174 return true;
175}
176
177QVariant KateConfig::value(const QString &key) const
178{
179 // check if we know this key, if not, return invalid variant
180 const auto &knownEntries = fullConfigKeyToEntry();
181 const auto it = knownEntries.find(key);
182 if (it == knownEntries.end()) {
183 return QVariant();
184 }
185
186 // key known, dispatch to normal value() function with enum
187 return value(it.value()->enumKey);
188}
189
190bool KateConfig::setValue(const QString &key, const QVariant &value)
191{
192 // check if we know this key, if not, ignore the set
193 const auto &knownEntries = fullConfigKeyToEntry();
194 const auto it = knownEntries.find(key);
195 if (it == knownEntries.end()) {
196 return false;
197 }
198
199 // key known, dispatch to normal setValue() function with enum
200 return setValue(it.value()->enumKey, value);
201}
202
203// END
204
205// BEGIN HelperFunctions
206KateGlobalConfig *KateGlobalConfig::s_global = nullptr;
207KateDocumentConfig *KateDocumentConfig::s_global = nullptr;
208KateViewConfig *KateViewConfig::s_global = nullptr;
209KateRendererConfig *KateRendererConfig::s_global = nullptr;
210
211/**
212 * validate if an encoding is ok
213 * @param name encoding name
214 * @return encoding ok?
215 */
216static bool isEncodingOk(const QString &name)
217{
218 return QStringDecoder(name.toUtf8().constData()).isValid() && QStringEncoder(name.toUtf8().constData()).isValid();
219}
220
221static bool inBounds(const int min, const QVariant &value, const int max)
222{
223 const int val = value.toInt();
224 return (val >= min) && (val <= max);
225}
226
227static bool isPositive(const QVariant &value)
228{
229 bool ok;
230 value.toUInt(&ok);
231 return ok;
232}
233// END
234
235// BEGIN KateGlobalConfig
236KateGlobalConfig::KateGlobalConfig()
237{
238 // register this as our global instance
239 Q_ASSERT(isGlobal());
240 s_global = this;
241
242 // avoid updateConfig effects like config write in constructor, see bug 377067
243 Q_ASSERT(configSessionNumber == 0);
244 ++configSessionNumber;
245
246 // init all known config entries
247 addConfigEntry(ConfigEntry(EncodingProberType, "Encoding Prober Type", QString(), KEncodingProber::Universal));
248 addConfigEntry(ConfigEntry(FallbackEncoding,
249 "Fallback Encoding",
250 QString(),
251 QString::fromUtf8(QStringConverter::nameForEncoding(QStringConverter::Latin1)),
252 [](const QVariant &value) {
253 return isEncodingOk(value.toString());
254 }));
255
256 // finalize the entries, e.g. hashs them
257 finalizeConfigEntries();
258
259 // init with defaults from config or really hardcoded ones
260 KConfigGroup cg(KTextEditor::EditorPrivate::config(), QStringLiteral("KTextEditor Editor"));
261 readConfig(cg);
262
263 // avoid updateConfig effects like config write in constructor, see bug 377067
264 Q_ASSERT(configSessionNumber == 1);
265 --configSessionNumber;
266}
267
268void KateGlobalConfig::readConfig(const KConfigGroup &config)
269{
270 // start config update group
271 configStart();
272
273 // read generic entries
274 readConfigEntries(config);
275
276 // end config update group, might trigger updateConfig()
277 configEnd();
278}
279
280void KateGlobalConfig::writeConfig(KConfigGroup &config)
281{
282 // write generic entries
283 writeConfigEntries(config);
284}
285
286void KateGlobalConfig::updateConfig()
287{
288 // write config
289 KConfigGroup cg(KTextEditor::EditorPrivate::config(), QStringLiteral("KTextEditor Editor"));
290 writeConfig(cg);
291 KTextEditor::EditorPrivate::config()->sync();
292
293 // trigger emission of KTextEditor::Editor::configChanged
294 KTextEditor::EditorPrivate::self()->triggerConfigChanged();
295}
296// END
297
298// BEGIN KateDocumentConfig
299KateDocumentConfig::KateDocumentConfig()
300{
301 // register this as our global instance
302 Q_ASSERT(isGlobal());
303 s_global = this;
304
305 // avoid updateConfig effects like config write in constructor, see bug 377067
306 Q_ASSERT(configSessionNumber == 0);
307 ++configSessionNumber;
308
309 // init all known config entries
310 addConfigEntry(ConfigEntry(TabWidth, "Tab Width", QStringLiteral("tab-width"), 4, [](const QVariant &value) {
311 return value.toInt() >= 1;
312 }));
313 addConfigEntry(ConfigEntry(IndentationWidth, "Indentation Width", QStringLiteral("indent-width"), 4, [](const QVariant &value) {
314 return value.toInt() >= 1;
315 }));
316 addConfigEntry(ConfigEntry(OnTheFlySpellCheck, "On-The-Fly Spellcheck", QStringLiteral("on-the-fly-spellcheck"), false));
317 addConfigEntry(ConfigEntry(IndentOnTextPaste, "Indent On Text Paste", QStringLiteral("indent-pasted-text"), true));
318 addConfigEntry(ConfigEntry(ReplaceTabsWithSpaces, "ReplaceTabsDyn", QStringLiteral("replace-tabs"), true));
319 addConfigEntry(ConfigEntry(BackupOnSaveLocal, "Backup Local", QStringLiteral("backup-on-save-local"), false));
320 addConfigEntry(ConfigEntry(BackupOnSaveRemote, "Backup Remote", QStringLiteral("backup-on-save-remote"), false));
321 addConfigEntry(ConfigEntry(BackupOnSavePrefix, "Backup Prefix", QStringLiteral("backup-on-save-prefix"), QString()));
322 addConfigEntry(ConfigEntry(BackupOnSaveSuffix, "Backup Suffix", QStringLiteral("backup-on-save-suffix"), QStringLiteral("~")));
323 addConfigEntry(ConfigEntry(IndentationMode, "Indentation Mode", QString(), QStringLiteral("normal")));
324 addConfigEntry(ConfigEntry(TabHandlingMode, "Tab Handling", QString(), KateDocumentConfig::tabSmart));
325 addConfigEntry(ConfigEntry(StaticWordWrap, "Word Wrap", QString(), false));
326 addConfigEntry(ConfigEntry(StaticWordWrapColumn, "Word Wrap Column", QString(), 80, [](const QVariant &value) {
327 return value.toInt() >= 1;
328 }));
329 addConfigEntry(ConfigEntry(PageUpDownMovesCursor, "PageUp/PageDown Moves Cursor", QString(), false));
330 addConfigEntry(ConfigEntry(SmartHome, "Smart Home", QString(), true));
331 addConfigEntry(ConfigEntry(ShowTabs, "Show Tabs", QString(), true));
332 addConfigEntry(ConfigEntry(IndentOnTab, "Indent On Tab", QString(), true));
333 addConfigEntry(ConfigEntry(KeepExtraSpaces, "Keep Extra Spaces", QStringLiteral("keep-extra-spaces"), false));
334 addConfigEntry(ConfigEntry(BackspaceIndents, "Indent On Backspace", QString(), true));
335 addConfigEntry(ConfigEntry(ShowSpacesMode, "Show Spaces", QString(), KateDocumentConfig::None));
336 addConfigEntry(ConfigEntry(TrailingMarkerSize, "Trailing Marker Size", QString(), 1));
337 addConfigEntry(
338 ConfigEntry(RemoveSpacesMode, "Remove Spaces", QStringLiteral("remove-spaces"), 1 /* on modified lines per default */, [](const QVariant &value) {
339 return inBounds(0, value, 2);
340 }));
341 addConfigEntry(ConfigEntry(NewlineAtEOF, "Newline at End of File", QString(), true));
342 addConfigEntry(ConfigEntry(OverwriteMode, "Overwrite Mode", QString(), false));
343 addConfigEntry(
344 ConfigEntry(Encoding, "Encoding", QString(), QString::fromUtf8(QStringConverter::nameForEncoding(QStringConverter::Utf8)), [](const QVariant &value) {
345 return isEncodingOk(value.toString());
346 }));
347 addConfigEntry(ConfigEntry(EndOfLine, "End of Line", QString(), 0));
348 addConfigEntry(ConfigEntry(AllowEndOfLineDetection, "Allow End of Line Detection", QString(), true));
349 addConfigEntry(ConfigEntry(ByteOrderMark, "BOM", QString(), false));
350 addConfigEntry(ConfigEntry(SwapFile, "Swap File Mode", QString(), KateDocumentConfig::EnableSwapFile));
351 addConfigEntry(ConfigEntry(SwapFileDirectory, "Swap Directory", QString(), QString()));
352 addConfigEntry(ConfigEntry(SwapFileSyncInterval, "Swap Sync Interval", QString(), 15));
353 addConfigEntry(ConfigEntry(LineLengthLimit, "Line Length Limit", QString(), 10000));
354 addConfigEntry(ConfigEntry(CamelCursor, "Camel Cursor", QString(), true));
355 addConfigEntry(ConfigEntry(AutoDetectIndent, "Auto Detect Indent", QString(), true));
356
357 // Auto save and co.
358 addConfigEntry(ConfigEntry(AutoSave, "Auto Save", QString(), false));
359 addConfigEntry(ConfigEntry(AutoSaveOnFocusOut, "Auto Save On Focus Out", QString(), false));
360 addConfigEntry(ConfigEntry(AutoSaveInteral, "Auto Save Interval", QString(), 0));
361
362 // Shall we do auto reloading for stuff e.g. in Git?
363 addConfigEntry(ConfigEntry(AutoReloadIfStateIsInVersionControl, "Auto Reload If State Is In Version Control", QString(), true));
364 // .editorconfig
365 addConfigEntry(ConfigEntry(UseEditorConfig, "Use Editor Config", QString(), true));
366
367 // finalize the entries, e.g. hashs them
368 finalizeConfigEntries();
369
370 // init with defaults from config or really hardcoded ones
371 KConfigGroup cg(KTextEditor::EditorPrivate::config(), QStringLiteral("KTextEditor Document"));
372 readConfig(cg);
373
374 // avoid updateConfig effects like config write in constructor, see bug 377067
375 Q_ASSERT(configSessionNumber == 1);
376 --configSessionNumber;
377}
378
379KateDocumentConfig::KateDocumentConfig(KTextEditor::DocumentPrivate *doc)
380 : KateConfig(s_global)
381 , m_doc(doc)
382{
383 // per document config doesn't read stuff per default
384}
385
386void KateDocumentConfig::readConfig(const KConfigGroup &config)
387{
388 // start config update group
389 configStart();
390
391 // read generic entries
392 readConfigEntries(config);
393
394 // fixup sonnet config, see KateSpellCheckConfigTab::apply(), too
395 // WARNING: this is slightly hackish, but it's currently the only way to
396 // do it, see also the KTextEdit class
397 if (isGlobal()) {
398 const QSettings settings(QStringLiteral("KDE"), QStringLiteral("Sonnet"));
399 const bool onTheFlyChecking = settings.value(QStringLiteral("checkerEnabledByDefault"), false).toBool();
400 setOnTheFlySpellCheck(onTheFlyChecking);
401
402 // ensure we load the default dictionary speller + trigrams early
403 // this avoids hangs for auto-spellchecking on first edits
404 // do this if we have on the fly spellchecking on only
405 if (onTheFlyChecking) {
406 Sonnet::Speller speller;
407 speller.setLanguage(Sonnet::Speller().defaultLanguage());
408 speller.isMisspelled(QStringLiteral("dummy to trigger dictionary load"));
409 Sonnet::GuessLanguage languageGuesser;
410 languageGuesser.identify(QStringLiteral("dummy to trigger identify"));
411 }
412 }
413
414 // backwards compatibility mappings
415 // convert stuff, old entries deleted in writeConfig
416 if (const int backupFlags = config.readEntry("Backup Flags", 0)) {
417 setBackupOnSaveLocal(backupFlags & 0x1);
418 setBackupOnSaveRemote(backupFlags & 0x2);
419 }
420
421 // end config update group, might trigger updateConfig()
422 configEnd();
423}
424
425void KateDocumentConfig::writeConfig(KConfigGroup &config)
426{
427 // write generic entries
428 writeConfigEntries(config);
429
430 // backwards compatibility mappings
431 // here we remove old entries we converted on readConfig
432 config.deleteEntry("Backup Flags");
433}
434
435void KateDocumentConfig::updateConfig()
436{
437 if (m_doc) {
438 m_doc->updateConfig();
439 return;
440 }
441
442 if (isGlobal()) {
443 const auto docs = KTextEditor::EditorPrivate::self()->documents();
444 for (auto doc : docs) {
445 static_cast<KTextEditor::DocumentPrivate *>(doc)->updateConfig();
446 }
447
448 // write config
449 KConfigGroup cg(KTextEditor::EditorPrivate::config(), QStringLiteral("KTextEditor Document"));
450 writeConfig(cg);
451 KTextEditor::EditorPrivate::config()->sync();
452
453 // trigger emission of KTextEditor::Editor::configChanged
454 KTextEditor::EditorPrivate::self()->triggerConfigChanged();
455 }
456}
457
458QString KateDocumentConfig::eolString() const
459{
460 switch (eol()) {
461 case KateDocumentConfig::eolDos:
462 return QStringLiteral("\r\n");
463
464 case KateDocumentConfig::eolMac:
465 return QStringLiteral("\r");
466
467 default:
468 return QStringLiteral("\n");
469 }
470}
471// END
472
473// BEGIN KateViewConfig
474KateViewConfig::KateViewConfig()
475{
476 // register this as our global instance
477 Q_ASSERT(isGlobal());
478 s_global = this;
479
480 // avoid updateConfig effects like config write in constructor, see bug 377067
481 Q_ASSERT(configSessionNumber == 0);
482 ++configSessionNumber;
483
484 // Init all known config entries
485 // NOTE: Ensure to keep the same order as listed in enum ConfigEntryTypes or it will later assert!
486 // addConfigEntry(ConfigEntry(<EnumKey>, <ConfigKey>, <CommandName>, <DefaultValue>, [<ValidatorFunction>]))
487 addConfigEntry(ConfigEntry(AllowMarkMenu, "Allow Mark Menu", QStringLiteral("allow-mark-menu"), true));
488 addConfigEntry(ConfigEntry(AutoBrackets, "Auto Brackets", QStringLiteral("auto-brackets"), true));
489 addConfigEntry(ConfigEntry(AutoCenterLines, "Auto Center Lines", QStringLiteral("auto-center-lines"), 0));
490 addConfigEntry(ConfigEntry(AutomaticCompletionInvocation, "Auto Completion", QString(), true));
491 addConfigEntry(ConfigEntry(AutomaticCompletionPreselectFirst, "Auto Completion Preselect First Entry", QString(), true));
492 addConfigEntry(ConfigEntry(BackspaceRemoveComposedCharacters, "Backspace Remove Composed Characters", QString(), false));
493 addConfigEntry(ConfigEntry(BookmarkSorting, "Bookmark Menu Sorting", QString(), 0));
494 addConfigEntry(ConfigEntry(CharsToEncloseSelection, "Chars To Enclose Selection", QStringLiteral("enclose-selection"), QStringLiteral("<>(){}[]'\"")));
495 addConfigEntry(ConfigEntry(ClipboardHistoryEntries, "Max Clipboard History Entries", QString(), 20, [](const QVariant &value) {
496 return inBounds(1, value, 999);
497 }));
498 addConfigEntry(
499 ConfigEntry(DefaultMarkType, "Default Mark Type", QStringLiteral("default-mark-type"), KTextEditor::Document::markType01, [](const QVariant &value) {
500 return isPositive(value);
501 }));
502 addConfigEntry(ConfigEntry(DynWordWrapAlignIndent, "Dynamic Word Wrap Align Indent", QString(), 80, [](const QVariant &value) {
503 return inBounds(0, value, 100);
504 }));
505 addConfigEntry(ConfigEntry(DynWordWrapIndicators, "Dynamic Word Wrap Indicators", QString(), 1, [](const QVariant &value) {
506 return inBounds(0, value, 2);
507 }));
508 addConfigEntry(ConfigEntry(DynWrapAnywhere, "Dynamic Wrap not at word boundaries", QStringLiteral("dynamic-word-wrap-anywhere"), false));
509 addConfigEntry(ConfigEntry(DynWrapAtStaticMarker, "Dynamic Word Wrap At Static Marker", QString(), false));
510 addConfigEntry(ConfigEntry(DynamicWordWrap, "Dynamic Word Wrap", QStringLiteral("dynamic-word-wrap"), true));
511 addConfigEntry(ConfigEntry(EnterToInsertCompletion, "Enter To Insert Completion", QStringLiteral("enter-to-insert-completion"), true));
512 addConfigEntry(ConfigEntry(FoldFirstLine, "Fold First Line", QString(), false));
513 addConfigEntry(ConfigEntry(InputMode, "Input Mode", QString(), 0, [](const QVariant &value) {
514 return isPositive(value);
515 }));
516 addConfigEntry(ConfigEntry(KeywordCompletion, "Keyword Completion", QStringLiteral("keyword-completion"), true));
517 addConfigEntry(ConfigEntry(MaxHistorySize, "Maximum Search History Size", QString(), 100, [](const QVariant &value) {
518 return inBounds(0, value, 999);
519 }));
520 addConfigEntry(ConfigEntry(MousePasteAtCursorPosition, "Mouse Paste At Cursor Position", QString(), false));
521 addConfigEntry(ConfigEntry(PersistentSelection, "Persistent Selection", QStringLiteral("persistent-selectionq"), false));
522 addConfigEntry(ConfigEntry(ScrollBarMiniMapWidth, "Scroll Bar Mini Map Width", QString(), 60, [](const QVariant &value) {
523 return inBounds(0, value, 999);
524 }));
525 addConfigEntry(ConfigEntry(ScrollPastEnd, "Scroll Past End", QString(), false));
526 addConfigEntry(ConfigEntry(SearchFlags, "Search/Replace Flags", QString(), IncFromCursor | PowerMatchCase | PowerModePlainText));
527 addConfigEntry(ConfigEntry(TabCompletion, "Enable Tab completion", QString(), false));
528 addConfigEntry(ConfigEntry(ShowBracketMatchPreview, "Bracket Match Preview", QStringLiteral("bracket-match-preview"), false));
529 addConfigEntry(ConfigEntry(ShowFoldingBar, "Folding Bar", QStringLiteral("folding-bar"), true));
530 addConfigEntry(ConfigEntry(ShowFoldingPreview, "Folding Preview", QStringLiteral("folding-preview"), true));
531 addConfigEntry(ConfigEntry(ShowIconBar, "Icon Bar", QStringLiteral("icon-bar"), false));
532 addConfigEntry(ConfigEntry(ShowLineCount, "Show Line Count", QString(), false));
533 addConfigEntry(ConfigEntry(ShowLineModification, "Line Modification", QStringLiteral("modification-markers"), true));
534 addConfigEntry(ConfigEntry(ShowLineNumbers, "Line Numbers", QStringLiteral("line-numbers"), true));
535 addConfigEntry(ConfigEntry(ShowScrollBarMarks, "Scroll Bar Marks", QString(), false));
536 addConfigEntry(ConfigEntry(ShowScrollBarMiniMap, "Scroll Bar MiniMap", QStringLiteral("scrollbar-minimap"), true));
537 addConfigEntry(ConfigEntry(ShowScrollBarMiniMapAll, "Scroll Bar Mini Map All", QString(), true));
538 addConfigEntry(ConfigEntry(ShowScrollBarPreview, "Scroll Bar Preview", QStringLiteral("scrollbar-preview"), true));
539 addConfigEntry(ConfigEntry(ShowScrollbars, "Show Scrollbars", QString(), AlwaysOn, [](const QVariant &value) {
540 return inBounds(0, value, 2);
541 }));
542 addConfigEntry(ConfigEntry(ShowWordCount, "Show Word Count", QString(), false));
543 addConfigEntry(ConfigEntry(TextDragAndDrop, "Text Drag And Drop", QString(), true));
544 addConfigEntry(ConfigEntry(SmartCopyCut, "Smart Copy Cut", QString(), true));
545 addConfigEntry(ConfigEntry(UserSetsOfCharsToEncloseSelection, "User Sets Of Chars To Enclose Selection", QString(), QStringList()));
546 addConfigEntry(ConfigEntry(ViInputModeStealKeys, "Vi Input Mode Steal Keys", QString(), false));
547 addConfigEntry(ConfigEntry(ViRelativeLineNumbers, "Vi Relative Line Numbers", QString(), false));
548 addConfigEntry(ConfigEntry(WordCompletion, "Word Completion", QString(), true));
549 addConfigEntry(ConfigEntry(WordCompletionMinimalWordLength,
550 "Word Completion Minimal Word Length",
551 QStringLiteral("word-completion-minimal-word-length"),
552 3,
553 [](const QVariant &value) {
554 return inBounds(0, value, 99);
555 }));
556 addConfigEntry(ConfigEntry(WordCompletionRemoveTail, "Word Completion Remove Tail", QString(), true));
557 addConfigEntry(ConfigEntry(ShowDocWithCompletion, "Show Documentation With Completion", QString(), true));
558 addConfigEntry(ConfigEntry(MultiCursorModifier, "Multiple Cursor Modifier", QString(), (int)Qt::AltModifier));
559 addConfigEntry(ConfigEntry(ShowFoldingOnHoverOnly, "Show Folding Icons On Hover Only", QString(), true));
560
561 // Statusbar stuff
562 addConfigEntry(ConfigEntry(ShowStatusbarLineColumn, "Show Statusbar Line Column", QString(), true));
563 addConfigEntry(ConfigEntry(ShowStatusbarDictionary, "Show Statusbar Dictionary", QString(), true));
564 addConfigEntry(ConfigEntry(ShowStatusbarInputMode, "Show Statusbar Input Mode", QString(), true));
565 addConfigEntry(ConfigEntry(ShowStatusbarHighlightingMode, "Show Statusbar Highlighting Mode", QString(), true));
566 addConfigEntry(ConfigEntry(ShowStatusbarTabSettings, "Show Statusbar Tab Settings", QString(), true));
567 addConfigEntry(ConfigEntry(ShowStatusbarFileEncoding, "Show File Encoding", QString(), true));
568 addConfigEntry(ConfigEntry(StatusbarLineColumnCompact, "Statusbar Line Column Compact Mode", QString(), true));
569 addConfigEntry(ConfigEntry(ShowStatusbarEOL, "Shoe Line Ending Type in Statusbar", QString(), false));
570 addConfigEntry(ConfigEntry(EnableAccessibility, "Enable Accessibility", QString(), true));
571 addConfigEntry(ConfigEntry(CycleThroughBookmarks, "Cycle Through Bookmarks", QString(), true));
572
573 // Never forget to finalize or the <CommandName> becomes not available
574 finalizeConfigEntries();
575
576 // init with defaults from config or really hardcoded ones
577 KConfigGroup config(KTextEditor::EditorPrivate::config(), QStringLiteral("KTextEditor View"));
578 readConfig(config);
579
580 // avoid updateConfig effects like config write in constructor, see bug 377067
581 Q_ASSERT(configSessionNumber == 1);
582 --configSessionNumber;
583}
584
585KateViewConfig::KateViewConfig(KTextEditor::ViewPrivate *view)
586 : KateConfig(s_global)
587 , m_view(view)
588{
589}
590
591KateViewConfig::~KateViewConfig() = default;
592
593void KateViewConfig::readConfig(const KConfigGroup &config)
594{
595 configStart();
596
597 // read generic entries
598 readConfigEntries(config);
599
600 configEnd();
601}
602
603void KateViewConfig::writeConfig(KConfigGroup &config)
604{
605 // write generic entries
606 writeConfigEntries(config);
607}
608
609void KateViewConfig::updateConfig()
610{
611 if (m_view) {
612 m_view->updateConfig();
613 return;
614 }
615
616 if (isGlobal()) {
617 for (KTextEditor::ViewPrivate *view : KTextEditor::EditorPrivate::self()->views()) {
618 view->updateConfig();
619 }
620
621 // write config
622 KConfigGroup cg(KTextEditor::EditorPrivate::config(), QStringLiteral("KTextEditor View"));
623 writeConfig(cg);
624 KTextEditor::EditorPrivate::config()->sync();
625
626 // trigger emission of KTextEditor::Editor::configChanged
627 KTextEditor::EditorPrivate::self()->triggerConfigChanged();
628 }
629}
630// END
631
632// BEGIN KateRendererConfig
633KateRendererConfig::KateRendererConfig()
634 : m_lineMarkerColor(KTextEditor::Document::reservedMarkersCount())
635 , m_schemaSet(false)
636 , m_fontSet(false)
637 , m_wordWrapMarkerSet(false)
638 , m_showIndentationLinesSet(false)
639 , m_showWholeBracketExpressionSet(false)
640 , m_backgroundColorSet(false)
641 , m_selectionColorSet(false)
642 , m_highlightedLineColorSet(false)
643 , m_highlightedBracketColorSet(false)
644 , m_wordWrapMarkerColorSet(false)
645 , m_tabMarkerColorSet(false)
646 , m_indentationLineColorSet(false)
647 , m_iconBarColorSet(false)
648 , m_foldingColorSet(false)
649 , m_lineNumberColorSet(false)
650 , m_currentLineNumberColorSet(false)
651 , m_separatorColorSet(false)
652 , m_spellingMistakeLineColorSet(false)
653 , m_templateColorsSet(false)
654 , m_modifiedLineColorSet(false)
655 , m_savedLineColorSet(false)
656 , m_searchHighlightColorSet(false)
657 , m_replaceHighlightColorSet(false)
658 , m_lineMarkerColorSet(m_lineMarkerColor.size())
659
660{
661 // init bitarray
662 m_lineMarkerColorSet.fill(true);
663
664 // register this as our global instance
665 Q_ASSERT(isGlobal());
666 s_global = this;
667
668 // avoid updateConfig effects like config write in constructor, see bug 377067
669 Q_ASSERT(configSessionNumber == 0);
670 ++configSessionNumber;
671
672 // Init all known config entries
673 addConfigEntry(ConfigEntry(AutoColorThemeSelection, "Auto Color Theme Selection", QString(), true));
674
675 // Never forget to finalize or the <CommandName> becomes not available
676 finalizeConfigEntries();
677
678 // init with defaults from config or really hardcoded ones
679 KConfigGroup config(KTextEditor::EditorPrivate::config(), QStringLiteral("KTextEditor Renderer"));
680 readConfig(config);
681
682 // avoid updateConfig effects like config write in constructor, see bug 377067
683 Q_ASSERT(configSessionNumber == 1);
684 --configSessionNumber;
685}
686
687KateRendererConfig::KateRendererConfig(KateRenderer *renderer)
688 : KateConfig(s_global)
689 , m_lineMarkerColor(KTextEditor::Document::reservedMarkersCount())
690 , m_schemaSet(false)
691 , m_fontSet(false)
692 , m_wordWrapMarkerSet(false)
693 , m_showIndentationLinesSet(false)
694 , m_showWholeBracketExpressionSet(false)
695 , m_backgroundColorSet(false)
696 , m_selectionColorSet(false)
697 , m_highlightedLineColorSet(false)
698 , m_highlightedBracketColorSet(false)
699 , m_wordWrapMarkerColorSet(false)
700 , m_tabMarkerColorSet(false)
701 , m_indentationLineColorSet(false)
702 , m_iconBarColorSet(false)
703 , m_foldingColorSet(false)
704 , m_lineNumberColorSet(false)
705 , m_currentLineNumberColorSet(false)
706 , m_separatorColorSet(false)
707 , m_spellingMistakeLineColorSet(false)
708 , m_templateColorsSet(false)
709 , m_modifiedLineColorSet(false)
710 , m_savedLineColorSet(false)
711 , m_searchHighlightColorSet(false)
712 , m_replaceHighlightColorSet(false)
713 , m_lineMarkerColorSet(m_lineMarkerColor.size())
714 , m_renderer(renderer)
715{
716 // init bitarray
717 m_lineMarkerColorSet.fill(false);
718}
719
720KateRendererConfig::~KateRendererConfig() = default;
721
722namespace
723{
724const char KEY_FONT[] = "Text Font";
725const char KEY_FONT_FEATURES[] = "Text Font Features";
726const char KEY_COLOR_THEME[] = "Color Theme";
727const char KEY_WORD_WRAP_MARKER[] = "Word Wrap Marker";
728const char KEY_SHOW_INDENTATION_LINES[] = "Show Indentation Lines";
729const char KEY_SHOW_WHOLE_BRACKET_EXPRESSION[] = "Show Whole Bracket Expression";
730const char KEY_ANIMATE_BRACKET_MATCHING[] = "Animate Bracket Matching";
731const char KEY_LINE_HEIGHT_MULTIPLIER[] = "Line Height Multiplier";
732}
733
734void KateRendererConfig::readConfig(const KConfigGroup &config)
735{
736 configStart();
737
738 // read generic entries
739 readConfigEntries(config);
740
741 // read font, including font features
742 auto font = config.readEntry(KEY_FONT, QFontDatabase::systemFont(QFontDatabase::FixedFont));
743 const QStringList rawFeaturesList = config.readEntry(KEY_FONT_FEATURES, QStringList());
744 for (const QString &feature : rawFeaturesList) {
745 const auto parts = feature.split(QStringLiteral("="), Qt::SkipEmptyParts);
746 if (parts.length() == 2) {
747 const auto tag = QFont::Tag::fromString(parts[0]);
748 bool ok = false;
749 const int number = parts[1].toInt(&ok);
750 if (tag.has_value() && ok) {
751 font.setFeature(tag.value(), number);
752 }
753 }
754 }
755 setFont(font);
756
757 // setSchema will default to right theme
758 setSchema(config.readEntry(KEY_COLOR_THEME, QString()));
759
760 setWordWrapMarker(config.readEntry(KEY_WORD_WRAP_MARKER, false));
761
762 setShowIndentationLines(config.readEntry(KEY_SHOW_INDENTATION_LINES, false));
763
764 setShowWholeBracketExpression(config.readEntry(KEY_SHOW_WHOLE_BRACKET_EXPRESSION, false));
765
766 setAnimateBracketMatching(config.readEntry(KEY_ANIMATE_BRACKET_MATCHING, false));
767
768 setLineHeightMultiplier(config.readEntry<qreal>(KEY_LINE_HEIGHT_MULTIPLIER, 1.0));
769
770 configEnd();
771}
772
773void KateRendererConfig::writeConfig(KConfigGroup &config)
774{
775 // write generic entries
776 writeConfigEntries(config);
777
778 // write font, including font features
779 const auto font = baseFont();
780 config.writeEntry(KEY_FONT, font);
781 const auto tags = font.featureTags();
782 QStringList features;
783 for (const auto &tag : tags) {
784 const QString name = QString::fromUtf8(tag.toString());
785 const quint32 value = font.featureValue(tag);
786 features.push_back(QStringLiteral("%1=%2").arg(name, QString::number(value)));
787 }
788 config.writeEntry(KEY_FONT_FEATURES, features);
789
790 config.writeEntry(KEY_COLOR_THEME, schema());
791
792 config.writeEntry(KEY_WORD_WRAP_MARKER, wordWrapMarker());
793
794 config.writeEntry(KEY_SHOW_INDENTATION_LINES, showIndentationLines());
795
796 config.writeEntry(KEY_SHOW_WHOLE_BRACKET_EXPRESSION, showWholeBracketExpression());
797
798 config.writeEntry(KEY_ANIMATE_BRACKET_MATCHING, animateBracketMatching());
799
800 config.writeEntry<qreal>(KEY_LINE_HEIGHT_MULTIPLIER, lineHeightMultiplier());
801}
802
803void KateRendererConfig::updateConfig()
804{
805 if (m_renderer) {
806 m_renderer->updateConfig();
807 return;
808 }
809
810 if (isGlobal()) {
811 for (auto view : KTextEditor::EditorPrivate::self()->views()) {
812 view->renderer()->updateConfig();
813 }
814
815 // write config
816 KConfigGroup cg(KTextEditor::EditorPrivate::config(), QStringLiteral("KTextEditor Renderer"));
817 writeConfig(cg);
818 KTextEditor::EditorPrivate::config()->sync();
819
820 // trigger emission of KTextEditor::Editor::configChanged
821 KTextEditor::EditorPrivate::self()->triggerConfigChanged();
822 }
823}
824
825const QString &KateRendererConfig::schema() const
826{
827 if (m_schemaSet || isGlobal()) {
828 return m_schema;
829 }
830
831 return s_global->schema();
832}
833
834void KateRendererConfig::setSchema(QString schema)
835{
836 // check if we have some matching theme, else fallback to best theme for current palette
837 // same behavior as for the "Automatic Color Theme Selection"
838 if (!KateHlManager::self()->repository().theme(schema).isValid()) {
839 schema = KateHlManager::self()->repository().themeForPalette(qGuiApp->palette()).name();
840 }
841
842 if (m_schemaSet && m_schema == schema) {
843 return;
844 }
845
846 configStart();
847 m_schemaSet = true;
848 m_schema = schema;
849 setSchemaInternal(m_schema);
850 configEnd();
851}
852
853void KateRendererConfig::reloadSchema()
854{
855 if (isGlobal()) {
856 setSchemaInternal(m_schema);
857 for (KTextEditor::ViewPrivate *view : KTextEditor::EditorPrivate::self()->views()) {
858 view->rendererConfig()->reloadSchema();
859 }
860 }
861
862 else if (m_renderer && m_schemaSet) {
863 setSchemaInternal(m_schema);
864 }
865
866 // trigger renderer/view update
867 if (m_renderer) {
868 m_renderer->updateConfig();
869 }
870}
871
872void KateRendererConfig::setSchemaInternal(const QString &schema)
873{
874 // we always set the theme if we arrive here!
875 m_schemaSet = true;
876
877 // for the global config, we honor the auto selection based on the palette
878 // do the same if the set theme really doesn't exist, we need a valid theme or the rendering will be broken in bad ways!
879 if ((isGlobal() && value(AutoColorThemeSelection).toBool()) || !KateHlManager::self()->repository().theme(schema).isValid()) {
880 // always choose some theme matching the current application palette
881 // we will arrive here after palette changed signals, too!
882 m_schema = KateHlManager::self()->repository().themeForPalette(qGuiApp->palette()).name();
883 } else {
884 // take user given theme 1:1
885 m_schema = schema;
886 }
887
888 const auto theme = KateHlManager::self()->repository().theme(m_schema);
889
890 m_backgroundColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::BackgroundColor));
891 m_backgroundColorSet = true;
892
893 m_selectionColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::TextSelection));
894 m_selectionColorSet = true;
895
896 m_highlightedLineColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::CurrentLine));
897 m_highlightedLineColorSet = true;
898
899 m_highlightedBracketColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::BracketMatching));
900 m_highlightedBracketColorSet = true;
901
902 m_wordWrapMarkerColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::WordWrapMarker));
903 m_wordWrapMarkerColorSet = true;
904
905 m_tabMarkerColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::TabMarker));
906 m_tabMarkerColorSet = true;
907
908 m_indentationLineColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::IndentationLine));
909 m_indentationLineColorSet = true;
910
911 m_iconBarColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::IconBorder));
912 m_iconBarColorSet = true;
913
914 m_foldingColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::CodeFolding));
915 m_foldingColorSet = true;
916
917 m_lineNumberColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::LineNumbers));
918 m_lineNumberColorSet = true;
919
920 m_currentLineNumberColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::CurrentLineNumber));
921 m_currentLineNumberColorSet = true;
922
923 m_separatorColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::Separator));
924 m_separatorColorSet = true;
925
926 m_spellingMistakeLineColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::SpellChecking));
927 m_spellingMistakeLineColorSet = true;
928
929 m_modifiedLineColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::ModifiedLines));
930 m_modifiedLineColorSet = true;
931
932 m_savedLineColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::SavedLines));
933 m_savedLineColorSet = true;
934
935 m_searchHighlightColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::SearchHighlight));
936 m_searchHighlightColorSet = true;
937
938 m_replaceHighlightColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::ReplaceHighlight));
939 m_replaceHighlightColorSet = true;
940
941 for (int i = 0; i <= KSyntaxHighlighting::Theme::MarkError - KSyntaxHighlighting::Theme::MarkBookmark; i++) {
942 QColor col =
943 QColor::fromRgba(theme.editorColor(static_cast<KSyntaxHighlighting::Theme::EditorColorRole>(i + KSyntaxHighlighting::Theme::MarkBookmark)));
944 m_lineMarkerColorSet[i] = true;
945 m_lineMarkerColor[i] = col;
946 }
947
948 m_templateBackgroundColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::TemplateBackground));
949
950 m_templateFocusedEditablePlaceholderColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::TemplateFocusedPlaceholder));
951
952 m_templateEditablePlaceholderColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::TemplatePlaceholder));
953
954 m_templateNotEditablePlaceholderColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::TemplateReadOnlyPlaceholder));
955
956 m_templateColorsSet = true;
957}
958
959const QFont &KateRendererConfig::baseFont() const
960{
961 if (m_fontSet || isGlobal()) {
962 return m_font;
963 }
964
965 return s_global->baseFont();
966}
967
968void KateRendererConfig::setFont(const QFont &font)
969{
970 if (m_fontSet && m_font == font) {
971 return;
972 }
973
974 configStart();
975 m_font = font;
976 m_fontSet = true;
977 configEnd();
978}
979
980bool KateRendererConfig::wordWrapMarker() const
981{
982 if (m_wordWrapMarkerSet || isGlobal()) {
983 return m_wordWrapMarker;
984 }
985
986 return s_global->wordWrapMarker();
987}
988
989void KateRendererConfig::setWordWrapMarker(bool on)
990{
991 if (m_wordWrapMarkerSet && m_wordWrapMarker == on) {
992 return;
993 }
994
995 configStart();
996
997 m_wordWrapMarkerSet = true;
998 m_wordWrapMarker = on;
999
1000 configEnd();
1001}
1002
1003const QColor &KateRendererConfig::backgroundColor() const
1004{
1005 if (m_backgroundColorSet || isGlobal()) {
1006 return m_backgroundColor;
1007 }
1008
1009 return s_global->backgroundColor();
1010}
1011
1012void KateRendererConfig::setBackgroundColor(const QColor &col)
1013{
1014 if (m_backgroundColorSet && m_backgroundColor == col) {
1015 return;
1016 }
1017
1018 configStart();
1019
1020 m_backgroundColorSet = true;
1021 m_backgroundColor = col;
1022
1023 configEnd();
1024}
1025
1026const QColor &KateRendererConfig::selectionColor() const
1027{
1028 if (m_selectionColorSet || isGlobal()) {
1029 return m_selectionColor;
1030 }
1031
1032 return s_global->selectionColor();
1033}
1034
1035void KateRendererConfig::setSelectionColor(const QColor &col)
1036{
1037 if (m_selectionColorSet && m_selectionColor == col) {
1038 return;
1039 }
1040
1041 configStart();
1042
1043 m_selectionColorSet = true;
1044 m_selectionColor = col;
1045
1046 configEnd();
1047}
1048
1049const QColor &KateRendererConfig::highlightedLineColor() const
1050{
1051 if (m_highlightedLineColorSet || isGlobal()) {
1052 return m_highlightedLineColor;
1053 }
1054
1055 return s_global->highlightedLineColor();
1056}
1057
1058void KateRendererConfig::setHighlightedLineColor(const QColor &col)
1059{
1060 if (m_highlightedLineColorSet && m_highlightedLineColor == col) {
1061 return;
1062 }
1063
1064 configStart();
1065
1066 m_highlightedLineColorSet = true;
1067 m_highlightedLineColor = col;
1068
1069 configEnd();
1070}
1071
1072const QColor &KateRendererConfig::lineMarkerColor(KTextEditor::Document::MarkTypes type) const
1073{
1074 int index = 0;
1075 if (type > 0) {
1076 while ((type >> index++) ^ 1) { }
1077 }
1078 index -= 1;
1079
1080 if (index < 0 || index >= KTextEditor::Document::reservedMarkersCount()) {
1081 static QColor dummy;
1082 return dummy;
1083 }
1084
1085 if (m_lineMarkerColorSet[index] || isGlobal()) {
1086 return m_lineMarkerColor[index];
1087 }
1088
1089 return s_global->lineMarkerColor(type);
1090}
1091
1092const QColor &KateRendererConfig::highlightedBracketColor() const
1093{
1094 if (m_highlightedBracketColorSet || isGlobal()) {
1095 return m_highlightedBracketColor;
1096 }
1097
1098 return s_global->highlightedBracketColor();
1099}
1100
1101void KateRendererConfig::setHighlightedBracketColor(const QColor &col)
1102{
1103 if (m_highlightedBracketColorSet && m_highlightedBracketColor == col) {
1104 return;
1105 }
1106
1107 configStart();
1108
1109 m_highlightedBracketColorSet = true;
1110 m_highlightedBracketColor = col;
1111
1112 configEnd();
1113}
1114
1115const QColor &KateRendererConfig::wordWrapMarkerColor() const
1116{
1117 if (m_wordWrapMarkerColorSet || isGlobal()) {
1118 return m_wordWrapMarkerColor;
1119 }
1120
1121 return s_global->wordWrapMarkerColor();
1122}
1123
1124void KateRendererConfig::setWordWrapMarkerColor(const QColor &col)
1125{
1126 if (m_wordWrapMarkerColorSet && m_wordWrapMarkerColor == col) {
1127 return;
1128 }
1129
1130 configStart();
1131
1132 m_wordWrapMarkerColorSet = true;
1133 m_wordWrapMarkerColor = col;
1134
1135 configEnd();
1136}
1137
1138const QColor &KateRendererConfig::tabMarkerColor() const
1139{
1140 if (m_tabMarkerColorSet || isGlobal()) {
1141 return m_tabMarkerColor;
1142 }
1143
1144 return s_global->tabMarkerColor();
1145}
1146
1147void KateRendererConfig::setTabMarkerColor(const QColor &col)
1148{
1149 if (m_tabMarkerColorSet && m_tabMarkerColor == col) {
1150 return;
1151 }
1152
1153 configStart();
1154
1155 m_tabMarkerColorSet = true;
1156 m_tabMarkerColor = col;
1157
1158 configEnd();
1159}
1160
1161const QColor &KateRendererConfig::indentationLineColor() const
1162{
1163 if (m_indentationLineColorSet || isGlobal()) {
1164 return m_indentationLineColor;
1165 }
1166
1167 return s_global->indentationLineColor();
1168}
1169
1170void KateRendererConfig::setIndentationLineColor(const QColor &col)
1171{
1172 if (m_indentationLineColorSet && m_indentationLineColor == col) {
1173 return;
1174 }
1175
1176 configStart();
1177
1178 m_indentationLineColorSet = true;
1179 m_indentationLineColor = col;
1180
1181 configEnd();
1182}
1183
1184const QColor &KateRendererConfig::iconBarColor() const
1185{
1186 if (m_iconBarColorSet || isGlobal()) {
1187 return m_iconBarColor;
1188 }
1189
1190 return s_global->iconBarColor();
1191}
1192
1193void KateRendererConfig::setIconBarColor(const QColor &col)
1194{
1195 if (m_iconBarColorSet && m_iconBarColor == col) {
1196 return;
1197 }
1198
1199 configStart();
1200
1201 m_iconBarColorSet = true;
1202 m_iconBarColor = col;
1203
1204 configEnd();
1205}
1206
1207const QColor &KateRendererConfig::foldingColor() const
1208{
1209 if (m_foldingColorSet || isGlobal()) {
1210 return m_foldingColor;
1211 }
1212
1213 return s_global->foldingColor();
1214}
1215
1216void KateRendererConfig::setFoldingColor(const QColor &col)
1217{
1218 if (m_foldingColorSet && m_foldingColor == col) {
1219 return;
1220 }
1221
1222 configStart();
1223
1224 m_foldingColorSet = true;
1225 m_foldingColor = col;
1226
1227 configEnd();
1228}
1229
1230const QColor &KateRendererConfig::templateBackgroundColor() const
1231{
1232 if (m_templateColorsSet || isGlobal()) {
1233 return m_templateBackgroundColor;
1234 }
1235
1236 return s_global->templateBackgroundColor();
1237}
1238
1239const QColor &KateRendererConfig::templateEditablePlaceholderColor() const
1240{
1241 if (m_templateColorsSet || isGlobal()) {
1242 return m_templateEditablePlaceholderColor;
1243 }
1244
1245 return s_global->templateEditablePlaceholderColor();
1246}
1247
1248const QColor &KateRendererConfig::templateFocusedEditablePlaceholderColor() const
1249{
1250 if (m_templateColorsSet || isGlobal()) {
1251 return m_templateFocusedEditablePlaceholderColor;
1252 }
1253
1254 return s_global->templateFocusedEditablePlaceholderColor();
1255}
1256
1257const QColor &KateRendererConfig::templateNotEditablePlaceholderColor() const
1258{
1259 if (m_templateColorsSet || isGlobal()) {
1260 return m_templateNotEditablePlaceholderColor;
1261 }
1262
1263 return s_global->templateNotEditablePlaceholderColor();
1264}
1265
1266const QColor &KateRendererConfig::lineNumberColor() const
1267{
1268 if (m_lineNumberColorSet || isGlobal()) {
1269 return m_lineNumberColor;
1270 }
1271
1272 return s_global->lineNumberColor();
1273}
1274
1275void KateRendererConfig::setLineNumberColor(const QColor &col)
1276{
1277 if (m_lineNumberColorSet && m_lineNumberColor == col) {
1278 return;
1279 }
1280
1281 configStart();
1282
1283 m_lineNumberColorSet = true;
1284 m_lineNumberColor = col;
1285
1286 configEnd();
1287}
1288
1289const QColor &KateRendererConfig::currentLineNumberColor() const
1290{
1291 if (m_currentLineNumberColorSet || isGlobal()) {
1292 return m_currentLineNumberColor;
1293 }
1294
1295 return s_global->currentLineNumberColor();
1296}
1297
1298void KateRendererConfig::setCurrentLineNumberColor(const QColor &col)
1299{
1300 if (m_currentLineNumberColorSet && m_currentLineNumberColor == col) {
1301 return;
1302 }
1303
1304 configStart();
1305
1306 m_currentLineNumberColorSet = true;
1307 m_currentLineNumberColor = col;
1308
1309 configEnd();
1310}
1311
1312const QColor &KateRendererConfig::separatorColor() const
1313{
1314 if (m_separatorColorSet || isGlobal()) {
1315 return m_separatorColor;
1316 }
1317
1318 return s_global->separatorColor();
1319}
1320
1321void KateRendererConfig::setSeparatorColor(const QColor &col)
1322{
1323 if (m_separatorColorSet && m_separatorColor == col) {
1324 return;
1325 }
1326
1327 configStart();
1328
1329 m_separatorColorSet = true;
1330 m_separatorColor = col;
1331
1332 configEnd();
1333}
1334
1335const QColor &KateRendererConfig::spellingMistakeLineColor() const
1336{
1337 if (m_spellingMistakeLineColorSet || isGlobal()) {
1338 return m_spellingMistakeLineColor;
1339 }
1340
1341 return s_global->spellingMistakeLineColor();
1342}
1343
1344void KateRendererConfig::setSpellingMistakeLineColor(const QColor &col)
1345{
1346 if (m_spellingMistakeLineColorSet && m_spellingMistakeLineColor == col) {
1347 return;
1348 }
1349
1350 configStart();
1351
1352 m_spellingMistakeLineColorSet = true;
1353 m_spellingMistakeLineColor = col;
1354
1355 configEnd();
1356}
1357
1358const QColor &KateRendererConfig::modifiedLineColor() const
1359{
1360 if (m_modifiedLineColorSet || isGlobal()) {
1361 return m_modifiedLineColor;
1362 }
1363
1364 return s_global->modifiedLineColor();
1365}
1366
1367void KateRendererConfig::setModifiedLineColor(const QColor &col)
1368{
1369 if (m_modifiedLineColorSet && m_modifiedLineColor == col) {
1370 return;
1371 }
1372
1373 configStart();
1374
1375 m_modifiedLineColorSet = true;
1376 m_modifiedLineColor = col;
1377
1378 configEnd();
1379}
1380
1381const QColor &KateRendererConfig::savedLineColor() const
1382{
1383 if (m_savedLineColorSet || isGlobal()) {
1384 return m_savedLineColor;
1385 }
1386
1387 return s_global->savedLineColor();
1388}
1389
1390void KateRendererConfig::setSavedLineColor(const QColor &col)
1391{
1392 if (m_savedLineColorSet && m_savedLineColor == col) {
1393 return;
1394 }
1395
1396 configStart();
1397
1398 m_savedLineColorSet = true;
1399 m_savedLineColor = col;
1400
1401 configEnd();
1402}
1403
1404const QColor &KateRendererConfig::searchHighlightColor() const
1405{
1406 if (m_searchHighlightColorSet || isGlobal()) {
1407 return m_searchHighlightColor;
1408 }
1409
1410 return s_global->searchHighlightColor();
1411}
1412
1413void KateRendererConfig::setSearchHighlightColor(const QColor &col)
1414{
1415 if (m_searchHighlightColorSet && m_searchHighlightColor == col) {
1416 return;
1417 }
1418
1419 configStart();
1420
1421 m_searchHighlightColorSet = true;
1422 m_searchHighlightColor = col;
1423
1424 configEnd();
1425}
1426
1427const QColor &KateRendererConfig::replaceHighlightColor() const
1428{
1429 if (m_replaceHighlightColorSet || isGlobal()) {
1430 return m_replaceHighlightColor;
1431 }
1432
1433 return s_global->replaceHighlightColor();
1434}
1435
1436void KateRendererConfig::setReplaceHighlightColor(const QColor &col)
1437{
1438 if (m_replaceHighlightColorSet && m_replaceHighlightColor == col) {
1439 return;
1440 }
1441
1442 configStart();
1443
1444 m_replaceHighlightColorSet = true;
1445 m_replaceHighlightColor = col;
1446
1447 configEnd();
1448}
1449
1450void KateRendererConfig::setLineHeightMultiplier(qreal value)
1451{
1452 configStart();
1453 m_lineHeightMultiplier = value;
1454 configEnd();
1455}
1456
1457bool KateRendererConfig::showIndentationLines() const
1458{
1459 if (m_showIndentationLinesSet || isGlobal()) {
1460 return m_showIndentationLines;
1461 }
1462
1463 return s_global->showIndentationLines();
1464}
1465
1466void KateRendererConfig::setShowIndentationLines(bool on)
1467{
1468 if (m_showIndentationLinesSet && m_showIndentationLines == on) {
1469 return;
1470 }
1471
1472 configStart();
1473
1474 m_showIndentationLinesSet = true;
1475 m_showIndentationLines = on;
1476
1477 configEnd();
1478}
1479
1480bool KateRendererConfig::showWholeBracketExpression() const
1481{
1482 if (m_showWholeBracketExpressionSet || isGlobal()) {
1483 return m_showWholeBracketExpression;
1484 }
1485
1486 return s_global->showWholeBracketExpression();
1487}
1488
1489void KateRendererConfig::setShowWholeBracketExpression(bool on)
1490{
1491 if (m_showWholeBracketExpressionSet && m_showWholeBracketExpression == on) {
1492 return;
1493 }
1494
1495 configStart();
1496
1497 m_showWholeBracketExpressionSet = true;
1498 m_showWholeBracketExpression = on;
1499
1500 configEnd();
1501}
1502
1503bool KateRendererConfig::animateBracketMatching()
1504{
1505 return s_global->m_animateBracketMatching;
1506}
1507
1508void KateRendererConfig::setAnimateBracketMatching(bool on)
1509{
1510 if (!isGlobal()) {
1511 s_global->setAnimateBracketMatching(on);
1512 } else if (on != m_animateBracketMatching) {
1513 configStart();
1514 m_animateBracketMatching = on;
1515 configEnd();
1516 }
1517}
1518
1519// END
KConfigGroup::deleteEntry
void deleteEntry(const char *key, WriteConfigFlags pFlags=Normal)
KConfigGroup::writeEntry
void writeEntry(const char *key, const char *value, WriteConfigFlags pFlags=Normal)
KConfigGroup::readEntry
QString readEntry(const char *key, const char *aDefault=nullptr) const
KSyntaxHighlighting::Repository::themeForPalette
Theme themeForPalette(const QPalette &palette) const
KSyntaxHighlighting::Repository::theme
Q_INVOKABLE KSyntaxHighlighting::Theme theme(const QString &themeName) const
KTextEditor::DocumentPrivate
Backend of KTextEditor::Document related public KTextEditor interfaces.
Definition katedocument.h:68
KTextEditor::Document::MarkTypes
MarkTypes
Predefined mark types.
Definition document.h:1557
KTextEditor::Document::markType01
@ markType01
Bookmark.
Definition document.h:1559
KTextEditor::Document::reservedMarkersCount
static int reservedMarkersCount()
Get the number of predefined mark types we have so far.
Definition document.h:1546
KTextEditor::EditorPrivate::config
static KSharedConfigPtr config()
The global configuration of katepart, e.g.
Definition kateglobal.cpp:536
KTextEditor::EditorPrivate::triggerConfigChanged
void triggerConfigChanged()
Trigger delayed emission of config changed.
Definition kateglobal.cpp:556
KTextEditor::EditorPrivate::self
static KTextEditor::EditorPrivate * self()
Kate Part Internal stuff ;)
Definition kateglobal.cpp:381
KTextEditor::EditorPrivate::documents
QList< KTextEditor::Document * > documents() override
Returns a list of all documents of this editor.
Definition kateglobal.h:99
KateConfig::ConfigEntry
One config entry.
Definition kateconfig.h:140
KateConfig
Base Class for the Kate Config Classes Current childs are KateDocumentConfig/KateDocumentConfig/KateD...
Definition kateconfig.h:47
KateConfig::isGlobal
bool isGlobal() const
Is this a global config object?
Definition kateconfig.h:66
KateConfig::KateConfig
KateConfig(const KateConfig *parent=nullptr)
Construct a KateConfig.
Definition kateconfig.cpp:30
KateConfig::~KateConfig
virtual ~KateConfig()
Virtual Destructor.
KateConfig::configSessionNumber
int configSessionNumber
recursion depth
Definition kateconfig.h:272
KateConfig::writeConfigEntries
void writeConfigEntries(KConfigGroup &config) const
Write all config entries to given config group.
Definition kateconfig.cpp:86
KateConfig::configEnd
void configEnd()
End a config change transaction, update the concerned KateDocumentConfig/KateDocumentConfig/KateDocum...
Definition kateconfig.cpp:103
KateConfig::readConfigEntries
void readConfigEntries(const KConfigGroup &config)
Read all config entries from given config group.
Definition kateconfig.cpp:74
KateConfig::finalizeConfigEntries
void finalizeConfigEntries()
Finalize the config entries.
Definition kateconfig.cpp:55
KateConfig::configStart
void configStart()
Start some config changes.
Definition kateconfig.cpp:94
KateConfig::setValue
bool setValue(const int key, const QVariant &value)
Set a config value.
Definition kateconfig.cpp:137
KateConfig::value
QVariant value(const int key) const
Get a config value.
Definition kateconfig.cpp:118
KateConfig::updateConfig
virtual void updateConfig()=0
do the real update
KateConfig::addConfigEntry
void addConfigEntry(ConfigEntry &&entry)
Register a new config entry.
Definition kateconfig.cpp:39
KateRenderer
Handles all of the work of rendering the text (used for the views and printing)
Definition katerenderer.h:56
Sonnet::GuessLanguage::identify
QString identify(const QString &text, const QStringList &suggestions=QStringList()) const
Sonnet::Speller::isMisspelled
bool isMisspelled(const QString &word) const
Sonnet::Speller::setLanguage
void setLanguage(const QString &lang)
KIO::number
KIOCORE_EXPORT QString number(KIO::filesize_t size)
KPublicTransport::IfoptUtil::isValid
bool isValid(QStringView ifopt)
KPublicTransport::UicRailwayCoach::features
std::vector< Feature > features(QStringView coachNumber, QStringView coachClassification)
KStandardActions::name
QString name(StandardAction id)
KTextEditor
The KTextEditor namespace contains all the public API that is required to use the KTextEditor compone...
Definition katetextblock.h:18
QByteArray::constData
const char * constData() const const
QColor::fromRgba
QColor fromRgba(QRgb rgba)
QFontDatabase::systemFont
QFont systemFont(SystemFont type)
QString::fromUtf8
QString fromUtf8(QByteArrayView str)
QString::number
QString number(double n, char format, int precision)
QString::toInt
int toInt(bool *ok, int base) const const
QString::toUtf8
QByteArray toUtf8() const const
QStringConverter::isValid
bool isValid() const const
QStringConverter::nameForEncoding
const char * nameForEncoding(Encoding e)
Qt::AltModifier
AltModifier
Qt::SkipEmptyParts
SkipEmptyParts
QVariant::toInt
int toInt(bool *ok) const const
QVariant::toUInt
uint toUInt(bool *ok) const const
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Apr 25 2025 11:52:17 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.