aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/user/README.md13
-rw-r--r--editors/code/package.json65
-rw-r--r--editors/code/src/config.ts14
-rw-r--r--editors/code/src/highlighting.ts62
-rw-r--r--editors/code/src/scopes.ts146
-rw-r--r--editors/code/src/scopes_mapper.ts79
6 files changed, 365 insertions, 14 deletions
diff --git a/docs/user/README.md b/docs/user/README.md
index 9cdabfd42..968d2e34c 100644
--- a/docs/user/README.md
+++ b/docs/user/README.md
@@ -87,7 +87,16 @@ host.
87 87
88### Settings 88### Settings
89 89
90* `rust-analyzer.highlightingOn`: enables experimental syntax highlighting 90* `rust-analyzer.highlightingOn`: enables experimental syntax highlighting.
91* `rust-analyzer.scopeMappings` -- a scheme backed JSON object to tweak Rust Analyzer scopes to TextMate scopes.
92 ```jsonc
93 {
94 //Will autocomplete keys to available RA scopes.
95 "keyword.unsafe": ["keyword", "keyword.control"],
96 //Values are string | TextMateScope | [string | TextMateScope]
97 "variable.mut": "variable"
98 }
99 ```
91* `rust-analyzer.enableEnhancedTyping`: by default, rust-analyzer intercepts 100* `rust-analyzer.enableEnhancedTyping`: by default, rust-analyzer intercepts
92 `Enter` key to make it easier to continue comments. Note that it may conflict with VIM emulation plugin. 101 `Enter` key to make it easier to continue comments. Note that it may conflict with VIM emulation plugin.
93* `rust-analyzer.raLspServerPath`: path to `ra_lsp_server` executable 102* `rust-analyzer.raLspServerPath`: path to `ra_lsp_server` executable
@@ -106,7 +115,7 @@ host.
106* `rust-analyzer.trace.cargo-watch`: enables cargo-watch logging 115* `rust-analyzer.trace.cargo-watch`: enables cargo-watch logging
107* `RUST_SRC_PATH`: environment variable that overwrites the sysroot 116* `RUST_SRC_PATH`: environment variable that overwrites the sysroot
108* `rust-analyzer.featureFlags` -- a JSON object to tweak fine-grained behavior: 117* `rust-analyzer.featureFlags` -- a JSON object to tweak fine-grained behavior:
109 ```js 118 ```jsonc
110 { 119 {
111 // Show diagnostics produced by rust-analyzer itself. 120 // Show diagnostics produced by rust-analyzer itself.
112 "lsp.diagnostics": true, 121 "lsp.diagnostics": true,
diff --git a/editors/code/package.json b/editors/code/package.json
index f75fafeb9..8e7046418 100644
--- a/editors/code/package.json
+++ b/editors/code/package.json
@@ -34,7 +34,8 @@
34 "dependencies": { 34 "dependencies": {
35 "lookpath": "^1.0.4", 35 "lookpath": "^1.0.4",
36 "seedrandom": "^3.0.5", 36 "seedrandom": "^3.0.5",
37 "vscode-languageclient": "^6.0.0-next.9" 37 "vscode-languageclient": "^6.0.0-next.9",
38 "jsonc-parser": "^2.1.0"
38 }, 39 },
39 "devDependencies": { 40 "devDependencies": {
40 "@types/glob": "^7.1.1", 41 "@types/glob": "^7.1.1",
@@ -176,6 +177,68 @@
176 "default": false, 177 "default": false,
177 "description": "Highlight Rust code (overrides built-in syntax highlighting)" 178 "description": "Highlight Rust code (overrides built-in syntax highlighting)"
178 }, 179 },
180 "rust-analyzer.scopeMappings": {
181 "type": "object",
182 "definitions": {},
183 "properties": {
184 "comment": {
185 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
186 },
187 "string": {
188 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
189 },
190 "keyword": {
191 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
192 },
193 "keyword.control": {
194 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
195 },
196 "keyword.unsafe": {
197 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
198 },
199 "function": {
200 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
201 },
202 "parameter": {
203 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
204 },
205 "constant": {
206 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
207 },
208 "type": {
209 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
210 },
211 "builtin": {
212 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
213 },
214 "text": {
215 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
216 },
217 "attribute": {
218 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
219 },
220 "literal": {
221 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
222 },
223 "macro": {
224 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
225 },
226 "variable": {
227 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
228 },
229 "variable.mut": {
230 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
231 },
232 "field": {
233 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
234 },
235 "module": {
236 "$ref": "vscode://schemas/textmate-colors#/items/properties/scope"
237 }
238 },
239 "additionalProperties": false,
240 "description": "Mapping Rust Analyzer scopes to TextMateRule scopes list."
241 },
179 "rust-analyzer.rainbowHighlightingOn": { 242 "rust-analyzer.rainbowHighlightingOn": {
180 "type": "boolean", 243 "type": "boolean",
181 "default": false, 244 "default": false,
diff --git a/editors/code/src/config.ts b/editors/code/src/config.ts
index e131f09df..c06dddb1c 100644
--- a/editors/code/src/config.ts
+++ b/editors/code/src/config.ts
@@ -1,5 +1,6 @@
1import * as vscode from 'vscode'; 1import * as vscode from 'vscode';
2 2import * as scopes from './scopes';
3import * as scopesMapper from './scopes_mapper';
3import { Server } from './server'; 4import { Server } from './server';
4 5
5const RA_LSP_DEBUG = process.env.__RA_LSP_SERVER_DEBUG; 6const RA_LSP_DEBUG = process.env.__RA_LSP_SERVER_DEBUG;
@@ -61,10 +62,17 @@ export class Config {
61 62
62 public userConfigChanged() { 63 public userConfigChanged() {
63 const config = vscode.workspace.getConfiguration('rust-analyzer'); 64 const config = vscode.workspace.getConfiguration('rust-analyzer');
65
66 Server.highlighter.removeHighlights();
67
64 let requireReloadMessage = null; 68 let requireReloadMessage = null;
65 69
66 if (config.has('highlightingOn')) { 70 if (config.has('highlightingOn')) {
67 this.highlightingOn = config.get('highlightingOn') as boolean; 71 this.highlightingOn = config.get('highlightingOn') as boolean;
72 if (this.highlightingOn) {
73 scopes.load();
74 scopesMapper.load();
75 }
68 } 76 }
69 77
70 if (config.has('rainbowHighlightingOn')) { 78 if (config.has('rainbowHighlightingOn')) {
@@ -73,10 +81,6 @@ export class Config {
73 ) as boolean; 81 ) as boolean;
74 } 82 }
75 83
76 if (!this.highlightingOn && Server) {
77 Server.highlighter.removeHighlights();
78 }
79
80 if (config.has('enableEnhancedTyping')) { 84 if (config.has('enableEnhancedTyping')) {
81 this.enableEnhancedTyping = config.get( 85 this.enableEnhancedTyping = config.get(
82 'enableEnhancedTyping', 86 'enableEnhancedTyping',
diff --git a/editors/code/src/highlighting.ts b/editors/code/src/highlighting.ts
index e1b0d13e7..68eae0941 100644
--- a/editors/code/src/highlighting.ts
+++ b/editors/code/src/highlighting.ts
@@ -1,6 +1,8 @@
1import seedrandom = require('seedrandom'); 1import seedrandom = require('seedrandom');
2import * as vscode from 'vscode'; 2import * as vscode from 'vscode';
3import * as lc from 'vscode-languageclient'; 3import * as lc from 'vscode-languageclient';
4import * as scopes from './scopes';
5import * as scopesMapper from './scopes_mapper';
4 6
5import { Server } from './server'; 7import { Server } from './server';
6 8
@@ -23,6 +25,41 @@ function fancify(seed: string, shade: 'light' | 'dark') {
23 return `hsl(${h},${s}%,${l}%)`; 25 return `hsl(${h},${s}%,${l}%)`;
24} 26}
25 27
28function createDecorationFromTextmate(
29 themeStyle: scopes.TextMateRuleSettings
30): vscode.TextEditorDecorationType {
31 const decorationOptions: vscode.DecorationRenderOptions = {};
32 decorationOptions.rangeBehavior = vscode.DecorationRangeBehavior.OpenOpen;
33
34 if (themeStyle.foreground) {
35 decorationOptions.color = themeStyle.foreground;
36 }
37
38 if (themeStyle.background) {
39 decorationOptions.backgroundColor = themeStyle.background;
40 }
41
42 if (themeStyle.fontStyle) {
43 const parts: string[] = themeStyle.fontStyle.split(' ');
44 parts.forEach(part => {
45 switch (part) {
46 case 'italic':
47 decorationOptions.fontStyle = 'italic';
48 break;
49 case 'bold':
50 decorationOptions.fontWeight = 'bold';
51 break;
52 case 'underline':
53 decorationOptions.textDecoration = 'underline';
54 break;
55 default:
56 break;
57 }
58 });
59 }
60 return vscode.window.createTextEditorDecorationType(decorationOptions);
61}
62
26export class Highlighter { 63export class Highlighter {
27 private static initDecorations(): Map< 64 private static initDecorations(): Map<
28 string, 65 string,
@@ -32,12 +69,25 @@ export class Highlighter {
32 tag: string, 69 tag: string,
33 textDecoration?: string, 70 textDecoration?: string,
34 ): [string, vscode.TextEditorDecorationType] => { 71 ): [string, vscode.TextEditorDecorationType] => {
35 const color = new vscode.ThemeColor('ralsp.' + tag); 72 const rule = scopesMapper.toRule(tag, scopes.find);
36 const decor = vscode.window.createTextEditorDecorationType({ 73
37 color, 74 if (rule) {
38 textDecoration, 75 const decor = createDecorationFromTextmate(rule);
39 }); 76 return [tag, decor];
40 return [tag, decor]; 77 } else {
78 const fallBackTag = 'ralsp.' + tag;
79 // console.log(' ');
80 // console.log('Missing theme for: <"' + tag + '"> for following mapped scopes:');
81 // console.log(scopesMapper.find(tag));
82 // console.log('Falling back to values defined in: ' + fallBackTag);
83 // console.log(' ');
84 const color = new vscode.ThemeColor(fallBackTag);
85 const decor = vscode.window.createTextEditorDecorationType({
86 color,
87 textDecoration
88 });
89 return [tag, decor];
90 }
41 }; 91 };
42 92
43 const decorations: Iterable<[ 93 const decorations: Iterable<[
diff --git a/editors/code/src/scopes.ts b/editors/code/src/scopes.ts
new file mode 100644
index 000000000..8f288d761
--- /dev/null
+++ b/editors/code/src/scopes.ts
@@ -0,0 +1,146 @@
1import * as fs from 'fs';
2import * as jsonc from 'jsonc-parser';
3import * as path from 'path';
4import * as vscode from 'vscode';
5
6export interface TextMateRule {
7 scope: string | string[];
8 settings: TextMateRuleSettings;
9}
10
11export interface TextMateRuleSettings {
12 foreground: string | undefined;
13 background: string | undefined;
14 fontStyle: string | undefined;
15}
16
17// Current theme colors
18const rules = new Map<string, TextMateRuleSettings>();
19
20export function find(scope: string): TextMateRuleSettings | undefined {
21 return rules.get(scope);
22}
23
24// Load all textmate scopes in the currently active theme
25export function load() {
26 // Remove any previous theme
27 rules.clear();
28 // Find out current color theme
29 const themeName = vscode.workspace
30 .getConfiguration('workbench')
31 .get('colorTheme');
32
33 if (typeof themeName !== 'string') {
34 // console.warn('workbench.colorTheme is', themeName)
35 return;
36 }
37 // Try to load colors from that theme
38 try {
39 loadThemeNamed(themeName);
40 } catch (e) {
41 // console.warn('failed to load theme', themeName, e)
42 }
43}
44
45function filterThemeExtensions(extension: vscode.Extension<any>): boolean {
46 return (
47 extension.extensionKind === vscode.ExtensionKind.UI &&
48 extension.packageJSON.contributes &&
49 extension.packageJSON.contributes.themes
50 );
51}
52
53// Find current theme on disk
54function loadThemeNamed(themeName: string) {
55 const themePaths = vscode.extensions.all
56 .filter(filterThemeExtensions)
57 .reduce((list, extension) => {
58 return extension.packageJSON.contributes.themes
59 .filter(
60 (element: any) =>
61 (element.id || element.label) === themeName
62 )
63 .map((element: any) =>
64 path.join(extension.extensionPath, element.path)
65 )
66 .concat(list);
67 }, Array<string>());
68
69 themePaths.forEach(loadThemeFile);
70
71 const tokenColorCustomizations: [any] = [
72 vscode.workspace
73 .getConfiguration('editor')
74 .get('tokenColorCustomizations')
75 ];
76
77 tokenColorCustomizations
78 .filter(custom => custom && custom.textMateRules)
79 .map(custom => custom.textMateRules)
80 .forEach(loadColors);
81}
82
83function loadThemeFile(themePath: string) {
84 const themeContent = [themePath]
85 .filter(isFile)
86 .map(readFileText)
87 .map(parseJSON)
88 .filter(theme => theme);
89
90 themeContent
91 .filter(theme => theme.tokenColors)
92 .map(theme => theme.tokenColors)
93 .forEach(loadColors);
94
95 themeContent
96 .filter(theme => theme.include)
97 .map(theme => path.join(path.dirname(themePath), theme.include))
98 .forEach(loadThemeFile);
99}
100
101function mergeRuleSettings(
102 defaultSetting: TextMateRuleSettings | undefined,
103 override: TextMateRuleSettings
104): TextMateRuleSettings {
105 if (defaultSetting === undefined) {
106 return override;
107 }
108 const mergedRule = defaultSetting;
109
110 mergedRule.background = override.background || defaultSetting.background;
111 mergedRule.foreground = override.foreground || defaultSetting.foreground;
112 mergedRule.fontStyle = override.fontStyle || defaultSetting.foreground;
113
114 return mergedRule;
115}
116
117function updateRules(
118 scope: string,
119 updatedSettings: TextMateRuleSettings
120): void {
121 [rules.get(scope)]
122 .map(settings => mergeRuleSettings(settings, updatedSettings))
123 .forEach(settings => rules.set(scope, settings));
124}
125
126function loadColors(textMateRules: TextMateRule[]): void {
127 textMateRules.forEach(rule => {
128 if (typeof rule.scope === 'string') {
129 updateRules(rule.scope, rule.settings);
130 } else if (rule.scope instanceof Array) {
131 rule.scope.forEach(scope => updateRules(scope, rule.settings));
132 }
133 });
134}
135
136function isFile(filePath: string): boolean {
137 return [filePath].map(fs.statSync).every(stat => stat.isFile());
138}
139
140function readFileText(filePath: string): string {
141 return fs.readFileSync(filePath, 'utf8');
142}
143
144function parseJSON(content: string): any {
145 return jsonc.parse(content);
146}
diff --git a/editors/code/src/scopes_mapper.ts b/editors/code/src/scopes_mapper.ts
new file mode 100644
index 000000000..85c791ff5
--- /dev/null
+++ b/editors/code/src/scopes_mapper.ts
@@ -0,0 +1,79 @@
1import * as vscode from 'vscode';
2import { TextMateRuleSettings } from './scopes';
3
4let mappings = new Map<string, string[]>();
5
6const defaultMapping = new Map<string, string[]>([
7 [
8 'comment',
9 [
10 'comment',
11 'comment.block',
12 'comment.line',
13 'comment.block.documentation'
14 ]
15 ],
16 ['string', ['string']],
17 ['keyword', ['keyword']],
18 ['keyword.control', ['keyword.control', 'keyword', 'keyword.other']],
19 [
20 'keyword.unsafe',
21 ['storage.modifier', 'keyword.other', 'keyword.control', 'keyword']
22 ],
23 ['function', ['entity.name.function']],
24 ['parameter', ['variable.parameter']],
25 ['constant', ['constant', 'variable']],
26 ['type', ['entity.name.type']],
27 ['builtin', ['variable.language', 'support.type', 'support.type']],
28 ['text', ['string', 'string.quoted', 'string.regexp']],
29 ['attribute', ['keyword']],
30 ['literal', ['string', 'string.quoted', 'string.regexp']],
31 ['macro', ['support.other']],
32 ['variable', ['variable']],
33 ['variable.mut', ['variable', 'storage.modifier']],
34 [
35 'field',
36 [
37 'variable.object.property',
38 'meta.field.declaration',
39 'meta.definition.property',
40 'variable.other'
41 ]
42 ],
43 ['module', ['entity.name.section', 'entity.other']]
44]);
45
46// Temporary exported for debugging for now.
47export function find(scope: string): string[] {
48 return mappings.get(scope) || [];
49}
50
51export function toRule(
52 scope: string,
53 intoRule: (scope: string) => TextMateRuleSettings | undefined
54): TextMateRuleSettings | undefined {
55 return find(scope)
56 .map(intoRule)
57 .filter(rule => rule !== undefined)[0];
58}
59
60function isString(value: any): value is string {
61 return typeof value === 'string';
62}
63
64function isArrayOfString(value: any): value is string[] {
65 return Array.isArray(value) && value.every(item => isString(item));
66}
67
68export function load() {
69 const rawConfig: { [key: string]: any } =
70 vscode.workspace
71 .getConfiguration('rust-analyzer')
72 .get('scopeMappings') || {};
73
74 mappings = Object.entries(rawConfig)
75 .filter(([_, value]) => isString(value) || isArrayOfString(value))
76 .reduce((list, [key, value]: [string, string | string[]]) => {
77 return list.set(key, isString(value) ? [value] : value);
78 }, defaultMapping);
79}