Skip to content

Commit 83c01fb

Browse files
gorhillgorhill
committed
Add syntax highlighting/auto-completion for preparsing directives
Related issue: - uBlockOrigin/uBlock-issues#1134 Invalid values for `!#if ...` will be highlighted as errors. Auto completion is now supported for both the directives themselves and the valid values for `!#if ...`. For examples, when pressing ctrl-space: - `!#e` will auto-complete to `!#endif` - `!#i` will offer to choose between `!#if ` or `!#include ` - `!#if fir` will auto-complete to `!#if env_firefox` Additionally, support for some of AdGuard preparsing directives, i.e. `!#if adguard` is now a valid and will be honoured -- it always evaluate to `false` in uBO.
1 parent 4c89c16 commit 83c01fb

File tree

7 files changed

+122
-35
lines changed

7 files changed

+122
-35
lines changed

‎src/1p-filters.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@
4949
<script src="lib/codemirror/addon/selection/active-line.js"></script>
5050

5151
<script src="js/codemirror/search.js"></script>
52+
<script src="js/codemirror/ubo-static-filtering.js"></script>
5253

5354
<script src="js/fa-icons.js"></script>
5455
<script src="js/vapi.js"></script>
@@ -59,7 +60,6 @@
5960
<script src="js/dashboard-common.js"></script>
6061
<script src="js/cloud-ui.js"></script>
6162
<script src="js/static-filtering-parser.js"></script>
62-
<script src="js/codemirror/ubo-static-filtering.js"></script>
6363
<script src="js/1p-filters.js"></script>
6464

6565
</body>

‎src/js/1p-filters.js‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,16 @@ const cmEditor = new CodeMirror(document.getElementById('userFilters'), {
4545

4646
uBlockDashboard.patchCodeMirrorEditor(cmEditor);
4747

48+
vAPI.messaging.send('dashboard', {
49+
what: 'getAutoCompleteDetails'
50+
}).then(response => {
51+
if ( response instanceof Object === false ) { return; }
52+
const mode = cmEditor.getMode();
53+
if ( mode.setHints instanceof Function ) {
54+
mode.setHints(response);
55+
}
56+
});
57+
4858
let cachedUserFilters = '';
4959

5060
/******************************************************************************/

‎src/js/asset-viewer.js‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,16 @@
4242

4343
uBlockDashboard.patchCodeMirrorEditor(cmEditor);
4444

45+
const hints = await vAPI.messaging.send('dashboard', {
46+
what: 'getAutoCompleteDetails'
47+
});
48+
if ( hints instanceof Object ) {
49+
const mode = cmEditor.getMode();
50+
if ( mode.setHints instanceof Function ) {
51+
mode.setHints(hints);
52+
}
53+
}
54+
4555
const details = await vAPI.messaging.send('default', {
4656
what : 'getAssetContent',
4757
url: assetKey,

‎src/js/assets.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ api.fetchFilterList = async function(mainlistURL) {
255255
}
256256
if ( result instanceof Object === false ) { continue; }
257257
const content = result.content;
258-
const slices = µBlock.processDirectives.split(content);
258+
const slices = µBlock.preparseDirectives.split(content);
259259
for ( let i = 0, n = slices.length - 1; i < n; i++ ) {
260260
const slice = content.slice(slices[i+0], slices[i+1]);
261261
if ( (i & 1) !== 0 ) {

‎src/js/codemirror/ubo-static-filtering.js‎

Lines changed: 86 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,53 @@
2525

2626
/******************************************************************************/
2727

28+
{
29+
// >>>>> start of local scope
30+
31+
/******************************************************************************/
32+
33+
const redirectNames = new Map();
34+
const scriptletNames = new Map();
35+
const preparseDirectiveNames = new Set();
36+
37+
/******************************************************************************/
38+
2839
CodeMirror.defineMode('ubo-static-filtering', function() {
2940
const StaticFilteringParser = typeof vAPI === 'object'
3041
? vAPI.StaticFilteringParser
3142
: self.StaticFilteringParser;
3243
if ( StaticFilteringParser instanceof Object === false ) { return; }
3344
const parser = new StaticFilteringParser({ interactive: true });
3445

35-
const reDirective = /^!#(?:if|endif|include)\b/;
46+
const rePreparseDirectives = /^!#(?:if|endif|include)\b/;
47+
const rePreparseIfDirective = /^(!#if !?)(.+)$/;
3648
let parserSlot = 0;
3749
let netOptionValueMode = false;
3850

51+
const colorCommentSpan = function(stream) {
52+
if ( rePreparseDirectives.test(stream.string) === false ) {
53+
stream.skipToEnd();
54+
return 'comment';
55+
}
56+
const match = rePreparseIfDirective.exec(stream.string);
57+
if ( match === null ) {
58+
stream.skipToEnd();
59+
return 'variable strong';
60+
}
61+
if ( stream.pos < match[1].length ) {
62+
stream.pos = match[1].length;
63+
return 'variable strong';
64+
}
65+
stream.skipToEnd();
66+
if (
67+
preparseDirectiveNames.size === 0 ||
68+
preparseDirectiveNames.has(match[2].trim())
69+
) {
70+
return 'variable strong';
71+
}
72+
return 'error strong';
73+
};
74+
3975
const colorExtHTMLPatternSpan = function(stream) {
4076
const { i } = parser.patternSpan;
4177
if ( stream.pos === parser.slices[i+1] ) {
@@ -202,10 +238,7 @@ CodeMirror.defineMode('ubo-static-filtering', function() {
202238
return 'comment';
203239
}
204240
if ( parser.category === parser.CATComment ) {
205-
stream.skipToEnd();
206-
return reDirective.test(stream.string)
207-
? 'variable strong'
208-
: 'comment';
241+
return colorCommentSpan(stream);
209242
}
210243
if ( (parser.slices[parserSlot] & parser.BITIgnore) !== 0 ) {
211244
stream.pos += parser.slices[parserSlot+2];
@@ -243,6 +276,23 @@ CodeMirror.defineMode('ubo-static-filtering', function() {
243276
style = style.trim();
244277
return style !== '' ? style : null;
245278
},
279+
setHints: function(details) {
280+
for ( const [ name, desc ] of details.redirectResources ) {
281+
const displayText = desc.aliasOf !== ''
282+
? `${name} (${desc.aliasOf})`
283+
: '';
284+
if ( desc.canRedirect ) {
285+
redirectNames.set(name, displayText);
286+
}
287+
if ( desc.canInject && name.endsWith('.js') ) {
288+
scriptletNames.set(name.slice(0, -3), displayText);
289+
}
290+
}
291+
details.preparseDirectives.forEach(a => {
292+
preparseDirectiveNames.add(a);
293+
});
294+
initHints();
295+
},
246296
};
247297
});
248298

@@ -251,17 +301,13 @@ CodeMirror.defineMode('ubo-static-filtering', function() {
251301
// Following code is for auto-completion. Reference:
252302
// https://codemirror.net/demo/complete.html
253303

254-
(( ) => {
255-
if ( typeof vAPI !== 'object' ) { return; }
256-
304+
const initHints = function() {
257305
const StaticFilteringParser = typeof vAPI === 'object'
258306
? vAPI.StaticFilteringParser
259307
: self.StaticFilteringParser;
260308
if ( StaticFilteringParser instanceof Object === false ) { return; }
261309

262310
const parser = new StaticFilteringParser();
263-
const redirectNames = new Map();
264-
const scriptletNames = new Map();
265311
const proceduralOperatorNames = new Map(
266312
Array.from(parser.proceduralOperatorTokens).filter(item => {
267313
return (item[1] & 0b01) !== 0;
@@ -380,7 +426,28 @@ CodeMirror.defineMode('ubo-static-filtering', function() {
380426
return pickBestHints(cursor, matchLeft[1], matchRight[1], hints);
381427
};
382428

383-
const getHints = function(cm) {
429+
const getCommentHints = function(cursor, line) {
430+
const beg = cursor.ch;
431+
if ( line.startsWith('!#if ') ) {
432+
const matchLeft = /^!#if !?(\w*)$/.exec(line.slice(0, beg));
433+
const matchRight = /^\w*/.exec(line.slice(beg));
434+
if ( matchLeft === null || matchRight === null ) { return; }
435+
const hints = [];
436+
for ( const hint of preparseDirectiveNames ) {
437+
hints.push(hint);
438+
}
439+
return pickBestHints(cursor, matchLeft[1], matchRight[0], hints);
440+
}
441+
if ( line.startsWith('!#') && line !== '!#endif' ) {
442+
const matchLeft = /^!#(\w*)$/.exec(line.slice(0, beg));
443+
const matchRight = /^\w*/.exec(line.slice(beg));
444+
if ( matchLeft === null || matchRight === null ) { return; }
445+
const hints = [ 'if ', 'endif\n', 'include ' ];
446+
return pickBestHints(cursor, matchLeft[1], matchRight[0], hints);
447+
}
448+
};
449+
450+
CodeMirror.registerHelper('hint', 'ubo-static-filtering', function(cm) {
384451
const cursor = cm.getCursor();
385452
const line = cm.getLine(cursor.line);
386453
parser.analyze(line);
@@ -393,25 +460,15 @@ CodeMirror.defineMode('ubo-static-filtering', function() {
393460
if ( parser.category === parser.CATStaticNetFilter ) {
394461
return getNetHints(cursor, line);
395462
}
396-
};
397-
398-
vAPI.messaging.send('dashboard', {
399-
what: 'getResourceDetails'
400-
}).then(response => {
401-
if ( Array.isArray(response) === false ) { return; }
402-
for ( const [ name, details ] of response ) {
403-
const displayText = details.aliasOf !== ''
404-
? `${name} (${details.aliasOf})`
405-
: '';
406-
if ( details.canRedirect ) {
407-
redirectNames.set(name, displayText);
408-
}
409-
if ( details.canInject && name.endsWith('.js') ) {
410-
scriptletNames.set(name.slice(0, -3), displayText);
411-
}
463+
if ( parser.category === parser.CATComment ) {
464+
return getCommentHints(cursor, line);
412465
}
413-
CodeMirror.registerHelper('hint', 'ubo-static-filtering', getHints);
414466
});
415-
})();
467+
};
468+
469+
/******************************************************************************/
470+
471+
// <<<<< end of local scope
472+
}
416473

417474
/******************************************************************************/

‎src/js/messaging.js‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1151,8 +1151,11 @@ const onMessage = function(request, sender, callback) {
11511151
response = µb.canUpdateShortcuts;
11521152
break;
11531153

1154-
case 'getResourceDetails':
1155-
response = µb.redirectEngine.getResourceDetails();
1154+
case 'getAutoCompleteDetails':
1155+
response = {
1156+
redirectResources: µb.redirectEngine.getResourceDetails(),
1157+
preparseDirectives: Array.from(µb.preparseDirectives.tokens.keys()),
1158+
};
11561159
break;
11571160

11581161
case 'getRules':

‎src/js/storage.js‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -802,7 +802,7 @@ self.addEventListener('hiddenSettingsChanged', ( ) => {
802802
// https://adblockplus.org/en/filters
803803
const staticNetFilteringEngine = this.staticNetFilteringEngine;
804804
const staticExtFilteringEngine = this.staticExtFilteringEngine;
805-
const lineIter = new this.LineIterator(this.processDirectives.prune(rawText));
805+
const lineIter = new this.LineIterator(this.preparseDirectives.prune(rawText));
806806
const parser = new vAPI.StaticFilteringParser();
807807

808808
parser.setMaxTokenLength(this.urlTokenizer.MAX_TOKEN_LENGTH);
@@ -857,7 +857,7 @@ self.addEventListener('hiddenSettingsChanged', ( ) => {
857857

858858
// https://github.com/AdguardTeam/AdguardBrowserExtension/issues/917
859859

860-
µBlock.processDirectives = {
860+
µBlock.preparseDirectives = {
861861
// This method returns an array of indices, corresponding to position in
862862
// the content string which should alternatively be parsed and discarded.
863863
split: function(content) {
@@ -929,6 +929,13 @@ self.addEventListener('hiddenSettingsChanged', ( ) => {
929929
[ 'cap_html_filtering', 'html_filtering' ],
930930
[ 'cap_user_stylesheet', 'user_stylesheet' ],
931931
[ 'false', 'false' ],
932+
// Compatibility with other blockers
933+
// https://kb.adguard.com/en/general/how-to-create-your-own-ad-filters#adguard-specific
934+
[ 'adguard', 'adguard' ],
935+
[ 'adguard_ext_chromium', 'chromium' ],
936+
[ 'adguard_ext_edge', 'edge' ],
937+
[ 'adguard_ext_firefox', 'firefox' ],
938+
[ 'adguard_ext_opera', 'chromium' ],
932939
]),
933940
};
934941

0 commit comments

Comments
 (0)