-
Notifications
You must be signed in to change notification settings - Fork 467
/
rainbow.js
438 lines (386 loc) · 11.9 KB
/
rainbow.js
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
/**
* Copyright 2012-2016 Craig Campbell
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Rainbow is a simple code syntax highlighter
*
* @see rainbowco.de
*/
import Prism from './prism';
import { isNode as utilIsNode, isWorker as utilIsWorker, createWorker, getLanguageForBlock } from './util';
import rainbowWorker from './worker';
/**
* An array of the language patterns specified for each language
*
* @type {Object}
*/
const patterns = {};
/**
* An object of languages mapping to what language they should inherit from
*
* @type {Object}
*/
const inheritenceMap = {};
/**
* A mapping of language aliases
*
* @type {Object}
*/
const aliases = {};
/**
* Representation of the actual rainbow object
*
* @type {Object}
*/
let Rainbow = {};
/**
* Callback to fire after each block is highlighted
*
* @type {null|Function}
*/
let onHighlightCallback;
const isNode = utilIsNode();
const isWorker = utilIsWorker();
let cachedWorker = null;
function _getWorker() {
if (isNode || cachedWorker === null) {
cachedWorker = createWorker(rainbowWorker, Prism);
}
return cachedWorker;
}
/**
* Helper for matching up callbacks directly with the
* post message requests to a web worker.
*
* @param {object} message data to send to web worker
* @param {Function} callback callback function for worker to reply to
* @return {void}
*/
function _messageWorker(message, callback) {
const worker = _getWorker();
function _listen(e) {
if (e.data.id === message.id) {
callback(e.data);
worker.removeEventListener('message', _listen);
}
}
worker.addEventListener('message', _listen);
worker.postMessage(message);
}
/**
* Browser Only - Handles response from web worker, updates DOM with
* resulting code, and fires callback
*
* @param {Element} element
* @param {object} waitingOn
* @param {Function} callback
* @return {void}
*/
function _generateHandler(element, waitingOn, callback) {
return function _handleResponseFromWorker(data) {
element.innerHTML = data.result;
element.classList.remove('loading');
if (element.parentNode.tagName === 'PRE') {
element.parentNode.classList.remove('loading');
}
// element.addEventListener('animationend', (e) => {
// if (e.animationName === 'fade-in') {
// setTimeout(() => {
// element.classList.remove('decrease-delay');
// }, 1000);
// }
// });
if (onHighlightCallback) {
onHighlightCallback(element, data.lang);
}
if (--waitingOn.c === 0) {
callback();
}
};
}
/**
* Gets options needed to pass into Prism
*
* @param {object} options
* @return {object}
*/
function _getPrismOptions(options) {
return {
patterns,
inheritenceMap,
aliases,
globalClass: options.globalClass,
delay: !isNaN(options.delay) ? options.delay : 0
};
}
/**
* Gets data to send to webworker
*
* @param {string} code
* @param {string} lang
* @return {object}
*/
function _getWorkerData(code, lang) {
let options = {};
if (typeof lang === 'object') {
options = lang;
lang = options.language;
}
lang = aliases[lang] || lang;
const workerData = {
id: String.fromCharCode(65 + Math.floor(Math.random() * 26)) + Date.now(),
code,
lang,
options: _getPrismOptions(options),
isNode
};
return workerData;
}
/**
* Browser Only - Sends messages to web worker to highlight elements passed
* in
*
* @param {Array} codeBlocks
* @param {Function} callback
* @return {void}
*/
function _highlightCodeBlocks(codeBlocks, callback) {
const waitingOn = { c: 0 };
for (const block of codeBlocks) {
const language = getLanguageForBlock(block);
if (block.classList.contains('rainbow') || !language) {
continue;
}
// This cancels the pending animation to fade the code in on load
// since we want to delay doing this until it is actually
// highlighted
block.classList.add('loading');
block.classList.add('rainbow');
// We need to make sure to also add the loading class to the pre tag
// because that is how we will know to show a preloader
if (block.parentNode.tagName === 'PRE') {
block.parentNode.classList.add('loading');
}
const globalClass = block.getAttribute('data-global-class');
const delay = parseInt(block.getAttribute('data-delay'), 10);
++waitingOn.c;
_messageWorker(_getWorkerData(block.innerHTML, { language, globalClass, delay }), _generateHandler(block, waitingOn, callback));
}
if (waitingOn.c === 0) {
callback();
}
}
function _addPreloader(preBlock) {
const preloader = document.createElement('div');
preloader.className = 'preloader';
for (let i = 0; i < 7; i++) {
preloader.appendChild(document.createElement('div'));
}
preBlock.appendChild(preloader);
}
/**
* Browser Only - Start highlighting all the code blocks
*
* @param {Element} node HTMLElement to search within
* @param {Function} callback
* @return {void}
*/
function _highlight(node, callback) {
callback = callback || function() {};
// The first argument can be an Event or a DOM Element.
//
// I was originally checking instanceof Event but that made it break
// when using mootools.
//
// @see https://github.com/ccampbell/rainbow/issues/32
node = node && typeof node.getElementsByTagName === 'function' ? node : document;
const preBlocks = node.getElementsByTagName('pre');
const codeBlocks = node.getElementsByTagName('code');
const finalPreBlocks = [];
const finalCodeBlocks = [];
// First loop through all pre blocks to find which ones to highlight
for (const preBlock of preBlocks) {
_addPreloader(preBlock);
// Strip whitespace around code tags when they are inside of a pre
// tag. This makes the themes look better because you can't
// accidentally add extra linebreaks at the start and end.
//
// When the pre tag contains a code tag then strip any extra
// whitespace.
//
// For example:
//
// <pre>
// <code>var foo = true;</code>
// </pre>
//
// will become:
//
// <pre><code>var foo = true;</code></pre>
//
// If you want to preserve whitespace you can use a pre tag on
// its own without a code tag inside of it.
if (preBlock.getElementsByTagName('code').length) {
// This fixes a race condition when Rainbow.color is called before
// the previous color call has finished.
if (!preBlock.getAttribute('data-trimmed')) {
preBlock.setAttribute('data-trimmed', true);
preBlock.innerHTML = preBlock.innerHTML.trim();
}
continue;
}
// If the pre block has no code blocks then we are going to want to
// process it directly.
finalPreBlocks.push(preBlock);
}
// @see http://stackoverflow.com/questions/2735067/how-to-convert-a-dom-node-list-to-an-array-in-javascript
// We are going to process all <code> blocks
for (const codeBlock of codeBlocks) {
finalCodeBlocks.push(codeBlock);
}
_highlightCodeBlocks(finalCodeBlocks.concat(finalPreBlocks), callback);
}
/**
* Callback to let you do stuff in your app after a piece of code has
* been highlighted
*
* @param {Function} callback
* @return {void}
*/
function onHighlight(callback) {
onHighlightCallback = callback;
}
/**
* Extends the language pattern matches
*
* @param {string} language name of language
* @param {object} languagePatterns object of patterns to add on
* @param {string|undefined} inherits optional language that this language
* should inherit rules from
*/
function extend(language, languagePatterns, inherits) {
// If we extend a language again we shouldn't need to specify the
// inheritence for it. For example, if you are adding special highlighting
// for a javascript function that is not in the base javascript rules, you
// should be able to do
//
// Rainbow.extend('javascript', [ … ]);
//
// Without specifying a language it should inherit (generic in this case)
if (!inheritenceMap[language]) {
inheritenceMap[language] = inherits;
}
patterns[language] = languagePatterns.concat(patterns[language] || []);
}
function remove(language) {
delete inheritenceMap[language];
delete patterns[language];
}
/**
* Starts the magic rainbow
*
* @return {void}
*/
function color(...args) {
// If you want to straight up highlight a string you can pass the
// string of code, the language, and a callback function.
//
// Example:
//
// Rainbow.color(code, language, function(highlightedCode, language) {
// // this code block is now highlighted
// });
if (typeof args[0] === 'string') {
const workerData = _getWorkerData(args[0], args[1]);
_messageWorker(workerData, (function(cb) {
return function(data) {
if (cb) {
cb(data.result, data.lang);
}
};
}(args[2])));
return;
}
// If you pass a callback function then we rerun the color function
// on all the code and call the callback function on complete.
//
// Example:
//
// Rainbow.color(function() {
// console.log('All matching tags on the page are now highlighted');
// });
if (typeof args[0] === 'function') {
_highlight(0, args[0]);
return;
}
// Otherwise we use whatever node you passed in with an optional
// callback function as the second parameter.
//
// Example:
//
// var preElement = document.createElement('pre');
// var codeElement = document.createElement('code');
// codeElement.setAttribute('data-language', 'javascript');
// codeElement.innerHTML = '// Here is some JavaScript';
// preElement.appendChild(codeElement);
// Rainbow.color(preElement, function() {
// // New element is now highlighted
// });
//
// If you don't pass an element it will default to `document`
_highlight(args[0], args[1]);
}
/**
* Method to add an alias for an existing language.
*
* For example if you want to have "coffee" map to "coffeescript"
*
* @see https://github.com/ccampbell/rainbow/issues/154
* @param {string} alias
* @param {string} originalLanguage
* @return {void}
*/
function addAlias(alias, originalLanguage) {
aliases[alias] = originalLanguage;
}
/**
* public methods
*/
Rainbow = {
extend,
remove,
onHighlight,
addAlias,
color
};
if (isNode) {
Rainbow.colorSync = function(code, lang) {
const workerData = _getWorkerData(code, lang);
const prism = new Prism(workerData.options);
return prism.refract(workerData.code, workerData.lang);
};
}
// In the browser hook it up to color on page load
if (!isNode && !isWorker) {
document.addEventListener('DOMContentLoaded', (event) => {
if (!Rainbow.defer) {
Rainbow.color(event);
}
}, false);
}
// From a node worker, handle the postMessage requests to it
if (isWorker) {
self.onmessage = rainbowWorker;
}
export default Rainbow;