12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198 |
- // https://github.com/substack/deep-freeze/blob/master/index.js
- /** @param {any} obj */
- function deepFreeze(obj) {
- Object.freeze(obj);
- var objIsFunction = typeof obj === 'function';
- Object.getOwnPropertyNames(obj).forEach(function(prop) {
- if (Object.hasOwnProperty.call(obj, prop)
- && obj[prop] !== null
- && (typeof obj[prop] === "object" || typeof obj[prop] === "function")
- // IE11 fix: https://github.com/highlightjs/highlight.js/issues/2318
- // TODO: remove in the future
- && (objIsFunction ? prop !== 'caller' && prop !== 'callee' && prop !== 'arguments' : true)
- && !Object.isFrozen(obj[prop])) {
- deepFreeze(obj[prop]);
- }
- });
- return obj;
- }
- class Response {
- /**
- * @param {CompiledMode} mode
- */
- constructor(mode) {
- // eslint-disable-next-line no-undefined
- if (mode.data === undefined) mode.data = {};
- this.data = mode.data;
- }
- ignoreMatch() {
- this.ignore = true;
- }
- }
- /**
- * @param {string} value
- * @returns {string}
- */
- function escapeHTML(value) {
- return value
- .replace(/&/g, '&')
- .replace(/</g, '<')
- .replace(/>/g, '>')
- .replace(/"/g, '"')
- .replace(/'/g, ''');
- }
- /**
- * performs a shallow merge of multiple objects into one
- *
- * @template T
- * @param {T} original
- * @param {Record<string,any>[]} objects
- * @returns {T} a single new object
- */
- function inherit(original, ...objects) {
- /** @type Record<string,any> */
- var result = {};
- for (const key in original) {
- result[key] = original[key];
- }
- objects.forEach(function(obj) {
- for (const key in obj) {
- result[key] = obj[key];
- }
- });
- return /** @type {T} */ (result);
- }
- /* Stream merging */
- /**
- * @typedef Event
- * @property {'start'|'stop'} event
- * @property {number} offset
- * @property {Node} node
- */
- /**
- * @param {Node} node
- */
- function tag(node) {
- return node.nodeName.toLowerCase();
- }
- /**
- * @param {Node} node
- */
- function nodeStream(node) {
- /** @type Event[] */
- var result = [];
- (function _nodeStream(node, offset) {
- for (var child = node.firstChild; child; child = child.nextSibling) {
- if (child.nodeType === 3) {
- offset += child.nodeValue.length;
- } else if (child.nodeType === 1) {
- result.push({
- event: 'start',
- offset: offset,
- node: child
- });
- offset = _nodeStream(child, offset);
- // Prevent void elements from having an end tag that would actually
- // double them in the output. There are more void elements in HTML
- // but we list only those realistically expected in code display.
- if (!tag(child).match(/br|hr|img|input/)) {
- result.push({
- event: 'stop',
- offset: offset,
- node: child
- });
- }
- }
- }
- return offset;
- })(node, 0);
- return result;
- }
- /**
- * @param {any} original - the original stream
- * @param {any} highlighted - stream of the highlighted source
- * @param {string} value - the original source itself
- */
- function mergeStreams(original, highlighted, value) {
- var processed = 0;
- var result = '';
- var nodeStack = [];
- function selectStream() {
- if (!original.length || !highlighted.length) {
- return original.length ? original : highlighted;
- }
- if (original[0].offset !== highlighted[0].offset) {
- return (original[0].offset < highlighted[0].offset) ? original : highlighted;
- }
- /*
- To avoid starting the stream just before it should stop the order is
- ensured that original always starts first and closes last:
- if (event1 == 'start' && event2 == 'start')
- return original;
- if (event1 == 'start' && event2 == 'stop')
- return highlighted;
- if (event1 == 'stop' && event2 == 'start')
- return original;
- if (event1 == 'stop' && event2 == 'stop')
- return highlighted;
- ... which is collapsed to:
- */
- return highlighted[0].event === 'start' ? original : highlighted;
- }
- /**
- * @param {Node} node
- */
- function open(node) {
- /** @param {Attr} attr */
- function attr_str(attr) {
- return ' ' + attr.nodeName + '="' + escapeHTML(attr.value) + '"';
- }
- // @ts-ignore
- result += '<' + tag(node) + [].map.call(node.attributes, attr_str).join('') + '>';
- }
- /**
- * @param {Node} node
- */
- function close(node) {
- result += '</' + tag(node) + '>';
- }
- /**
- * @param {Event} event
- */
- function render(event) {
- (event.event === 'start' ? open : close)(event.node);
- }
- while (original.length || highlighted.length) {
- var stream = selectStream();
- result += escapeHTML(value.substring(processed, stream[0].offset));
- processed = stream[0].offset;
- if (stream === original) {
- /*
- On any opening or closing tag of the original markup we first close
- the entire highlighted node stack, then render the original tag along
- with all the following original tags at the same offset and then
- reopen all the tags on the highlighted stack.
- */
- nodeStack.reverse().forEach(close);
- do {
- render(stream.splice(0, 1)[0]);
- stream = selectStream();
- } while (stream === original && stream.length && stream[0].offset === processed);
- nodeStack.reverse().forEach(open);
- } else {
- if (stream[0].event === 'start') {
- nodeStack.push(stream[0].node);
- } else {
- nodeStack.pop();
- }
- render(stream.splice(0, 1)[0]);
- }
- }
- return result + escapeHTML(value.substr(processed));
- }
- var utils = /*#__PURE__*/Object.freeze({
- __proto__: null,
- escapeHTML: escapeHTML,
- inherit: inherit,
- nodeStream: nodeStream,
- mergeStreams: mergeStreams
- });
- /**
- * @typedef {object} Renderer
- * @property {(text: string) => void} addText
- * @property {(node: Node) => void} openNode
- * @property {(node: Node) => void} closeNode
- * @property {() => string} value
- */
- /** @typedef {{kind?: string, sublanguage?: boolean}} Node */
- /** @typedef {{walk: (r: Renderer) => void}} Tree */
- /** */
- const SPAN_CLOSE = '</span>';
- /**
- * Determines if a node needs to be wrapped in <span>
- *
- * @param {Node} node */
- const emitsWrappingTags = (node) => {
- return !!node.kind;
- };
- /** @type {Renderer} */
- class HTMLRenderer {
- /**
- * Creates a new HTMLRenderer
- *
- * @param {Tree} parseTree - the parse tree (must support `walk` API)
- * @param {{classPrefix: string}} options
- */
- constructor(parseTree, options) {
- this.buffer = "";
- this.classPrefix = options.classPrefix;
- parseTree.walk(this);
- }
- /**
- * Adds texts to the output stream
- *
- * @param {string} text */
- addText(text) {
- this.buffer += escapeHTML(text);
- }
- /**
- * Adds a node open to the output stream (if needed)
- *
- * @param {Node} node */
- openNode(node) {
- if (!emitsWrappingTags(node)) return;
- let className = node.kind;
- if (!node.sublanguage) {
- className = `${this.classPrefix}${className}`;
- }
- this.span(className);
- }
- /**
- * Adds a node close to the output stream (if needed)
- *
- * @param {Node} node */
- closeNode(node) {
- if (!emitsWrappingTags(node)) return;
- this.buffer += SPAN_CLOSE;
- }
- /**
- * returns the accumulated buffer
- */
- value() {
- return this.buffer;
- }
- // helpers
- /**
- * Builds a span element
- *
- * @param {string} className */
- span(className) {
- this.buffer += `<span class="${className}">`;
- }
- }
- /** @typedef {{kind?: string, sublanguage?: boolean, children: Node[]} | string} Node */
- /** @typedef {{kind?: string, sublanguage?: boolean, children: Node[]} } DataNode */
- /** */
- class TokenTree {
- constructor() {
- /** @type DataNode */
- this.rootNode = { children: [] };
- this.stack = [this.rootNode];
- }
- get top() {
- return this.stack[this.stack.length - 1];
- }
- get root() { return this.rootNode; }
- /** @param {Node} node */
- add(node) {
- this.top.children.push(node);
- }
- /** @param {string} kind */
- openNode(kind) {
- /** @type Node */
- const node = { kind, children: [] };
- this.add(node);
- this.stack.push(node);
- }
- closeNode() {
- if (this.stack.length > 1) {
- return this.stack.pop();
- }
- // eslint-disable-next-line no-undefined
- return undefined;
- }
- closeAllNodes() {
- while (this.closeNode());
- }
- toJSON() {
- return JSON.stringify(this.rootNode, null, 4);
- }
- /**
- * @typedef { import("./html_renderer").Renderer } Renderer
- * @param {Renderer} builder
- */
- walk(builder) {
- // this does not
- return this.constructor._walk(builder, this.rootNode);
- // this works
- // return TokenTree._walk(builder, this.rootNode);
- }
- /**
- * @param {Renderer} builder
- * @param {Node} node
- */
- static _walk(builder, node) {
- if (typeof node === "string") {
- builder.addText(node);
- } else if (node.children) {
- builder.openNode(node);
- node.children.forEach((child) => this._walk(builder, child));
- builder.closeNode(node);
- }
- return builder;
- }
- /**
- * @param {Node} node
- */
- static _collapse(node) {
- if (typeof node === "string") return;
- if (!node.children) return;
- if (node.children.every(el => typeof el === "string")) {
- // node.text = node.children.join("");
- // delete node.children;
- node.children = [node.children.join("")];
- } else {
- node.children.forEach((child) => {
- TokenTree._collapse(child);
- });
- }
- }
- }
- /**
- Currently this is all private API, but this is the minimal API necessary
- that an Emitter must implement to fully support the parser.
- Minimal interface:
- - addKeyword(text, kind)
- - addText(text)
- - addSublanguage(emitter, subLanguageName)
- - finalize()
- - openNode(kind)
- - closeNode()
- - closeAllNodes()
- - toHTML()
- */
- /**
- * @implements {Emitter}
- */
- class TokenTreeEmitter extends TokenTree {
- /**
- * @param {*} options
- */
- constructor(options) {
- super();
- this.options = options;
- }
- /**
- * @param {string} text
- * @param {string} kind
- */
- addKeyword(text, kind) {
- if (text === "") { return; }
- this.openNode(kind);
- this.addText(text);
- this.closeNode();
- }
- /**
- * @param {string} text
- */
- addText(text) {
- if (text === "") { return; }
- this.add(text);
- }
- /**
- * @param {Emitter & {root: DataNode}} emitter
- * @param {string} name
- */
- addSublanguage(emitter, name) {
- /** @type DataNode */
- const node = emitter.root;
- node.kind = name;
- node.sublanguage = true;
- this.add(node);
- }
- toHTML() {
- const renderer = new HTMLRenderer(this, this.options);
- return renderer.value();
- }
- finalize() {
- return true;
- }
- }
- /**
- * @param {string} value
- * @returns {RegExp}
- * */
- function escape(value) {
- return new RegExp(value.replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&'), 'm');
- }
- /**
- * @param {RegExp | string } re
- * @returns {string}
- */
- function source(re) {
- if (!re) return null;
- if (typeof re === "string") return re;
- return re.source;
- }
- /**
- * @param {...(RegExp | string) } args
- * @returns {string}
- */
- function concat(...args) {
- const joined = args.map((x) => source(x)).join("");
- return joined;
- }
- /**
- * @param {RegExp} re
- * @returns {number}
- */
- function countMatchGroups(re) {
- return (new RegExp(re.toString() + '|')).exec('').length - 1;
- }
- /**
- * Does lexeme start with a regular expression match at the beginning
- * @param {RegExp} re
- * @param {string} lexeme
- */
- function startsWith(re, lexeme) {
- var match = re && re.exec(lexeme);
- return match && match.index === 0;
- }
- // join logically computes regexps.join(separator), but fixes the
- // backreferences so they continue to match.
- // it also places each individual regular expression into it's own
- // match group, keeping track of the sequencing of those match groups
- // is currently an exercise for the caller. :-)
- /**
- * @param {(string | RegExp)[]} regexps
- * @param {string} separator
- * @returns {string}
- */
- function join(regexps, separator = "|") {
- // backreferenceRe matches an open parenthesis or backreference. To avoid
- // an incorrect parse, it additionally matches the following:
- // - [...] elements, where the meaning of parentheses and escapes change
- // - other escape sequences, so we do not misparse escape sequences as
- // interesting elements
- // - non-matching or lookahead parentheses, which do not capture. These
- // follow the '(' with a '?'.
- var backreferenceRe = /\[(?:[^\\\]]|\\.)*\]|\(\??|\\([1-9][0-9]*)|\\./;
- var numCaptures = 0;
- var ret = '';
- for (var i = 0; i < regexps.length; i++) {
- numCaptures += 1;
- var offset = numCaptures;
- var re = source(regexps[i]);
- if (i > 0) {
- ret += separator;
- }
- ret += "(";
- while (re.length > 0) {
- var match = backreferenceRe.exec(re);
- if (match == null) {
- ret += re;
- break;
- }
- ret += re.substring(0, match.index);
- re = re.substring(match.index + match[0].length);
- if (match[0][0] === '\\' && match[1]) {
- // Adjust the backreference.
- ret += '\\' + String(Number(match[1]) + offset);
- } else {
- ret += match[0];
- if (match[0] === '(') {
- numCaptures++;
- }
- }
- }
- ret += ")";
- }
- return ret;
- }
- // Common regexps
- const IDENT_RE = '[a-zA-Z]\\w*';
- const UNDERSCORE_IDENT_RE = '[a-zA-Z_]\\w*';
- const NUMBER_RE = '\\b\\d+(\\.\\d+)?';
- const C_NUMBER_RE = '(-?)(\\b0[xX][a-fA-F0-9]+|(\\b\\d+(\\.\\d*)?|\\.\\d+)([eE][-+]?\\d+)?)'; // 0x..., 0..., decimal, float
- const BINARY_NUMBER_RE = '\\b(0b[01]+)'; // 0b...
- const RE_STARTERS_RE = '!|!=|!==|%|%=|&|&&|&=|\\*|\\*=|\\+|\\+=|,|-|-=|/=|/|:|;|<<|<<=|<=|<|===|==|=|>>>=|>>=|>=|>>>|>>|>|\\?|\\[|\\{|\\(|\\^|\\^=|\\||\\|=|\\|\\||~';
- /**
- * @param { Partial<Mode> & {binary?: string | RegExp} } opts
- */
- const SHEBANG = (opts = {}) => {
- const beginShebang = /^#![ ]*\//;
- if (opts.binary) {
- opts.begin = concat(
- beginShebang,
- /.*\b/,
- opts.binary,
- /\b.*/);
- }
- return inherit({
- className: 'meta',
- begin: beginShebang,
- end: /$/,
- relevance: 0,
- /** @type {ModeCallback} */
- "on:begin": (m, resp) => {
- if (m.index !== 0) resp.ignoreMatch();
- }
- }, opts);
- };
- // Common modes
- const BACKSLASH_ESCAPE = {
- begin: '\\\\[\\s\\S]', relevance: 0
- };
- const APOS_STRING_MODE = {
- className: 'string',
- begin: '\'',
- end: '\'',
- illegal: '\\n',
- contains: [BACKSLASH_ESCAPE]
- };
- const QUOTE_STRING_MODE = {
- className: 'string',
- begin: '"',
- end: '"',
- illegal: '\\n',
- contains: [BACKSLASH_ESCAPE]
- };
- const PHRASAL_WORDS_MODE = {
- begin: /\b(a|an|the|are|I'm|isn't|don't|doesn't|won't|but|just|should|pretty|simply|enough|gonna|going|wtf|so|such|will|you|your|they|like|more)\b/
- };
- /**
- * Creates a comment mode
- *
- * @param {string | RegExp} begin
- * @param {string | RegExp} end
- * @param {Mode | {}} [modeOptions]
- * @returns {Partial<Mode>}
- */
- const COMMENT = function(begin, end, modeOptions = {}) {
- var mode = inherit(
- {
- className: 'comment',
- begin,
- end,
- contains: []
- },
- modeOptions
- );
- mode.contains.push(PHRASAL_WORDS_MODE);
- mode.contains.push({
- className: 'doctag',
- begin: '(?:TODO|FIXME|NOTE|BUG|OPTIMIZE|HACK|XXX):',
- relevance: 0
- });
- return mode;
- };
- const C_LINE_COMMENT_MODE = COMMENT('//', '$');
- const C_BLOCK_COMMENT_MODE = COMMENT('/\\*', '\\*/');
- const HASH_COMMENT_MODE = COMMENT('#', '$');
- const NUMBER_MODE = {
- className: 'number',
- begin: NUMBER_RE,
- relevance: 0
- };
- const C_NUMBER_MODE = {
- className: 'number',
- begin: C_NUMBER_RE,
- relevance: 0
- };
- const BINARY_NUMBER_MODE = {
- className: 'number',
- begin: BINARY_NUMBER_RE,
- relevance: 0
- };
- const CSS_NUMBER_MODE = {
- className: 'number',
- begin: NUMBER_RE + '(' +
- '%|em|ex|ch|rem' +
- '|vw|vh|vmin|vmax' +
- '|cm|mm|in|pt|pc|px' +
- '|deg|grad|rad|turn' +
- '|s|ms' +
- '|Hz|kHz' +
- '|dpi|dpcm|dppx' +
- ')?',
- relevance: 0
- };
- const REGEXP_MODE = {
- // this outer rule makes sure we actually have a WHOLE regex and not simply
- // an expression such as:
- //
- // 3 / something
- //
- // (which will then blow up when regex's `illegal` sees the newline)
- begin: /(?=\/[^/\n]*\/)/,
- contains: [{
- className: 'regexp',
- begin: /\//,
- end: /\/[gimuy]*/,
- illegal: /\n/,
- contains: [
- BACKSLASH_ESCAPE,
- {
- begin: /\[/,
- end: /\]/,
- relevance: 0,
- contains: [BACKSLASH_ESCAPE]
- }
- ]
- }]
- };
- const TITLE_MODE = {
- className: 'title',
- begin: IDENT_RE,
- relevance: 0
- };
- const UNDERSCORE_TITLE_MODE = {
- className: 'title',
- begin: UNDERSCORE_IDENT_RE,
- relevance: 0
- };
- const METHOD_GUARD = {
- // excludes method names from keyword processing
- begin: '\\.\\s*' + UNDERSCORE_IDENT_RE,
- relevance: 0
- };
- /**
- * Adds end same as begin mechanics to a mode
- *
- * Your mode must include at least a single () match group as that first match
- * group is what is used for comparison
- * @param {Partial<Mode>} mode
- */
- const END_SAME_AS_BEGIN = function(mode) {
- return Object.assign(mode,
- {
- /** @type {ModeCallback} */
- 'on:begin': (m, resp) => { resp.data._beginMatch = m[1]; },
- /** @type {ModeCallback} */
- 'on:end': (m, resp) => { if (resp.data._beginMatch !== m[1]) resp.ignoreMatch(); }
- });
- };
- var MODES = /*#__PURE__*/Object.freeze({
- __proto__: null,
- IDENT_RE: IDENT_RE,
- UNDERSCORE_IDENT_RE: UNDERSCORE_IDENT_RE,
- NUMBER_RE: NUMBER_RE,
- C_NUMBER_RE: C_NUMBER_RE,
- BINARY_NUMBER_RE: BINARY_NUMBER_RE,
- RE_STARTERS_RE: RE_STARTERS_RE,
- SHEBANG: SHEBANG,
- BACKSLASH_ESCAPE: BACKSLASH_ESCAPE,
- APOS_STRING_MODE: APOS_STRING_MODE,
- QUOTE_STRING_MODE: QUOTE_STRING_MODE,
- PHRASAL_WORDS_MODE: PHRASAL_WORDS_MODE,
- COMMENT: COMMENT,
- C_LINE_COMMENT_MODE: C_LINE_COMMENT_MODE,
- C_BLOCK_COMMENT_MODE: C_BLOCK_COMMENT_MODE,
- HASH_COMMENT_MODE: HASH_COMMENT_MODE,
- NUMBER_MODE: NUMBER_MODE,
- C_NUMBER_MODE: C_NUMBER_MODE,
- BINARY_NUMBER_MODE: BINARY_NUMBER_MODE,
- CSS_NUMBER_MODE: CSS_NUMBER_MODE,
- REGEXP_MODE: REGEXP_MODE,
- TITLE_MODE: TITLE_MODE,
- UNDERSCORE_TITLE_MODE: UNDERSCORE_TITLE_MODE,
- METHOD_GUARD: METHOD_GUARD,
- END_SAME_AS_BEGIN: END_SAME_AS_BEGIN
- });
- // keywords that should have no default relevance value
- var COMMON_KEYWORDS = 'of and for in not or if then'.split(' ');
- // compilation
- /**
- * Compiles a language definition result
- *
- * Given the raw result of a language definition (Language), compiles this so
- * that it is ready for highlighting code.
- * @param {Language} language
- * @returns {CompiledLanguage}
- */
- function compileLanguage(language) {
- /**
- * Builds a regex with the case sensativility of the current language
- *
- * @param {RegExp | string} value
- * @param {boolean} [global]
- */
- function langRe(value, global) {
- return new RegExp(
- source(value),
- 'm' + (language.case_insensitive ? 'i' : '') + (global ? 'g' : '')
- );
- }
- /**
- Stores multiple regular expressions and allows you to quickly search for
- them all in a string simultaneously - returning the first match. It does
- this by creating a huge (a|b|c) regex - each individual item wrapped with ()
- and joined by `|` - using match groups to track position. When a match is
- found checking which position in the array has content allows us to figure
- out which of the original regexes / match groups triggered the match.
- The match object itself (the result of `Regex.exec`) is returned but also
- enhanced by merging in any meta-data that was registered with the regex.
- This is how we keep track of which mode matched, and what type of rule
- (`illegal`, `begin`, end, etc).
- */
- class MultiRegex {
- constructor() {
- this.matchIndexes = {};
- // @ts-ignore
- this.regexes = [];
- this.matchAt = 1;
- this.position = 0;
- }
- // @ts-ignore
- addRule(re, opts) {
- opts.position = this.position++;
- // @ts-ignore
- this.matchIndexes[this.matchAt] = opts;
- this.regexes.push([opts, re]);
- this.matchAt += countMatchGroups(re) + 1;
- }
- compile() {
- if (this.regexes.length === 0) {
- // avoids the need to check length every time exec is called
- // @ts-ignore
- this.exec = () => null;
- }
- const terminators = this.regexes.map(el => el[1]);
- this.matcherRe = langRe(join(terminators), true);
- this.lastIndex = 0;
- }
- /** @param {string} s */
- exec(s) {
- this.matcherRe.lastIndex = this.lastIndex;
- const match = this.matcherRe.exec(s);
- if (!match) { return null; }
- // eslint-disable-next-line no-undefined
- const i = match.findIndex((el, i) => i > 0 && el !== undefined);
- // @ts-ignore
- const matchData = this.matchIndexes[i];
- // trim off any earlier non-relevant match groups (ie, the other regex
- // match groups that make up the multi-matcher)
- match.splice(0, i);
- return Object.assign(match, matchData);
- }
- }
- /*
- Created to solve the key deficiently with MultiRegex - there is no way to
- test for multiple matches at a single location. Why would we need to do
- that? In the future a more dynamic engine will allow certain matches to be
- ignored. An example: if we matched say the 3rd regex in a large group but
- decided to ignore it - we'd need to started testing again at the 4th
- regex... but MultiRegex itself gives us no real way to do that.
- So what this class creates MultiRegexs on the fly for whatever search
- position they are needed.
- NOTE: These additional MultiRegex objects are created dynamically. For most
- grammars most of the time we will never actually need anything more than the
- first MultiRegex - so this shouldn't have too much overhead.
- Say this is our search group, and we match regex3, but wish to ignore it.
- regex1 | regex2 | regex3 | regex4 | regex5 ' ie, startAt = 0
- What we need is a new MultiRegex that only includes the remaining
- possibilities:
- regex4 | regex5 ' ie, startAt = 3
- This class wraps all that complexity up in a simple API... `startAt` decides
- where in the array of expressions to start doing the matching. It
- auto-increments, so if a match is found at position 2, then startAt will be
- set to 3. If the end is reached startAt will return to 0.
- MOST of the time the parser will be setting startAt manually to 0.
- */
- class ResumableMultiRegex {
- constructor() {
- // @ts-ignore
- this.rules = [];
- // @ts-ignore
- this.multiRegexes = [];
- this.count = 0;
- this.lastIndex = 0;
- this.regexIndex = 0;
- }
- // @ts-ignore
- getMatcher(index) {
- if (this.multiRegexes[index]) return this.multiRegexes[index];
- const matcher = new MultiRegex();
- this.rules.slice(index).forEach(([re, opts]) => matcher.addRule(re, opts));
- matcher.compile();
- this.multiRegexes[index] = matcher;
- return matcher;
- }
- resumingScanAtSamePosition() {
- return this.regexIndex !== 0;
- }
- considerAll() {
- this.regexIndex = 0;
- }
- // @ts-ignore
- addRule(re, opts) {
- this.rules.push([re, opts]);
- if (opts.type === "begin") this.count++;
- }
- /** @param {string} s */
- exec(s) {
- const m = this.getMatcher(this.regexIndex);
- m.lastIndex = this.lastIndex;
- let result = m.exec(s);
- // The following is because we have no easy way to say "resume scanning at the
- // existing position but also skip the current rule ONLY". What happens is
- // all prior rules are also skipped which can result in matching the wrong
- // thing. Example of matching "booger":
- // our matcher is [string, "booger", number]
- //
- // ....booger....
- // if "booger" is ignored then we'd really need a regex to scan from the
- // SAME position for only: [string, number] but ignoring "booger" (if it
- // was the first match), a simple resume would scan ahead who knows how
- // far looking only for "number", ignoring potential string matches (or
- // future "booger" matches that might be valid.)
- // So what we do: We execute two matchers, one resuming at the same
- // position, but the second full matcher starting at the position after:
- // /--- resume first regex match here (for [number])
- // |/---- full match here for [string, "booger", number]
- // vv
- // ....booger....
- // Which ever results in a match first is then used. So this 3-4 step
- // process essentially allows us to say "match at this position, excluding
- // a prior rule that was ignored".
- //
- // 1. Match "booger" first, ignore. Also proves that [string] does non match.
- // 2. Resume matching for [number]
- // 3. Match at index + 1 for [string, "booger", number]
- // 4. If #2 and #3 result in matches, which came first?
- if (this.resumingScanAtSamePosition()) {
- if (result && result.index === this.lastIndex) ; else { // use the second matcher result
- const m2 = this.getMatcher(0);
- m2.lastIndex = this.lastIndex + 1;
- result = m2.exec(s);
- }
- }
- if (result) {
- this.regexIndex += result.position + 1;
- if (this.regexIndex === this.count) {
- // wrap-around to considering all matches again
- this.considerAll();
- }
- }
- return result;
- }
- }
- /**
- * Given a mode, builds a huge ResumableMultiRegex that can be used to walk
- * the content and find matches.
- *
- * @param {CompiledMode} mode
- * @returns {ResumableMultiRegex}
- */
- function buildModeRegex(mode) {
- const mm = new ResumableMultiRegex();
- mode.contains.forEach(term => mm.addRule(term.begin, { rule: term, type: "begin" }));
- if (mode.terminator_end) {
- mm.addRule(mode.terminator_end, { type: "end" });
- }
- if (mode.illegal) {
- mm.addRule(mode.illegal, { type: "illegal" });
- }
- return mm;
- }
- // TODO: We need negative look-behind support to do this properly
- /**
- * Skip a match if it has a preceding or trailing dot
- *
- * This is used for `beginKeywords` to prevent matching expressions such as
- * `bob.keyword.do()`. The mode compiler automatically wires this up as a
- * special _internal_ 'on:begin' callback for modes with `beginKeywords`
- * @param {RegExpMatchArray} match
- * @param {CallbackResponse} response
- */
- function skipIfhasPrecedingOrTrailingDot(match, response) {
- const before = match.input[match.index - 1];
- const after = match.input[match.index + match[0].length];
- if (before === "." || after === ".") {
- response.ignoreMatch();
- }
- }
- /** skip vs abort vs ignore
- *
- * @skip - The mode is still entered and exited normally (and contains rules apply),
- * but all content is held and added to the parent buffer rather than being
- * output when the mode ends. Mostly used with `sublanguage` to build up
- * a single large buffer than can be parsed by sublanguage.
- *
- * - The mode begin ands ends normally.
- * - Content matched is added to the parent mode buffer.
- * - The parser cursor is moved forward normally.
- *
- * @abort - A hack placeholder until we have ignore. Aborts the mode (as if it
- * never matched) but DOES NOT continue to match subsequent `contains`
- * modes. Abort is bad/suboptimal because it can result in modes
- * farther down not getting applied because an earlier rule eats the
- * content but then aborts.
- *
- * - The mode does not begin.
- * - Content matched by `begin` is added to the mode buffer.
- * - The parser cursor is moved forward accordingly.
- *
- * @ignore - Ignores the mode (as if it never matched) and continues to match any
- * subsequent `contains` modes. Ignore isn't technically possible with
- * the current parser implementation.
- *
- * - The mode does not begin.
- * - Content matched by `begin` is ignored.
- * - The parser cursor is not moved forward.
- */
- /**
- * Compiles an individual mode
- *
- * This can raise an error if the mode contains certain detectable known logic
- * issues.
- * @param {Mode} mode
- * @param {CompiledMode | null} [parent]
- * @returns {CompiledMode | never}
- */
- function compileMode(mode, parent) {
- const cmode = /** @type CompiledMode */ (mode);
- if (mode.compiled) return cmode;
- mode.compiled = true;
- // __beforeBegin is considered private API, internal use only
- mode.__beforeBegin = null;
- mode.keywords = mode.keywords || mode.beginKeywords;
- let kw_pattern = null;
- if (typeof mode.keywords === "object") {
- kw_pattern = mode.keywords.$pattern;
- delete mode.keywords.$pattern;
- }
- if (mode.keywords) {
- mode.keywords = compileKeywords(mode.keywords, language.case_insensitive);
- }
- // both are not allowed
- if (mode.lexemes && kw_pattern) {
- throw new Error("ERR: Prefer `keywords.$pattern` to `mode.lexemes`, BOTH are not allowed. (see mode reference) ");
- }
- // `mode.lexemes` was the old standard before we added and now recommend
- // using `keywords.$pattern` to pass the keyword pattern
- cmode.keywordPatternRe = langRe(mode.lexemes || kw_pattern || /\w+/, true);
- if (parent) {
- if (mode.beginKeywords) {
- // for languages with keywords that include non-word characters checking for
- // a word boundary is not sufficient, so instead we check for a word boundary
- // or whitespace - this does no harm in any case since our keyword engine
- // doesn't allow spaces in keywords anyways and we still check for the boundary
- // first
- mode.begin = '\\b(' + mode.beginKeywords.split(' ').join('|') + ')(?=\\b|\\s)';
- mode.__beforeBegin = skipIfhasPrecedingOrTrailingDot;
- }
- if (!mode.begin) mode.begin = /\B|\b/;
- cmode.beginRe = langRe(mode.begin);
- if (mode.endSameAsBegin) mode.end = mode.begin;
- if (!mode.end && !mode.endsWithParent) mode.end = /\B|\b/;
- if (mode.end) cmode.endRe = langRe(mode.end);
- cmode.terminator_end = source(mode.end) || '';
- if (mode.endsWithParent && parent.terminator_end) {
- cmode.terminator_end += (mode.end ? '|' : '') + parent.terminator_end;
- }
- }
- if (mode.illegal) cmode.illegalRe = langRe(mode.illegal);
- // eslint-disable-next-line no-undefined
- if (mode.relevance === undefined) mode.relevance = 1;
- if (!mode.contains) mode.contains = [];
- mode.contains = [].concat(...mode.contains.map(function(c) {
- return expand_or_clone_mode(c === 'self' ? mode : c);
- }));
- mode.contains.forEach(function(c) { compileMode(/** @type Mode */ (c), cmode); });
- if (mode.starts) {
- compileMode(mode.starts, parent);
- }
- cmode.matcher = buildModeRegex(cmode);
- return cmode;
- }
- // self is not valid at the top-level
- if (language.contains && language.contains.includes('self')) {
- throw new Error("ERR: contains `self` is not supported at the top-level of a language. See documentation.");
- }
- return compileMode(/** @type Mode */ (language));
- }
- /**
- * Determines if a mode has a dependency on it's parent or not
- *
- * If a mode does have a parent dependency then often we need to clone it if
- * it's used in multiple places so that each copy points to the correct parent,
- * where-as modes without a parent can often safely be re-used at the bottom of
- * a mode chain.
- *
- * @param {Mode | null} mode
- * @returns {boolean} - is there a dependency on the parent?
- * */
- function dependencyOnParent(mode) {
- if (!mode) return false;
- return mode.endsWithParent || dependencyOnParent(mode.starts);
- }
- /**
- * Expands a mode or clones it if necessary
- *
- * This is necessary for modes with parental dependenceis (see notes on
- * `dependencyOnParent`) and for nodes that have `variants` - which must then be
- * exploded into their own individual modes at compile time.
- *
- * @param {Mode} mode
- * @returns {Mode | Mode[]}
- * */
- function expand_or_clone_mode(mode) {
- if (mode.variants && !mode.cached_variants) {
- mode.cached_variants = mode.variants.map(function(variant) {
- return inherit(mode, { variants: null }, variant);
- });
- }
- // EXPAND
- // if we have variants then essentially "replace" the mode with the variants
- // this happens in compileMode, where this function is called from
- if (mode.cached_variants) {
- return mode.cached_variants;
- }
- // CLONE
- // if we have dependencies on parents then we need a unique
- // instance of ourselves, so we can be reused with many
- // different parents without issue
- if (dependencyOnParent(mode)) {
- return inherit(mode, { starts: mode.starts ? inherit(mode.starts) : null });
- }
- if (Object.isFrozen(mode)) {
- return inherit(mode);
- }
- // no special dependency issues, just return ourselves
- return mode;
- }
- /***********************************************
- Keywords
- ***********************************************/
- /**
- * Given raw keywords from a language definition, compile them.
- *
- * @param {string | Record<string,string>} rawKeywords
- * @param {boolean} case_insensitive
- */
- function compileKeywords(rawKeywords, case_insensitive) {
- /** @type KeywordDict */
- var compiled_keywords = {};
- if (typeof rawKeywords === 'string') { // string
- splitAndCompile('keyword', rawKeywords);
- } else {
- Object.keys(rawKeywords).forEach(function(className) {
- splitAndCompile(className, rawKeywords[className]);
- });
- }
- return compiled_keywords;
- // ---
- /**
- * Compiles an individual list of keywords
- *
- * Ex: "for if when while|5"
- *
- * @param {string} className
- * @param {string} keywordList
- */
- function splitAndCompile(className, keywordList) {
- if (case_insensitive) {
- keywordList = keywordList.toLowerCase();
- }
- keywordList.split(' ').forEach(function(keyword) {
- var pair = keyword.split('|');
- compiled_keywords[pair[0]] = [className, scoreForKeyword(pair[0], pair[1])];
- });
- }
- }
- /**
- * Returns the proper score for a given keyword
- *
- * Also takes into account comment keywords, which will be scored 0 UNLESS
- * another score has been manually assigned.
- * @param {string} keyword
- * @param {string} [providedScore]
- */
- function scoreForKeyword(keyword, providedScore) {
- // manual scores always win over common keywords
- // so you can force a score of 1 if you really insist
- if (providedScore) {
- return Number(providedScore);
- }
- return commonKeyword(keyword) ? 0 : 1;
- }
- /**
- * Determines if a given keyword is common or not
- *
- * @param {string} keyword */
- function commonKeyword(keyword) {
- return COMMON_KEYWORDS.includes(keyword.toLowerCase());
- }
- var version = "10.2.1";
- // @ts-nocheck
- function hasValueOrEmptyAttribute(value) {
- return Boolean(value || value === "");
- }
- const Component = {
- props: ["language", "code", "autodetect"],
- data: function() {
- return {
- detectedLanguage: "",
- unknownLanguage: false
- };
- },
- computed: {
- className() {
- if (this.unknownLanguage) return "";
- return "hljs " + this.detectedLanguage;
- },
- highlighted() {
- // no idea what language to use, return raw code
- if (!this.autoDetect && !hljs.getLanguage(this.language)) {
- console.warn(`The language "${this.language}" you specified could not be found.`);
- this.unknownLanguage = true;
- return escapeHTML(this.code);
- }
- let result;
- if (this.autoDetect) {
- result = hljs.highlightAuto(this.code);
- this.detectedLanguage = result.language;
- } else {
- result = hljs.highlight(this.language, this.code, this.ignoreIllegals);
- this.detectectLanguage = this.language;
- }
- return result.value;
- },
- autoDetect() {
- return !this.language || hasValueOrEmptyAttribute(this.autodetect);
- },
- ignoreIllegals() {
- return true;
- }
- },
- // this avoids needing to use a whole Vue compilation pipeline just
- // to build Highlight.js
- render(createElement) {
- return createElement("pre", {}, [
- createElement("code", {
- class: this.className,
- domProps: { innerHTML: this.highlighted }})
- ]);
- }
- // template: `<pre><code :class="className" v-html="highlighted"></code></pre>`
- };
- const VuePlugin = {
- install(Vue) {
- Vue.component('highlightjs', Component);
- }
- };
- /*
- Syntax highlighting with language autodetection.
- https://highlightjs.org/
- */
- const escape$1 = escapeHTML;
- const inherit$1 = inherit;
- const { nodeStream: nodeStream$1, mergeStreams: mergeStreams$1 } = utils;
- const NO_MATCH = Symbol("nomatch");
- /**
- * @param {any} hljs - object that is extended (legacy)
- * @returns {HLJSApi}
- */
- const HLJS = function(hljs) {
- // Convenience variables for build-in objects
- /** @type {unknown[]} */
- var ArrayProto = [];
- // Global internal variables used within the highlight.js library.
- /** @type {Record<string, Language>} */
- var languages = Object.create(null);
- /** @type {Record<string, string>} */
- var aliases = Object.create(null);
- /** @type {HLJSPlugin[]} */
- var plugins = [];
- // safe/production mode - swallows more errors, tries to keep running
- // even if a single syntax or parse hits a fatal error
- var SAFE_MODE = true;
- var fixMarkupRe = /(^(<[^>]+>|\t|)+|\n)/gm;
- var LANGUAGE_NOT_FOUND = "Could not find the language '{}', did you forget to load/include a language module?";
- /** @type {Language} */
- const PLAINTEXT_LANGUAGE = { disableAutodetect: true, name: 'Plain text', contains: [] };
- // Global options used when within external APIs. This is modified when
- // calling the `hljs.configure` function.
- /** @type HLJSOptions */
- var options = {
- noHighlightRe: /^(no-?highlight)$/i,
- languageDetectRe: /\blang(?:uage)?-([\w-]+)\b/i,
- classPrefix: 'hljs-',
- tabReplace: null,
- useBR: false,
- languages: null,
- // beta configuration options, subject to change, welcome to discuss
- // https://github.com/highlightjs/highlight.js/issues/1086
- __emitter: TokenTreeEmitter
- };
- /* Utility functions */
- /**
- * Tests a language name to see if highlighting should be skipped
- * @param {string} languageName
- */
- function shouldNotHighlight(languageName) {
- return options.noHighlightRe.test(languageName);
- }
- /**
- * @param {HighlightedHTMLElement} block - the HTML element to determine language for
- */
- function blockLanguage(block) {
- var classes = block.className + ' ';
- classes += block.parentNode ? block.parentNode.className : '';
- // language-* takes precedence over non-prefixed class names.
- const match = options.languageDetectRe.exec(classes);
- if (match) {
- var language = getLanguage(match[1]);
- if (!language) {
- console.warn(LANGUAGE_NOT_FOUND.replace("{}", match[1]));
- console.warn("Falling back to no-highlight mode for this block.", block);
- }
- return language ? match[1] : 'no-highlight';
- }
- return classes
- .split(/\s+/)
- .find((_class) => shouldNotHighlight(_class) || getLanguage(_class));
- }
- /**
- * Core highlighting function.
- *
- * @param {string} languageName - the language to use for highlighting
- * @param {string} code - the code to highlight
- * @param {boolean} [ignoreIllegals] - whether to ignore illegal matches, default is to bail
- * @param {Mode} [continuation] - current continuation mode, if any
- *
- * @returns {HighlightResult} Result - an object that represents the result
- * @property {string} language - the language name
- * @property {number} relevance - the relevance score
- * @property {string} value - the highlighted HTML code
- * @property {string} code - the original raw code
- * @property {Mode} top - top of the current mode stack
- * @property {boolean} illegal - indicates whether any illegal matches were found
- */
- function highlight(languageName, code, ignoreIllegals, continuation) {
- /** @type {{ code: string, language: string, result?: any }} */
- var context = {
- code,
- language: languageName
- };
- // the plugin can change the desired language or the code to be highlighted
- // just be changing the object it was passed
- fire("before:highlight", context);
- // a before plugin can usurp the result completely by providing it's own
- // in which case we don't even need to call highlight
- var result = context.result ?
- context.result :
- _highlight(context.language, context.code, ignoreIllegals, continuation);
- result.code = context.code;
- // the plugin can change anything in result to suite it
- fire("after:highlight", result);
- return result;
- }
- /**
- * private highlight that's used internally and does not fire callbacks
- *
- * @param {string} languageName - the language to use for highlighting
- * @param {string} code - the code to highlight
- * @param {boolean} [ignoreIllegals] - whether to ignore illegal matches, default is to bail
- * @param {Mode} [continuation] - current continuation mode, if any
- */
- function _highlight(languageName, code, ignoreIllegals, continuation) {
- var codeToHighlight = code;
- /**
- * Return keyword data if a match is a keyword
- * @param {CompiledMode} mode - current mode
- * @param {RegExpMatchArray} match - regexp match data
- * @returns {KeywordData | false}
- */
- function keywordData(mode, match) {
- var matchText = language.case_insensitive ? match[0].toLowerCase() : match[0];
- return Object.prototype.hasOwnProperty.call(mode.keywords, matchText) && mode.keywords[matchText];
- }
- function processKeywords() {
- if (!top.keywords) {
- emitter.addText(mode_buffer);
- return;
- }
- let last_index = 0;
- top.keywordPatternRe.lastIndex = 0;
- let match = top.keywordPatternRe.exec(mode_buffer);
- let buf = "";
- while (match) {
- buf += mode_buffer.substring(last_index, match.index);
- const data = keywordData(top, match);
- if (data) {
- const [kind, keywordRelevance] = data;
- emitter.addText(buf);
- buf = "";
- relevance += keywordRelevance;
- emitter.addKeyword(match[0], kind);
- } else {
- buf += match[0];
- }
- last_index = top.keywordPatternRe.lastIndex;
- match = top.keywordPatternRe.exec(mode_buffer);
- }
- buf += mode_buffer.substr(last_index);
- emitter.addText(buf);
- }
- function processSubLanguage() {
- if (mode_buffer === "") return;
- /** @type HighlightResult */
- var result = null;
- if (typeof top.subLanguage === 'string') {
- if (!languages[top.subLanguage]) {
- emitter.addText(mode_buffer);
- return;
- }
- result = _highlight(top.subLanguage, mode_buffer, true, continuations[top.subLanguage]);
- continuations[top.subLanguage] = result.top;
- } else {
- result = highlightAuto(mode_buffer, top.subLanguage.length ? top.subLanguage : null);
- }
- // Counting embedded language score towards the host language may be disabled
- // with zeroing the containing mode relevance. Use case in point is Markdown that
- // allows XML everywhere and makes every XML snippet to have a much larger Markdown
- // score.
- if (top.relevance > 0) {
- relevance += result.relevance;
- }
- emitter.addSublanguage(result.emitter, result.language);
- }
- function processBuffer() {
- if (top.subLanguage != null) {
- processSubLanguage();
- } else {
- processKeywords();
- }
- mode_buffer = '';
- }
- /**
- * @param {Mode} mode - new mode to start
- */
- function startNewMode(mode) {
- if (mode.className) {
- emitter.openNode(mode.className);
- }
- top = Object.create(mode, { parent: { value: top } });
- return top;
- }
- /**
- * @param {CompiledMode } mode - the mode to potentially end
- * @param {RegExpMatchArray} match - the latest match
- * @param {string} matchPlusRemainder - match plus remainder of content
- * @returns {CompiledMode | void} - the next mode, or if void continue on in current mode
- */
- function endOfMode(mode, match, matchPlusRemainder) {
- let matched = startsWith(mode.endRe, matchPlusRemainder);
- if (matched) {
- if (mode["on:end"]) {
- const resp = new Response(mode);
- mode["on:end"](match, resp);
- if (resp.ignore) matched = false;
- }
- if (matched) {
- while (mode.endsParent && mode.parent) {
- mode = mode.parent;
- }
- return mode;
- }
- }
- // even if on:end fires an `ignore` it's still possible
- // that we might trigger the end node because of a parent mode
- if (mode.endsWithParent) {
- return endOfMode(mode.parent, match, matchPlusRemainder);
- }
- }
- /**
- * Handle matching but then ignoring a sequence of text
- *
- * @param {string} lexeme - string containing full match text
- */
- function doIgnore(lexeme) {
- if (top.matcher.regexIndex === 0) {
- // no more regexs to potentially match here, so we move the cursor forward one
- // space
- mode_buffer += lexeme[0];
- return 1;
- } else {
- // no need to move the cursor, we still have additional regexes to try and
- // match at this very spot
- resumeScanAtSamePosition = true;
- return 0;
- }
- }
- /**
- * Handle the start of a new potential mode match
- *
- * @param {EnhancedMatch} match - the current match
- * @returns {number} how far to advance the parse cursor
- */
- function doBeginMatch(match) {
- var lexeme = match[0];
- var new_mode = match.rule;
- const resp = new Response(new_mode);
- // first internal before callbacks, then the public ones
- const beforeCallbacks = [new_mode.__beforeBegin, new_mode["on:begin"]];
- for (const cb of beforeCallbacks) {
- if (!cb) continue;
- cb(match, resp);
- if (resp.ignore) return doIgnore(lexeme);
- }
- if (new_mode && new_mode.endSameAsBegin) {
- new_mode.endRe = escape(lexeme);
- }
- if (new_mode.skip) {
- mode_buffer += lexeme;
- } else {
- if (new_mode.excludeBegin) {
- mode_buffer += lexeme;
- }
- processBuffer();
- if (!new_mode.returnBegin && !new_mode.excludeBegin) {
- mode_buffer = lexeme;
- }
- }
- startNewMode(new_mode);
- // if (mode["after:begin"]) {
- // let resp = new Response(mode);
- // mode["after:begin"](match, resp);
- // }
- return new_mode.returnBegin ? 0 : lexeme.length;
- }
- /**
- * Handle the potential end of mode
- *
- * @param {RegExpMatchArray} match - the current match
- */
- function doEndMatch(match) {
- var lexeme = match[0];
- var matchPlusRemainder = codeToHighlight.substr(match.index);
- var end_mode = endOfMode(top, match, matchPlusRemainder);
- if (!end_mode) { return NO_MATCH; }
- var origin = top;
- if (origin.skip) {
- mode_buffer += lexeme;
- } else {
- if (!(origin.returnEnd || origin.excludeEnd)) {
- mode_buffer += lexeme;
- }
- processBuffer();
- if (origin.excludeEnd) {
- mode_buffer = lexeme;
- }
- }
- do {
- if (top.className) {
- emitter.closeNode();
- }
- if (!top.skip && !top.subLanguage) {
- relevance += top.relevance;
- }
- top = top.parent;
- } while (top !== end_mode.parent);
- if (end_mode.starts) {
- if (end_mode.endSameAsBegin) {
- end_mode.starts.endRe = end_mode.endRe;
- }
- startNewMode(end_mode.starts);
- }
- return origin.returnEnd ? 0 : lexeme.length;
- }
- function processContinuations() {
- var list = [];
- for (var current = top; current !== language; current = current.parent) {
- if (current.className) {
- list.unshift(current.className);
- }
- }
- list.forEach(item => emitter.openNode(item));
- }
- /** @type {{type?: MatchType, index?: number, rule?: Mode}}} */
- var lastMatch = {};
- /**
- * Process an individual match
- *
- * @param {string} textBeforeMatch - text preceeding the match (since the last match)
- * @param {EnhancedMatch} [match] - the match itself
- */
- function processLexeme(textBeforeMatch, match) {
- var lexeme = match && match[0];
- // add non-matched text to the current mode buffer
- mode_buffer += textBeforeMatch;
- if (lexeme == null) {
- processBuffer();
- return 0;
- }
- // we've found a 0 width match and we're stuck, so we need to advance
- // this happens when we have badly behaved rules that have optional matchers to the degree that
- // sometimes they can end up matching nothing at all
- // Ref: https://github.com/highlightjs/highlight.js/issues/2140
- if (lastMatch.type === "begin" && match.type === "end" && lastMatch.index === match.index && lexeme === "") {
- // spit the "skipped" character that our regex choked on back into the output sequence
- mode_buffer += codeToHighlight.slice(match.index, match.index + 1);
- if (!SAFE_MODE) {
- /** @type {AnnotatedError} */
- const err = new Error('0 width match regex');
- err.languageName = languageName;
- err.badRule = lastMatch.rule;
- throw err;
- }
- return 1;
- }
- lastMatch = match;
- if (match.type === "begin") {
- return doBeginMatch(match);
- } else if (match.type === "illegal" && !ignoreIllegals) {
- // illegal match, we do not continue processing
- /** @type {AnnotatedError} */
- const err = new Error('Illegal lexeme "' + lexeme + '" for mode "' + (top.className || '<unnamed>') + '"');
- err.mode = top;
- throw err;
- } else if (match.type === "end") {
- var processed = doEndMatch(match);
- if (processed !== NO_MATCH) {
- return processed;
- }
- }
- // edge case for when illegal matches $ (end of line) which is technically
- // a 0 width match but not a begin/end match so it's not caught by the
- // first handler (when ignoreIllegals is true)
- if (match.type === "illegal" && lexeme === "") {
- // advance so we aren't stuck in an infinite loop
- return 1;
- }
- // infinite loops are BAD, this is a last ditch catch all. if we have a
- // decent number of iterations yet our index (cursor position in our
- // parsing) still 3x behind our index then something is very wrong
- // so we bail
- if (iterations > 100000 && iterations > match.index * 3) {
- const err = new Error('potential infinite loop, way more iterations than matches');
- throw err;
- }
- /*
- Why might be find ourselves here? Only one occasion now. An end match that was
- triggered but could not be completed. When might this happen? When an `endSameasBegin`
- rule sets the end rule to a specific match. Since the overall mode termination rule that's
- being used to scan the text isn't recompiled that means that any match that LOOKS like
- the end (but is not, because it is not an exact match to the beginning) will
- end up here. A definite end match, but when `doEndMatch` tries to "reapply"
- the end rule and fails to match, we wind up here, and just silently ignore the end.
- This causes no real harm other than stopping a few times too many.
- */
- mode_buffer += lexeme;
- return lexeme.length;
- }
- var language = getLanguage(languageName);
- if (!language) {
- console.error(LANGUAGE_NOT_FOUND.replace("{}", languageName));
- throw new Error('Unknown language: "' + languageName + '"');
- }
- var md = compileLanguage(language);
- var result = '';
- /** @type {CompiledMode} */
- var top = continuation || md;
- /** @type Record<string,Mode> */
- var continuations = {}; // keep continuations for sub-languages
- var emitter = new options.__emitter(options);
- processContinuations();
- var mode_buffer = '';
- var relevance = 0;
- var index = 0;
- var iterations = 0;
- var resumeScanAtSamePosition = false;
- try {
- top.matcher.considerAll();
- for (;;) {
- iterations++;
- if (resumeScanAtSamePosition) {
- // only regexes not matched previously will now be
- // considered for a potential match
- resumeScanAtSamePosition = false;
- } else {
- top.matcher.considerAll();
- }
- top.matcher.lastIndex = index;
- const match = top.matcher.exec(codeToHighlight);
- // console.log("match", match[0], match.rule && match.rule.begin)
- if (!match) break;
- const beforeMatch = codeToHighlight.substring(index, match.index);
- const processedCount = processLexeme(beforeMatch, match);
- index = match.index + processedCount;
- }
- processLexeme(codeToHighlight.substr(index));
- emitter.closeAllNodes();
- emitter.finalize();
- result = emitter.toHTML();
- return {
- relevance: relevance,
- value: result,
- language: languageName,
- illegal: false,
- emitter: emitter,
- top: top
- };
- } catch (err) {
- if (err.message && err.message.includes('Illegal')) {
- return {
- illegal: true,
- illegalBy: {
- msg: err.message,
- context: codeToHighlight.slice(index - 100, index + 100),
- mode: err.mode
- },
- sofar: result,
- relevance: 0,
- value: escape$1(codeToHighlight),
- emitter: emitter
- };
- } else if (SAFE_MODE) {
- return {
- illegal: false,
- relevance: 0,
- value: escape$1(codeToHighlight),
- emitter: emitter,
- language: languageName,
- top: top,
- errorRaised: err
- };
- } else {
- throw err;
- }
- }
- }
- /**
- * returns a valid highlight result, without actually doing any actual work,
- * auto highlight starts with this and it's possible for small snippets that
- * auto-detection may not find a better match
- * @param {string} code
- * @returns {HighlightResult}
- */
- function justTextHighlightResult(code) {
- const result = {
- relevance: 0,
- emitter: new options.__emitter(options),
- value: escape$1(code),
- illegal: false,
- top: PLAINTEXT_LANGUAGE
- };
- result.emitter.addText(code);
- return result;
- }
- /**
- Highlighting with language detection. Accepts a string with the code to
- highlight. Returns an object with the following properties:
- - language (detected language)
- - relevance (int)
- - value (an HTML string with highlighting markup)
- - second_best (object with the same structure for second-best heuristically
- detected language, may be absent)
- @param {string} code
- @param {Array<string>} [languageSubset]
- @returns {AutoHighlightResult}
- */
- function highlightAuto(code, languageSubset) {
- languageSubset = languageSubset || options.languages || Object.keys(languages);
- var result = justTextHighlightResult(code);
- var secondBest = result;
- languageSubset.filter(getLanguage).filter(autoDetection).forEach(function(name) {
- var current = _highlight(name, code, false);
- current.language = name;
- if (current.relevance > secondBest.relevance) {
- secondBest = current;
- }
- if (current.relevance > result.relevance) {
- secondBest = result;
- result = current;
- }
- });
- if (secondBest.language) {
- // second_best (with underscore) is the expected API
- result.second_best = secondBest;
- }
- return result;
- }
- /**
- Post-processing of the highlighted markup:
- - replace TABs with something more useful
- - replace real line-breaks with '<br>' for non-pre containers
- @param {string} html
- @returns {string}
- */
- function fixMarkup(html) {
- if (!(options.tabReplace || options.useBR)) {
- return html;
- }
- return html.replace(fixMarkupRe, match => {
- if (match === '\n') {
- return options.useBR ? '<br>' : match;
- } else if (options.tabReplace) {
- return match.replace(/\t/g, options.tabReplace);
- }
- return match;
- });
- }
- /**
- * Builds new class name for block given the language name
- *
- * @param {string} prevClassName
- * @param {string} [currentLang]
- * @param {string} [resultLang]
- */
- function buildClassName(prevClassName, currentLang, resultLang) {
- var language = currentLang ? aliases[currentLang] : resultLang;
- var result = [prevClassName.trim()];
- if (!prevClassName.match(/\bhljs\b/)) {
- result.push('hljs');
- }
- if (!prevClassName.includes(language)) {
- result.push(language);
- }
- return result.join(' ').trim();
- }
- /**
- * Applies highlighting to a DOM node containing code. Accepts a DOM node and
- * two optional parameters for fixMarkup.
- *
- * @param {HighlightedHTMLElement} element - the HTML element to highlight
- */
- function highlightBlock(element) {
- /** @type HTMLElement */
- let node = null;
- const language = blockLanguage(element);
- if (shouldNotHighlight(language)) return;
- fire("before:highlightBlock",
- { block: element, language: language });
- if (options.useBR) {
- // node = document.createElement('div');
- node = document.createElement('view');
- node.innerHTML = element.innerHTML.replace(/\n/g, '').replace(/<br[ /]*>/g, '\n');
- } else {
- node = element;
- }
- const text = node.textContent;
- const result = language ? highlight(language, text, true) : highlightAuto(text);
- const originalStream = nodeStream$1(node);
- if (originalStream.length) {
- // const resultNode = document.createElement('div');
- const resultNode = document.createElement('view');
- resultNode.innerHTML = result.value;
- result.value = mergeStreams$1(originalStream, nodeStream$1(resultNode), text);
- }
- result.value = fixMarkup(result.value);
- fire("after:highlightBlock", { block: element, result: result });
- element.innerHTML = result.value;
- element.className = buildClassName(element.className, language, result.language);
- element.result = {
- language: result.language,
- // TODO: remove with version 11.0
- re: result.relevance,
- relavance: result.relevance
- };
- if (result.second_best) {
- element.second_best = {
- language: result.second_best.language,
- // TODO: remove with version 11.0
- re: result.second_best.relevance,
- relavance: result.second_best.relevance
- };
- }
- }
- /**
- * Updates highlight.js global options with the passed options
- *
- * @param {{}} userOptions
- */
- function configure(userOptions) {
- options = inherit$1(options, userOptions);
- }
- /**
- * Highlights to all <pre><code> blocks on a page
- *
- * @type {Function & {called?: boolean}}
- */
- const initHighlighting = () => {
- if (initHighlighting.called) return;
- initHighlighting.called = true;
- var blocks = document.querySelectorAll('pre code')
-
- };
- // Higlights all when DOMContentLoaded fires
- function initHighlightingOnLoad() {
- // @ts-ignore
- window.addEventListener('DOMContentLoaded', initHighlighting, false);
- }
- /**
- * Register a language grammar module
- *
- * @param {string} languageName
- * @param {LanguageFn} languageDefinition
- */
- function registerLanguage(languageName, languageDefinition) {
- var lang = null;
- try {
- lang = languageDefinition(hljs);
- } catch (error) {
- console.error("Language definition for '{}' could not be registered.".replace("{}", languageName));
- // hard or soft error
- if (!SAFE_MODE) { throw error; } else { console.error(error); }
- // languages that have serious errors are replaced with essentially a
- // "plaintext" stand-in so that the code blocks will still get normal
- // css classes applied to them - and one bad language won't break the
- // entire highlighter
- lang = PLAINTEXT_LANGUAGE;
- }
- // give it a temporary name if it doesn't have one in the meta-data
- if (!lang.name) lang.name = languageName;
- languages[languageName] = lang;
- lang.rawDefinition = languageDefinition.bind(null, hljs);
- if (lang.aliases) {
- registerAliases(lang.aliases, { languageName });
- }
- }
- /**
- * @returns {string[]} List of language internal names
- */
- function listLanguages() {
- return Object.keys(languages);
- }
- /**
- intended usage: When one language truly requires another
- Unlike `getLanguage`, this will throw when the requested language
- is not available.
- @param {string} name - name of the language to fetch/require
- @returns {Language | never}
- */
- function requireLanguage(name) {
- var lang = getLanguage(name);
- if (lang) { return lang; }
- var err = new Error('The \'{}\' language is required, but not loaded.'.replace('{}', name));
- throw err;
- }
- /**
- * @param {string} name - name of the language to retrieve
- * @returns {Language | undefined}
- */
- function getLanguage(name) {
- name = (name || '').toLowerCase();
- return languages[name] || languages[aliases[name]];
- }
- /**
- *
- * @param {string|string[]} aliasList - single alias or list of aliases
- * @param {{languageName: string}} opts
- */
- function registerAliases(aliasList, { languageName }) {
- if (typeof aliasList === 'string') {
- aliasList = [aliasList];
- }
- aliasList.forEach(alias => { aliases[alias] = languageName; });
- }
- /**
- * Determines if a given language has auto-detection enabled
- * @param {string} name - name of the language
- */
- function autoDetection(name) {
- var lang = getLanguage(name);
- return lang && !lang.disableAutodetect;
- }
- /**
- * @param {HLJSPlugin} plugin
- */
- function addPlugin(plugin) {
- plugins.push(plugin);
- }
- /**
- *
- * @param {PluginEvent} event
- * @param {any} args
- */
- function fire(event, args) {
- var cb = event;
- plugins.forEach(function(plugin) {
- if (plugin[cb]) {
- plugin[cb](args);
- }
- });
- }
- /* fixMarkup is deprecated and will be removed entirely in v11 */
- function deprecate_fixMarkup(arg) {
- console.warn("fixMarkup is deprecated and will be removed entirely in v11.0");
- console.warn("Please see https://github.com/highlightjs/highlight.js/issues/2534");
- return fixMarkup(arg)
- }
- /* Interface definition */
- Object.assign(hljs, {
- highlight,
- highlightAuto,
- fixMarkup: deprecate_fixMarkup,
- highlightBlock,
- configure,
- initHighlighting,
- initHighlightingOnLoad,
- registerLanguage,
- listLanguages,
- getLanguage,
- registerAliases,
- requireLanguage,
- autoDetection,
- inherit: inherit$1,
- addPlugin,
- // plugins for frameworks
- vuePlugin: VuePlugin
- });
- hljs.debugMode = function() { SAFE_MODE = false; };
- hljs.safeMode = function() { SAFE_MODE = true; };
- hljs.versionString = version;
- for (const key in MODES) {
- // @ts-ignore
- if (typeof MODES[key] === "object") {
- // @ts-ignore
- deepFreeze(MODES[key]);
- }
- }
- // merge all the modes/regexs into our main object
- Object.assign(hljs, MODES);
- return hljs;
- };
- // export an "instance" of the highlighter
- var highlight = HLJS({});
- module.exports = highlight;
|