1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/*
SPDX-FileCopyrightText: 2009 Milian Wolff <mail@milianw.de>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KDEVPLATFORM_COLORCACHE_H
#define KDEVPLATFORM_COLORCACHE_H
#include <QObject>
#include <QVector>
#include <QColor>
#include <QPointer>
#include <KSyntaxHighlighting/Repository>
#include <interfaces/icompletionsettings.h>
#include <language/languageexport.h>
namespace KSyntaxHighlighting {
class Theme;
}
namespace KTextEditor {
class Document;
class View;
}
namespace KDevelop {
class ConfigurableHighlightingColors;
class IDocument;
/**
* A singleton which holds the global default colors, adapted to the current color scheme
*/
class KDEVPLATFORMLANGUAGE_EXPORT ColorCache
: public QObject
{
Q_OBJECT
public:
~ColorCache() override;
/// access the global color cache
static ColorCache* self();
/// adapt a given foreground color to the current color scheme
/// @p ratio between 0 and 255 where 0 gives @see m_foregroundColor
/// and 255 gives @p color
///
/// @note if you are looking for a background color, simply setting an alpha
/// value should work.
QColor blend(QColor color, uchar ratio) const;
/// adapt a given background color to the current color scheme
/// @p ratio between 0 and 255 where 0 gives @see m_foregroundColor
/// and 255 gives @p color
///
/// @note if you are looking for a background color, simply setting an alpha
/// value should work.
QColor blendBackground(QColor color, uchar ratio) const;
/// blend a color for local colorization according to the user settings
/// @see blend()
QColor blendLocalColor(QColor color) const;
/// blend a color for global colorization according to the user settings
/// @see blend()
QColor blendGlobalColor(QColor color) const;
/// access the default colors
ConfigurableHighlightingColors* defaultColors() const;
/**
* @returns a primary color if @p num less primaryColorCount and a supplementary color if @p num >= primaryColorCount and < validColorCount
* @see validColorCount()
* @see primaryColorCount()
*/
QColor generatedColor(uint num) const;
/**
* @returns the number of primary and supplementary colors
*
* @see generatedColor()
* @see primaryColorCount()
*/
uint validColorCount() const;
/**
* @returns number of primary colors
*
* When you run out of primary colors use supplementary colors
*/
uint primaryColorCount() const;
/// access the foreground color
QColor foregroundColor() const;
Q_SIGNALS:
/// will be emitted whenever the colors got changed
/// @see update()
void colorsGotChanged();
private Q_SLOTS:
/// if necessary, adapt to the colors of this document
void slotDocumentActivated();
/// settings got changed, update to the settings of the sender
void slotViewSettingsChanged();
/// will regenerate colors from global KDE color scheme
void updateColorsFromScheme();
/// will regenerate colors with the proper intensity settings
void updateColorsFromSettings();
/// regenerate colors and emits @p colorsGotChanged()
/// and finally triggers a rehighlight of the opened documents
void updateInternal();
bool tryActiveDocument();
private:
explicit ColorCache(QObject* parent = nullptr);
static ColorCache* m_self;
/// get @p totalGeneratedColors colors from the color wheel and adapt them to the current color scheme
void generateColors();
/// calls @c updateInternal() delayed to prevent double loading of language plugins.
void update();
/// try to access the KatePart settings for the given doc or fallback to the global KDE scheme
/// and update the colors if necessary
/// @see generateColors(), updateColorsFromScheme()
void updateColorsFromView(KTextEditor::View* view);
bool updateColorsFromTheme(const KSyntaxHighlighting::Theme& theme);
void updateDefaultColorsFromSource();
/// the default colors for the different types
ConfigurableHighlightingColors* m_defaultColors;
/// the generated colors
QVector<QColor> m_colors;
uint m_validColorCount;
uint m_primaryColorCount;
/// Maybe make this configurable: An offset where to start stepping through the color wheel
uint m_colorOffset;
/// the text color for the current color scheme
QColor m_foregroundColor;
/// the editor background color for the current color scheme
QColor m_backgroundColor;
/// How generated colors for local variables should be mixed with the foreground color.
/// Between 0 and 255, where 255 means only foreground color, and 0 only the chosen color.
uchar m_localColorRatio;
/// How global colors (i.e. for types, uses, etc.) should be mixed with the foreground color.
/// Between 0 and 255, where 255 means only foreground color, and 0 only the chosen color.
uchar m_globalColorRatio;
ICompletionSettings::GlobalColorSource m_globalColorSource;
/// Whether declarations have to be rendered with a bold style or not.
bool m_boldDeclarations;
/// The view we are listening to for setting changes.
QPointer<KTextEditor::View> m_view;
KSyntaxHighlighting::Repository m_schemeRepo;
};
}
#endif // KDEVPLATFORM_COLORCACHE_H
|
