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
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
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
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
75{
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
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
95{
97
98 if (configSessionNumber > 1) {
99 return;
100 }
101}
102
104{
105 if (configSessionNumber == 0) {
106 return;
107 }
108
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
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{
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);
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(),
252 [](const QVariant &value) {
253 return isEncodingOk(value.toString());
254 }));
255
256 // finalize the entries, e.g. hashs them
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);
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);
292
293 // trigger emission of KTextEditor::Editor::configChanged
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);
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));
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));
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
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);
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 Sonnet::GuessLanguage languageGuesser;
409 languageGuesser.identify(QStringLiteral("dummy to trigger identify"));
410 }
411 }
412
413 // backwards compatibility mappings
414 // convert stuff, old entries deleted in writeConfig
415 if (const int backupFlags = config.readEntry("Backup Flags", 0)) {
416 setBackupOnSaveLocal(backupFlags & 0x1);
417 setBackupOnSaveRemote(backupFlags & 0x2);
418 }
419
420 // end config update group, might trigger updateConfig()
421 configEnd();
422}
423
424void KateDocumentConfig::writeConfig(KConfigGroup &config)
425{
426 // write generic entries
427 writeConfigEntries(config);
428
429 // backwards compatibility mappings
430 // here we remove old entries we converted on readConfig
431 config.deleteEntry("Backup Flags");
432}
433
434void KateDocumentConfig::updateConfig()
435{
436 if (m_doc) {
437 m_doc->updateConfig();
438 return;
439 }
440
441 if (isGlobal()) {
442 const auto docs = KTextEditor::EditorPrivate::self()->documents();
443 for (auto doc : docs) {
444 static_cast<KTextEditor::DocumentPrivate *>(doc)->updateConfig();
445 }
446
447 // write config
448 KConfigGroup cg(KTextEditor::EditorPrivate::config(), QStringLiteral("KTextEditor Document"));
449 writeConfig(cg);
451
452 // trigger emission of KTextEditor::Editor::configChanged
454 }
455}
456
457QString KateDocumentConfig::eolString() const
458{
459 switch (eol()) {
460 case KateDocumentConfig::eolDos:
461 return QStringLiteral("\r\n");
462
463 case KateDocumentConfig::eolMac:
464 return QStringLiteral("\r");
465
466 default:
467 return QStringLiteral("\n");
468 }
469}
470// END
471
472// BEGIN KateViewConfig
473KateViewConfig::KateViewConfig()
474{
475 // register this as our global instance
476 Q_ASSERT(isGlobal());
477 s_global = this;
478
479 // avoid updateConfig effects like config write in constructor, see bug 377067
480 Q_ASSERT(configSessionNumber == 0);
482
483 // Init all known config entries
484 // NOTE: Ensure to keep the same order as listed in enum ConfigEntryTypes or it will later assert!
485 // addConfigEntry(ConfigEntry(<EnumKey>, <ConfigKey>, <CommandName>, <DefaultValue>, [<ValidatorFunction>]))
486 addConfigEntry(ConfigEntry(AllowMarkMenu, "Allow Mark Menu", QStringLiteral("allow-mark-menu"), true));
487 addConfigEntry(ConfigEntry(AutoBrackets, "Auto Brackets", QStringLiteral("auto-brackets"), true));
488 addConfigEntry(ConfigEntry(AutoCenterLines, "Auto Center Lines", QStringLiteral("auto-center-lines"), 0));
489 addConfigEntry(ConfigEntry(AutomaticCompletionInvocation, "Auto Completion", QString(), true));
490 addConfigEntry(ConfigEntry(AutomaticCompletionPreselectFirst, "Auto Completion Preselect First Entry", QString(), true));
491 addConfigEntry(ConfigEntry(BackspaceRemoveComposedCharacters, "Backspace Remove Composed Characters", QString(), false));
492 addConfigEntry(ConfigEntry(BookmarkSorting, "Bookmark Menu Sorting", QString(), 0));
493 addConfigEntry(ConfigEntry(CharsToEncloseSelection, "Chars To Enclose Selection", QStringLiteral("enclose-selection"), QStringLiteral("<>(){}[]'\"")));
494 addConfigEntry(ConfigEntry(ClipboardHistoryEntries, "Max Clipboard History Entries", QString(), 20, [](const QVariant &value) {
495 return inBounds(1, value, 999);
496 }));
498 ConfigEntry(DefaultMarkType, "Default Mark Type", QStringLiteral("default-mark-type"), KTextEditor::Document::markType01, [](const QVariant &value) {
499 return isPositive(value);
500 }));
501 addConfigEntry(ConfigEntry(DynWordWrapAlignIndent, "Dynamic Word Wrap Align Indent", QString(), 80, [](const QVariant &value) {
502 return inBounds(0, value, 100);
503 }));
504 addConfigEntry(ConfigEntry(DynWordWrapIndicators, "Dynamic Word Wrap Indicators", QString(), 1, [](const QVariant &value) {
505 return inBounds(0, value, 2);
506 }));
507 addConfigEntry(ConfigEntry(DynWrapAnywhere, "Dynamic Wrap not at word boundaries", QStringLiteral("dynamic-word-wrap-anywhere"), false));
508 addConfigEntry(ConfigEntry(DynWrapAtStaticMarker, "Dynamic Word Wrap At Static Marker", QString(), false));
509 addConfigEntry(ConfigEntry(DynamicWordWrap, "Dynamic Word Wrap", QStringLiteral("dynamic-word-wrap"), true));
510 addConfigEntry(ConfigEntry(EnterToInsertCompletion, "Enter To Insert Completion", QStringLiteral("enter-to-insert-completion"), true));
511 addConfigEntry(ConfigEntry(FoldFirstLine, "Fold First Line", QString(), false));
512 addConfigEntry(ConfigEntry(InputMode, "Input Mode", QString(), 0, [](const QVariant &value) {
513 return isPositive(value);
514 }));
515 addConfigEntry(ConfigEntry(KeywordCompletion, "Keyword Completion", QStringLiteral("keyword-completion"), true));
516 addConfigEntry(ConfigEntry(MaxHistorySize, "Maximum Search History Size", QString(), 100, [](const QVariant &value) {
517 return inBounds(0, value, 999);
518 }));
519 addConfigEntry(ConfigEntry(MousePasteAtCursorPosition, "Mouse Paste At Cursor Position", QString(), false));
520 addConfigEntry(ConfigEntry(PersistentSelection, "Persistent Selection", QStringLiteral("persistent-selectionq"), false));
521 addConfigEntry(ConfigEntry(ScrollBarMiniMapWidth, "Scroll Bar Mini Map Width", QString(), 60, [](const QVariant &value) {
522 return inBounds(0, value, 999);
523 }));
524 addConfigEntry(ConfigEntry(ScrollPastEnd, "Scroll Past End", QString(), false));
525 addConfigEntry(ConfigEntry(SearchFlags, "Search/Replace Flags", QString(), IncFromCursor | PowerMatchCase | PowerModePlainText));
526 addConfigEntry(ConfigEntry(TabCompletion, "Enable Tab completion", QString(), false));
527 addConfigEntry(ConfigEntry(ShowBracketMatchPreview, "Bracket Match Preview", QStringLiteral("bracket-match-preview"), false));
528 addConfigEntry(ConfigEntry(ShowFoldingBar, "Folding Bar", QStringLiteral("folding-bar"), true));
529 addConfigEntry(ConfigEntry(ShowFoldingPreview, "Folding Preview", QStringLiteral("folding-preview"), true));
530 addConfigEntry(ConfigEntry(ShowIconBar, "Icon Bar", QStringLiteral("icon-bar"), false));
531 addConfigEntry(ConfigEntry(ShowLineCount, "Show Line Count", QString(), false));
532 addConfigEntry(ConfigEntry(ShowLineModification, "Line Modification", QStringLiteral("modification-markers"), true));
533 addConfigEntry(ConfigEntry(ShowLineNumbers, "Line Numbers", QStringLiteral("line-numbers"), true));
534 addConfigEntry(ConfigEntry(ShowScrollBarMarks, "Scroll Bar Marks", QString(), false));
535 addConfigEntry(ConfigEntry(ShowScrollBarMiniMap, "Scroll Bar MiniMap", QStringLiteral("scrollbar-minimap"), true));
536 addConfigEntry(ConfigEntry(ShowScrollBarMiniMapAll, "Scroll Bar Mini Map All", QString(), true));
537 addConfigEntry(ConfigEntry(ShowScrollBarPreview, "Scroll Bar Preview", QStringLiteral("scrollbar-preview"), true));
538 addConfigEntry(ConfigEntry(ShowScrollbars, "Show Scrollbars", QString(), AlwaysOn, [](const QVariant &value) {
539 return inBounds(0, value, 2);
540 }));
541 addConfigEntry(ConfigEntry(ShowWordCount, "Show Word Count", QString(), false));
542 addConfigEntry(ConfigEntry(TextDragAndDrop, "Text Drag And Drop", QString(), true));
543 addConfigEntry(ConfigEntry(SmartCopyCut, "Smart Copy Cut", QString(), true));
544 addConfigEntry(ConfigEntry(UserSetsOfCharsToEncloseSelection, "User Sets Of Chars To Enclose Selection", QString(), QStringList()));
545 addConfigEntry(ConfigEntry(ViInputModeStealKeys, "Vi Input Mode Steal Keys", QString(), false));
546 addConfigEntry(ConfigEntry(ViRelativeLineNumbers, "Vi Relative Line Numbers", QString(), false));
547 addConfigEntry(ConfigEntry(WordCompletion, "Word Completion", QString(), true));
548 addConfigEntry(ConfigEntry(WordCompletionMinimalWordLength,
549 "Word Completion Minimal Word Length",
550 QStringLiteral("word-completion-minimal-word-length"),
551 3,
552 [](const QVariant &value) {
553 return inBounds(0, value, 99);
554 }));
555 addConfigEntry(ConfigEntry(WordCompletionRemoveTail, "Word Completion Remove Tail", QString(), true));
556 addConfigEntry(ConfigEntry(ShowDocWithCompletion, "Show Documentation With Completion", QString(), true));
557 addConfigEntry(ConfigEntry(MultiCursorModifier, "Multiple Cursor Modifier", QString(), (int)Qt::AltModifier));
558 addConfigEntry(ConfigEntry(ShowFoldingOnHoverOnly, "Show Folding Icons On Hover Only", QString(), true));
559
560 // Statusbar stuff
561 addConfigEntry(ConfigEntry(ShowStatusbarLineColumn, "Show Statusbar Line Column", QString(), true));
562 addConfigEntry(ConfigEntry(ShowStatusbarDictionary, "Show Statusbar Dictionary", QString(), true));
563 addConfigEntry(ConfigEntry(ShowStatusbarInputMode, "Show Statusbar Input Mode", QString(), true));
564 addConfigEntry(ConfigEntry(ShowStatusbarHighlightingMode, "Show Statusbar Highlighting Mode", QString(), true));
565 addConfigEntry(ConfigEntry(ShowStatusbarTabSettings, "Show Statusbar Tab Settings", QString(), true));
566 addConfigEntry(ConfigEntry(ShowStatusbarFileEncoding, "Show File Encoding", QString(), true));
567 addConfigEntry(ConfigEntry(StatusbarLineColumnCompact, "Statusbar Line Column Compact Mode", QString(), true));
568 addConfigEntry(ConfigEntry(ShowStatusbarEOL, "Shoe Line Ending Type in Statusbar", QString(), false));
569 addConfigEntry(ConfigEntry(EnableAccessibility, "Enable Accessibility", QString(), true));
570
571 // Never forget to finalize or the <CommandName> becomes not available
573
574 // init with defaults from config or really hardcoded ones
575 KConfigGroup config(KTextEditor::EditorPrivate::config(), QStringLiteral("KTextEditor View"));
576 readConfig(config);
577
578 // avoid updateConfig effects like config write in constructor, see bug 377067
579 Q_ASSERT(configSessionNumber == 1);
581}
582
583KateViewConfig::KateViewConfig(KTextEditor::ViewPrivate *view)
584 : KateConfig(s_global)
585 , m_view(view)
586{
587}
588
589KateViewConfig::~KateViewConfig() = default;
590
591void KateViewConfig::readConfig(const KConfigGroup &config)
592{
593 configStart();
594
595 // read generic entries
596 readConfigEntries(config);
597
598 configEnd();
599}
600
601void KateViewConfig::writeConfig(KConfigGroup &config)
602{
603 // write generic entries
604 writeConfigEntries(config);
605}
606
607void KateViewConfig::updateConfig()
608{
609 if (m_view) {
610 m_view->updateConfig();
611 return;
612 }
613
614 if (isGlobal()) {
615 for (KTextEditor::ViewPrivate *view : KTextEditor::EditorPrivate::self()->views()) {
616 view->updateConfig();
617 }
618
619 // write config
620 KConfigGroup cg(KTextEditor::EditorPrivate::config(), QStringLiteral("KTextEditor View"));
621 writeConfig(cg);
623
624 // trigger emission of KTextEditor::Editor::configChanged
626 }
627}
628// END
629
630// BEGIN KateRendererConfig
631KateRendererConfig::KateRendererConfig()
632 : m_lineMarkerColor(KTextEditor::Document::reservedMarkersCount())
633 , m_schemaSet(false)
634 , m_fontSet(false)
635 , m_wordWrapMarkerSet(false)
636 , m_showIndentationLinesSet(false)
637 , m_showWholeBracketExpressionSet(false)
638 , m_backgroundColorSet(false)
639 , m_selectionColorSet(false)
640 , m_highlightedLineColorSet(false)
641 , m_highlightedBracketColorSet(false)
642 , m_wordWrapMarkerColorSet(false)
643 , m_tabMarkerColorSet(false)
644 , m_indentationLineColorSet(false)
645 , m_iconBarColorSet(false)
646 , m_foldingColorSet(false)
647 , m_lineNumberColorSet(false)
648 , m_currentLineNumberColorSet(false)
649 , m_separatorColorSet(false)
650 , m_spellingMistakeLineColorSet(false)
651 , m_templateColorsSet(false)
652 , m_modifiedLineColorSet(false)
653 , m_savedLineColorSet(false)
654 , m_searchHighlightColorSet(false)
655 , m_replaceHighlightColorSet(false)
656 , m_lineMarkerColorSet(m_lineMarkerColor.size())
657
658{
659 // init bitarray
660 m_lineMarkerColorSet.fill(true);
661
662 // register this as our global instance
663 Q_ASSERT(isGlobal());
664 s_global = this;
665
666 // avoid updateConfig effects like config write in constructor, see bug 377067
667 Q_ASSERT(configSessionNumber == 0);
669
670 // Init all known config entries
671 addConfigEntry(ConfigEntry(AutoColorThemeSelection, "Auto Color Theme Selection", QString(), true));
672
673 // Never forget to finalize or the <CommandName> becomes not available
675
676 // init with defaults from config or really hardcoded ones
677 KConfigGroup config(KTextEditor::EditorPrivate::config(), QStringLiteral("KTextEditor Renderer"));
678 readConfig(config);
679
680 // avoid updateConfig effects like config write in constructor, see bug 377067
681 Q_ASSERT(configSessionNumber == 1);
683}
684
685KateRendererConfig::KateRendererConfig(KateRenderer *renderer)
686 : KateConfig(s_global)
687 , m_lineMarkerColor(KTextEditor::Document::reservedMarkersCount())
688 , m_schemaSet(false)
689 , m_fontSet(false)
690 , m_wordWrapMarkerSet(false)
691 , m_showIndentationLinesSet(false)
692 , m_showWholeBracketExpressionSet(false)
693 , m_backgroundColorSet(false)
694 , m_selectionColorSet(false)
695 , m_highlightedLineColorSet(false)
696 , m_highlightedBracketColorSet(false)
697 , m_wordWrapMarkerColorSet(false)
698 , m_tabMarkerColorSet(false)
699 , m_indentationLineColorSet(false)
700 , m_iconBarColorSet(false)
701 , m_foldingColorSet(false)
702 , m_lineNumberColorSet(false)
703 , m_currentLineNumberColorSet(false)
704 , m_separatorColorSet(false)
705 , m_spellingMistakeLineColorSet(false)
706 , m_templateColorsSet(false)
707 , m_modifiedLineColorSet(false)
708 , m_savedLineColorSet(false)
709 , m_searchHighlightColorSet(false)
710 , m_replaceHighlightColorSet(false)
711 , m_lineMarkerColorSet(m_lineMarkerColor.size())
712 , m_renderer(renderer)
713{
714 // init bitarray
715 m_lineMarkerColorSet.fill(false);
716}
717
718KateRendererConfig::~KateRendererConfig() = default;
719
720namespace
721{
722const char KEY_FONT[] = "Text Font";
723const char KEY_FONT_FEATURES[] = "Text Font Features";
724const char KEY_COLOR_THEME[] = "Color Theme";
725const char KEY_WORD_WRAP_MARKER[] = "Word Wrap Marker";
726const char KEY_SHOW_INDENTATION_LINES[] = "Show Indentation Lines";
727const char KEY_SHOW_WHOLE_BRACKET_EXPRESSION[] = "Show Whole Bracket Expression";
728const char KEY_ANIMATE_BRACKET_MATCHING[] = "Animate Bracket Matching";
729const char KEY_LINE_HEIGHT_MULTIPLIER[] = "Line Height Multiplier";
730}
731
732void KateRendererConfig::readConfig(const KConfigGroup &config)
733{
734 configStart();
735
736 // read generic entries
737 readConfigEntries(config);
738
739 // read font, including font features
740 auto font = config.readEntry(KEY_FONT, QFontDatabase::systemFont(QFontDatabase::FixedFont));
741#if QT_VERSION >= QT_VERSION_CHECK(6, 7, 0)
742 const QStringList rawFeaturesList = config.readEntry(KEY_FONT_FEATURES, QStringList());
743 for (const QString &feature : rawFeaturesList) {
744 const auto parts = feature.split(QStringLiteral("="), Qt::SkipEmptyParts);
745 if (parts.length() == 2) {
746 const auto tag = QFont::Tag::fromString(parts[0]);
747 bool ok = false;
748 const int number = parts[1].toInt(&ok);
749 if (tag.has_value() && ok) {
750 font.setFeature(tag.value(), number);
751 }
752 }
753 }
754#endif
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#if QT_VERSION >= QT_VERSION_CHECK(6, 7, 0)
782 const auto tags = font.featureTags();
784 for (const auto &tag : tags) {
785 const QString name = QString::fromUtf8(tag.toString());
786 const quint32 value = font.featureValue(tag);
787 features.push_back(QStringLiteral("%1=%2").arg(name, QString::number(value)));
788 }
789 config.writeEntry(KEY_FONT_FEATURES, features);
790#endif
791
792 config.writeEntry(KEY_COLOR_THEME, schema());
793
794 config.writeEntry(KEY_WORD_WRAP_MARKER, wordWrapMarker());
795
796 config.writeEntry(KEY_SHOW_INDENTATION_LINES, showIndentationLines());
797
798 config.writeEntry(KEY_SHOW_WHOLE_BRACKET_EXPRESSION, showWholeBracketExpression());
799
800 config.writeEntry(KEY_ANIMATE_BRACKET_MATCHING, animateBracketMatching());
801
802 config.writeEntry<qreal>(KEY_LINE_HEIGHT_MULTIPLIER, lineHeightMultiplier());
803}
804
805void KateRendererConfig::updateConfig()
806{
807 if (m_renderer) {
808 m_renderer->updateConfig();
809 return;
810 }
811
812 if (isGlobal()) {
813 for (auto view : KTextEditor::EditorPrivate::self()->views()) {
814 view->renderer()->updateConfig();
815 }
816
817 // write config
818 KConfigGroup cg(KTextEditor::EditorPrivate::config(), QStringLiteral("KTextEditor Renderer"));
819 writeConfig(cg);
821
822 // trigger emission of KTextEditor::Editor::configChanged
824 }
825}
826
827const QString &KateRendererConfig::schema() const
828{
829 if (m_schemaSet || isGlobal()) {
830 return m_schema;
831 }
832
833 return s_global->schema();
834}
835
836void KateRendererConfig::setSchema(QString schema)
837{
838 // check if we have some matching theme, else fallback to best theme for current palette
839 // same behavior as for the "Automatic Color Theme Selection"
840 if (!KateHlManager::self()->repository().theme(schema).isValid()) {
841 schema = KateHlManager::self()->repository().themeForPalette(qGuiApp->palette()).name();
842 }
843
844 if (m_schemaSet && m_schema == schema) {
845 return;
846 }
847
848 configStart();
849 m_schemaSet = true;
850 m_schema = schema;
851 setSchemaInternal(m_schema);
852 configEnd();
853}
854
855void KateRendererConfig::reloadSchema()
856{
857 if (isGlobal()) {
858 setSchemaInternal(m_schema);
859 for (KTextEditor::ViewPrivate *view : KTextEditor::EditorPrivate::self()->views()) {
860 view->rendererConfig()->reloadSchema();
861 }
862 }
863
864 else if (m_renderer && m_schemaSet) {
865 setSchemaInternal(m_schema);
866 }
867
868 // trigger renderer/view update
869 if (m_renderer) {
870 m_renderer->updateConfig();
871 }
872}
873
874void KateRendererConfig::setSchemaInternal(const QString &schema)
875{
876 // we always set the theme if we arrive here!
877 m_schemaSet = true;
878
879 // for the global config, we honor the auto selection based on the palette
880 // 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!
881 if ((isGlobal() && value(AutoColorThemeSelection).toBool()) || !KateHlManager::self()->repository().theme(schema).isValid()) {
882 // always choose some theme matching the current application palette
883 // we will arrive here after palette changed signals, too!
884 m_schema = KateHlManager::self()->repository().themeForPalette(qGuiApp->palette()).name();
885 } else {
886 // take user given theme 1:1
887 m_schema = schema;
888 }
889
890 const auto theme = KateHlManager::self()->repository().theme(m_schema);
891
892 m_backgroundColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::BackgroundColor));
893 m_backgroundColorSet = true;
894
895 m_selectionColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::TextSelection));
896 m_selectionColorSet = true;
897
898 m_highlightedLineColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::CurrentLine));
899 m_highlightedLineColorSet = true;
900
901 m_highlightedBracketColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::BracketMatching));
902 m_highlightedBracketColorSet = true;
903
904 m_wordWrapMarkerColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::WordWrapMarker));
905 m_wordWrapMarkerColorSet = true;
906
907 m_tabMarkerColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::TabMarker));
908 m_tabMarkerColorSet = true;
909
910 m_indentationLineColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::IndentationLine));
911 m_indentationLineColorSet = true;
912
913 m_iconBarColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::IconBorder));
914 m_iconBarColorSet = true;
915
916 m_foldingColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::CodeFolding));
917 m_foldingColorSet = true;
918
919 m_lineNumberColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::LineNumbers));
920 m_lineNumberColorSet = true;
921
922 m_currentLineNumberColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::CurrentLineNumber));
923 m_currentLineNumberColorSet = true;
924
925 m_separatorColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::Separator));
926 m_separatorColorSet = true;
927
928 m_spellingMistakeLineColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::SpellChecking));
929 m_spellingMistakeLineColorSet = true;
930
931 m_modifiedLineColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::ModifiedLines));
932 m_modifiedLineColorSet = true;
933
934 m_savedLineColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::SavedLines));
935 m_savedLineColorSet = true;
936
937 m_searchHighlightColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::SearchHighlight));
938 m_searchHighlightColorSet = true;
939
940 m_replaceHighlightColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::ReplaceHighlight));
941 m_replaceHighlightColorSet = true;
942
944 QColor col =
946 m_lineMarkerColorSet[i] = true;
947 m_lineMarkerColor[i] = col;
948 }
949
950 m_templateBackgroundColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::TemplateBackground));
951
952 m_templateFocusedEditablePlaceholderColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::TemplateFocusedPlaceholder));
953
954 m_templateEditablePlaceholderColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::TemplatePlaceholder));
955
956 m_templateNotEditablePlaceholderColor = QColor::fromRgba(theme.editorColor(KSyntaxHighlighting::Theme::TemplateReadOnlyPlaceholder));
957
958 m_templateColorsSet = true;
959}
960
961const QFont &KateRendererConfig::baseFont() const
962{
963 if (m_fontSet || isGlobal()) {
964 return m_font;
965 }
966
967 return s_global->baseFont();
968}
969
970void KateRendererConfig::setFont(const QFont &font)
971{
972 if (m_fontSet && m_font == font) {
973 return;
974 }
975
976 configStart();
977 m_font = font;
978 m_fontSet = true;
979 configEnd();
980}
981
982bool KateRendererConfig::wordWrapMarker() const
983{
984 if (m_wordWrapMarkerSet || isGlobal()) {
985 return m_wordWrapMarker;
986 }
987
988 return s_global->wordWrapMarker();
989}
990
991void KateRendererConfig::setWordWrapMarker(bool on)
992{
993 if (m_wordWrapMarkerSet && m_wordWrapMarker == on) {
994 return;
995 }
996
997 configStart();
998
999 m_wordWrapMarkerSet = true;
1000 m_wordWrapMarker = on;
1001
1002 configEnd();
1003}
1004
1005const QColor &KateRendererConfig::backgroundColor() const
1006{
1007 if (m_backgroundColorSet || isGlobal()) {
1008 return m_backgroundColor;
1009 }
1010
1011 return s_global->backgroundColor();
1012}
1013
1014void KateRendererConfig::setBackgroundColor(const QColor &col)
1015{
1016 if (m_backgroundColorSet && m_backgroundColor == col) {
1017 return;
1018 }
1019
1020 configStart();
1021
1022 m_backgroundColorSet = true;
1023 m_backgroundColor = col;
1024
1025 configEnd();
1026}
1027
1028const QColor &KateRendererConfig::selectionColor() const
1029{
1030 if (m_selectionColorSet || isGlobal()) {
1031 return m_selectionColor;
1032 }
1033
1034 return s_global->selectionColor();
1035}
1036
1037void KateRendererConfig::setSelectionColor(const QColor &col)
1038{
1039 if (m_selectionColorSet && m_selectionColor == col) {
1040 return;
1041 }
1042
1043 configStart();
1044
1045 m_selectionColorSet = true;
1046 m_selectionColor = col;
1047
1048 configEnd();
1049}
1050
1051const QColor &KateRendererConfig::highlightedLineColor() const
1052{
1053 if (m_highlightedLineColorSet || isGlobal()) {
1054 return m_highlightedLineColor;
1055 }
1056
1057 return s_global->highlightedLineColor();
1058}
1059
1060void KateRendererConfig::setHighlightedLineColor(const QColor &col)
1061{
1062 if (m_highlightedLineColorSet && m_highlightedLineColor == col) {
1063 return;
1064 }
1065
1066 configStart();
1067
1068 m_highlightedLineColorSet = true;
1069 m_highlightedLineColor = col;
1070
1071 configEnd();
1072}
1073
1074const QColor &KateRendererConfig::lineMarkerColor(KTextEditor::Document::MarkTypes type) const
1075{
1076 int index = 0;
1077 if (type > 0) {
1078 while ((type >> index++) ^ 1) { }
1079 }
1080 index -= 1;
1081
1082 if (index < 0 || index >= KTextEditor::Document::reservedMarkersCount()) {
1083 static QColor dummy;
1084 return dummy;
1085 }
1086
1087 if (m_lineMarkerColorSet[index] || isGlobal()) {
1088 return m_lineMarkerColor[index];
1089 }
1090
1091 return s_global->lineMarkerColor(type);
1092}
1093
1094const QColor &KateRendererConfig::highlightedBracketColor() const
1095{
1096 if (m_highlightedBracketColorSet || isGlobal()) {
1097 return m_highlightedBracketColor;
1098 }
1099
1100 return s_global->highlightedBracketColor();
1101}
1102
1103void KateRendererConfig::setHighlightedBracketColor(const QColor &col)
1104{
1105 if (m_highlightedBracketColorSet && m_highlightedBracketColor == col) {
1106 return;
1107 }
1108
1109 configStart();
1110
1111 m_highlightedBracketColorSet = true;
1112 m_highlightedBracketColor = col;
1113
1114 configEnd();
1115}
1116
1117const QColor &KateRendererConfig::wordWrapMarkerColor() const
1118{
1119 if (m_wordWrapMarkerColorSet || isGlobal()) {
1120 return m_wordWrapMarkerColor;
1121 }
1122
1123 return s_global->wordWrapMarkerColor();
1124}
1125
1126void KateRendererConfig::setWordWrapMarkerColor(const QColor &col)
1127{
1128 if (m_wordWrapMarkerColorSet && m_wordWrapMarkerColor == col) {
1129 return;
1130 }
1131
1132 configStart();
1133
1134 m_wordWrapMarkerColorSet = true;
1135 m_wordWrapMarkerColor = col;
1136
1137 configEnd();
1138}
1139
1140const QColor &KateRendererConfig::tabMarkerColor() const
1141{
1142 if (m_tabMarkerColorSet || isGlobal()) {
1143 return m_tabMarkerColor;
1144 }
1145
1146 return s_global->tabMarkerColor();
1147}
1148
1149void KateRendererConfig::setTabMarkerColor(const QColor &col)
1150{
1151 if (m_tabMarkerColorSet && m_tabMarkerColor == col) {
1152 return;
1153 }
1154
1155 configStart();
1156
1157 m_tabMarkerColorSet = true;
1158 m_tabMarkerColor = col;
1159
1160 configEnd();
1161}
1162
1163const QColor &KateRendererConfig::indentationLineColor() const
1164{
1165 if (m_indentationLineColorSet || isGlobal()) {
1166 return m_indentationLineColor;
1167 }
1168
1169 return s_global->indentationLineColor();
1170}
1171
1172void KateRendererConfig::setIndentationLineColor(const QColor &col)
1173{
1174 if (m_indentationLineColorSet && m_indentationLineColor == col) {
1175 return;
1176 }
1177
1178 configStart();
1179
1180 m_indentationLineColorSet = true;
1181 m_indentationLineColor = col;
1182
1183 configEnd();
1184}
1185
1186const QColor &KateRendererConfig::iconBarColor() const
1187{
1188 if (m_iconBarColorSet || isGlobal()) {
1189 return m_iconBarColor;
1190 }
1191
1192 return s_global->iconBarColor();
1193}
1194
1195void KateRendererConfig::setIconBarColor(const QColor &col)
1196{
1197 if (m_iconBarColorSet && m_iconBarColor == col) {
1198 return;
1199 }
1200
1201 configStart();
1202
1203 m_iconBarColorSet = true;
1204 m_iconBarColor = col;
1205
1206 configEnd();
1207}
1208
1209const QColor &KateRendererConfig::foldingColor() const
1210{
1211 if (m_foldingColorSet || isGlobal()) {
1212 return m_foldingColor;
1213 }
1214
1215 return s_global->foldingColor();
1216}
1217
1218void KateRendererConfig::setFoldingColor(const QColor &col)
1219{
1220 if (m_foldingColorSet && m_foldingColor == col) {
1221 return;
1222 }
1223
1224 configStart();
1225
1226 m_foldingColorSet = true;
1227 m_foldingColor = col;
1228
1229 configEnd();
1230}
1231
1232const QColor &KateRendererConfig::templateBackgroundColor() const
1233{
1234 if (m_templateColorsSet || isGlobal()) {
1235 return m_templateBackgroundColor;
1236 }
1237
1238 return s_global->templateBackgroundColor();
1239}
1240
1241const QColor &KateRendererConfig::templateEditablePlaceholderColor() const
1242{
1243 if (m_templateColorsSet || isGlobal()) {
1244 return m_templateEditablePlaceholderColor;
1245 }
1246
1247 return s_global->templateEditablePlaceholderColor();
1248}
1249
1250const QColor &KateRendererConfig::templateFocusedEditablePlaceholderColor() const
1251{
1252 if (m_templateColorsSet || isGlobal()) {
1253 return m_templateFocusedEditablePlaceholderColor;
1254 }
1255
1256 return s_global->templateFocusedEditablePlaceholderColor();
1257}
1258
1259const QColor &KateRendererConfig::templateNotEditablePlaceholderColor() const
1260{
1261 if (m_templateColorsSet || isGlobal()) {
1262 return m_templateNotEditablePlaceholderColor;
1263 }
1264
1265 return s_global->templateNotEditablePlaceholderColor();
1266}
1267
1268const QColor &KateRendererConfig::lineNumberColor() const
1269{
1270 if (m_lineNumberColorSet || isGlobal()) {
1271 return m_lineNumberColor;
1272 }
1273
1274 return s_global->lineNumberColor();
1275}
1276
1277void KateRendererConfig::setLineNumberColor(const QColor &col)
1278{
1279 if (m_lineNumberColorSet && m_lineNumberColor == col) {
1280 return;
1281 }
1282
1283 configStart();
1284
1285 m_lineNumberColorSet = true;
1286 m_lineNumberColor = col;
1287
1288 configEnd();
1289}
1290
1291const QColor &KateRendererConfig::currentLineNumberColor() const
1292{
1293 if (m_currentLineNumberColorSet || isGlobal()) {
1294 return m_currentLineNumberColor;
1295 }
1296
1297 return s_global->currentLineNumberColor();
1298}
1299
1300void KateRendererConfig::setCurrentLineNumberColor(const QColor &col)
1301{
1302 if (m_currentLineNumberColorSet && m_currentLineNumberColor == col) {
1303 return;
1304 }
1305
1306 configStart();
1307
1308 m_currentLineNumberColorSet = true;
1309 m_currentLineNumberColor = col;
1310
1311 configEnd();
1312}
1313
1314const QColor &KateRendererConfig::separatorColor() const
1315{
1316 if (m_separatorColorSet || isGlobal()) {
1317 return m_separatorColor;
1318 }
1319
1320 return s_global->separatorColor();
1321}
1322
1323void KateRendererConfig::setSeparatorColor(const QColor &col)
1324{
1325 if (m_separatorColorSet && m_separatorColor == col) {
1326 return;
1327 }
1328
1329 configStart();
1330
1331 m_separatorColorSet = true;
1332 m_separatorColor = col;
1333
1334 configEnd();
1335}
1336
1337const QColor &KateRendererConfig::spellingMistakeLineColor() const
1338{
1339 if (m_spellingMistakeLineColorSet || isGlobal()) {
1340 return m_spellingMistakeLineColor;
1341 }
1342
1343 return s_global->spellingMistakeLineColor();
1344}
1345
1346void KateRendererConfig::setSpellingMistakeLineColor(const QColor &col)
1347{
1348 if (m_spellingMistakeLineColorSet && m_spellingMistakeLineColor == col) {
1349 return;
1350 }
1351
1352 configStart();
1353
1354 m_spellingMistakeLineColorSet = true;
1355 m_spellingMistakeLineColor = col;
1356
1357 configEnd();
1358}
1359
1360const QColor &KateRendererConfig::modifiedLineColor() const
1361{
1362 if (m_modifiedLineColorSet || isGlobal()) {
1363 return m_modifiedLineColor;
1364 }
1365
1366 return s_global->modifiedLineColor();
1367}
1368
1369void KateRendererConfig::setModifiedLineColor(const QColor &col)
1370{
1371 if (m_modifiedLineColorSet && m_modifiedLineColor == col) {
1372 return;
1373 }
1374
1375 configStart();
1376
1377 m_modifiedLineColorSet = true;
1378 m_modifiedLineColor = col;
1379
1380 configEnd();
1381}
1382
1383const QColor &KateRendererConfig::savedLineColor() const
1384{
1385 if (m_savedLineColorSet || isGlobal()) {
1386 return m_savedLineColor;
1387 }
1388
1389 return s_global->savedLineColor();
1390}
1391
1392void KateRendererConfig::setSavedLineColor(const QColor &col)
1393{
1394 if (m_savedLineColorSet && m_savedLineColor == col) {
1395 return;
1396 }
1397
1398 configStart();
1399
1400 m_savedLineColorSet = true;
1401 m_savedLineColor = col;
1402
1403 configEnd();
1404}
1405
1406const QColor &KateRendererConfig::searchHighlightColor() const
1407{
1408 if (m_searchHighlightColorSet || isGlobal()) {
1409 return m_searchHighlightColor;
1410 }
1411
1412 return s_global->searchHighlightColor();
1413}
1414
1415void KateRendererConfig::setSearchHighlightColor(const QColor &col)
1416{
1417 if (m_searchHighlightColorSet && m_searchHighlightColor == col) {
1418 return;
1419 }
1420
1421 configStart();
1422
1423 m_searchHighlightColorSet = true;
1424 m_searchHighlightColor = col;
1425
1426 configEnd();
1427}
1428
1429const QColor &KateRendererConfig::replaceHighlightColor() const
1430{
1431 if (m_replaceHighlightColorSet || isGlobal()) {
1432 return m_replaceHighlightColor;
1433 }
1434
1435 return s_global->replaceHighlightColor();
1436}
1437
1438void KateRendererConfig::setReplaceHighlightColor(const QColor &col)
1439{
1440 if (m_replaceHighlightColorSet && m_replaceHighlightColor == col) {
1441 return;
1442 }
1443
1444 configStart();
1445
1446 m_replaceHighlightColorSet = true;
1447 m_replaceHighlightColor = col;
1448
1449 configEnd();
1450}
1451
1452void KateRendererConfig::setLineHeightMultiplier(qreal value)
1453{
1454 configStart();
1455 m_lineHeightMultiplier = value;
1456 configEnd();
1457}
1458
1459bool KateRendererConfig::showIndentationLines() const
1460{
1461 if (m_showIndentationLinesSet || isGlobal()) {
1462 return m_showIndentationLines;
1463 }
1464
1465 return s_global->showIndentationLines();
1466}
1467
1468void KateRendererConfig::setShowIndentationLines(bool on)
1469{
1470 if (m_showIndentationLinesSet && m_showIndentationLines == on) {
1471 return;
1472 }
1473
1474 configStart();
1475
1476 m_showIndentationLinesSet = true;
1477 m_showIndentationLines = on;
1478
1479 configEnd();
1480}
1481
1482bool KateRendererConfig::showWholeBracketExpression() const
1483{
1484 if (m_showWholeBracketExpressionSet || isGlobal()) {
1485 return m_showWholeBracketExpression;
1486 }
1487
1488 return s_global->showWholeBracketExpression();
1489}
1490
1491void KateRendererConfig::setShowWholeBracketExpression(bool on)
1492{
1493 if (m_showWholeBracketExpressionSet && m_showWholeBracketExpression == on) {
1494 return;
1495 }
1496
1497 configStart();
1498
1499 m_showWholeBracketExpressionSet = true;
1500 m_showWholeBracketExpression = on;
1501
1502 configEnd();
1503}
1504
1505bool KateRendererConfig::animateBracketMatching()
1506{
1507 return s_global->m_animateBracketMatching;
1508}
1509
1510void KateRendererConfig::setAnimateBracketMatching(bool on)
1511{
1512 if (!isGlobal()) {
1513 s_global->setAnimateBracketMatching(on);
1514 } else if (on != m_animateBracketMatching) {
1515 configStart();
1516 m_animateBracketMatching = on;
1517 configEnd();
1518 }
1519}
1520
1521// END
void deleteEntry(const char *key, WriteConfigFlags pFlags=Normal)
void writeEntry(const char *key, const char *value, WriteConfigFlags pFlags=Normal)
QString readEntry(const char *key, const char *aDefault=nullptr) const
Theme themeForPalette(const QPalette &palette) const
Q_INVOKABLE KSyntaxHighlighting::Theme theme(const QString &themeName) const
Backend of KTextEditor::Document related public KTextEditor interfaces.
MarkTypes
Predefined mark types.
Definition document.h:1557
@ markType01
Bookmark.
Definition document.h:1559
static int reservedMarkersCount()
Get the number of predefined mark types we have so far.
Definition document.h:1546
static KSharedConfigPtr config()
The global configuration of katepart, e.g.
void triggerConfigChanged()
Trigger delayed emission of config changed.
static KTextEditor::EditorPrivate * self()
Kate Part Internal stuff ;)
QList< KTextEditor::Document * > documents() override
Returns a list of all documents of this editor.
Definition kateglobal.h:99
One config entry.
Definition kateconfig.h:140
Base Class for the Kate Config Classes Current childs are KateDocumentConfig/KateDocumentConfig/KateD...
Definition kateconfig.h:47
bool isGlobal() const
Is this a global config object?
Definition kateconfig.h:66
KateConfig(const KateConfig *parent=nullptr)
Construct a KateConfig.
virtual ~KateConfig()
Virtual Destructor.
int configSessionNumber
recursion depth
Definition kateconfig.h:272
void writeConfigEntries(KConfigGroup &config) const
Write all config entries to given config group.
void configEnd()
End a config change transaction, update the concerned KateDocumentConfig/KateDocumentConfig/KateDocum...
void readConfigEntries(const KConfigGroup &config)
Read all config entries from given config group.
void finalizeConfigEntries()
Finalize the config entries.
void configStart()
Start some config changes.
bool setValue(const int key, const QVariant &value)
Set a config value.
QVariant value(const int key) const
Get a config value.
virtual void updateConfig()=0
do the real update
void addConfigEntry(ConfigEntry &&entry)
Register a new config entry.
Handles all of the work of rendering the text (used for the views and printing)
void updateConfig()
Configuration.
QString identify(const QString &text, const QStringList &suggestions=QStringList()) const
void setLanguage(const QString &lang)
KIOCORE_EXPORT QString number(KIO::filesize_t size)
bool isValid(QStringView ifopt)
std::vector< Feature > features(QStringView coachNumber, QStringView coachClassification)
QString name(StandardAction id)
The KTextEditor namespace contains all the public API that is required to use the KTextEditor compone...
const char * constData() const const
QColor fromRgba(QRgb rgba)
QFont systemFont(SystemFont type)
QString fromUtf8(QByteArrayView str)
QString number(double n, char format, int precision)
int toInt(bool *ok, int base) const const
QByteArray toUtf8() const const
bool isValid() const const
const char * nameForEncoding(Encoding e)
AltModifier
SkipEmptyParts
int toInt(bool *ok) const const
QString toString() const const
uint toUInt(bool *ok) const const
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 20 2024 11:56:00 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.