| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291 |
- // FIXME: Strikethrough
- // FIXME: Modifiers not applying
-
- class MDTokenType {
- static Text = new MDTokenType('Text');
- static Whitespace = new MDTokenType('Whitespace');
-
- static Underscore = new MDTokenType('Underscore');
- static Asterisk = new MDTokenType('Asterisk');
- static Slash = new MDTokenType('Slash');
- static Tilde = new MDTokenType('Tilde');
- static Bang = new MDTokenType('Bang');
- static Backtick = new MDTokenType('Backtick');
- static Equal = new MDTokenType('Equal');
- static Caret = new MDTokenType('Caret');
-
- static Label = new MDTokenType('Label'); // content=label
- static URL = new MDTokenType('URL'); // content=URL, extra=title
- static Email = new MDTokenType('Email'); // content=email address, extra=title
- static SimpleLink = new MDTokenType('SimpleLink'); // content=URL
- static SimpleEmail = new MDTokenType('SimpleEmail'); // content=email address
- static Footnote = new MDTokenType('Footnote'); // content=symbol
- static Modifier = new MDTokenType('Modifier'); // content
-
- static HTMLTag = new MDTokenType('HTMLTag'); // content=tag string, tag=MDHTMLTag
-
- static META_AnyNonWhitespace = new MDTokenType('METAAnyNonWhitespace');
- static META_OptionalWhitespace = new MDTokenType('METAOptionalWhitespace');
-
- /** @type {string} */
- name;
-
- /**
- * @param {string} name
- */
- constructor(name) {
- this.name = name;
- }
-
- toString() {
- return `${this.constructor.name}.${this.name}`;
- }
-
- equals(other) {
- return (other instanceof MDTokenType) && other.name == this.name;
- }
- }
-
- class MDToken {
- /**
- * The original token string.
- * @type {string}
- */
- original;
- /** @type {MDTokenType} */
- type;
- /** @type {string|null} */
- content;
- /** @type {string|null} */
- extra;
- /** @type {MDHTMLTag|null} */
- tag;
- /** @type {MDTagModifier|null} */
- modifier;
-
- /**
- * @param {string} original
- * @param {MDTokenType} type
- * @param {string|MDTagModifier|null} content
- * @param {string|null} extra
- * @param {MDHTMLTag|null} tag
- */
- constructor(original, type, content=null, extra=null, tag=null) {
- this.original = original;
- this.type = type;
- if (content instanceof MDTagModifier) {
- this.content = null;
- this.modifier = content;
- } else {
- this.content = content;
- this.modifier = null;
- }
- this.extra = extra;
- this.tag = tag;
- }
-
- toString() {
- return `(${this.constructor.name} type=${this.type.toString()} content=${this.content})`;
- }
-
- /**
- * Searches an array of MDToken for the given pattern of MDTokenTypes.
- * If found, returns an object with the given keys.
- * - `tokens: MDToken[]` - the subarray of `tokensToSearch` that match the pattern
- * - `index: number` - index into `tokensToSearch` of first matching token
- *
- * @param {MDToken[]|MDNode[]} tokensToSearch - mixed array of `MDToken` and `MDNode` elements
- * @param {MDTokenType[]} pattern - contiguous run of token types to find
- * @param {number} startIndex - token index to begin searching (defaults to 0)
- * @returns {object|null} match object as described, or `null` if not found
- */
- static findFirstTokens(tokensToSearch, pattern, startIndex=0) {
- var matched = [];
- for (var t = startIndex; t < tokensToSearch.length; t++) {
- var matchedAll = true;
- matched = [];
- var patternOffset = 0;
- for (var p = 0; p < pattern.length; p++) {
- var t0 = t + p + patternOffset;
- if (t0 >= tokensToSearch.length) return null;
- let token = tokensToSearch[t0];
- let elem = pattern[p];
- if (elem == MDTokenType.META_OptionalWhitespace) {
- if (token instanceof MDToken && token.type == MDTokenType.Whitespace) {
- matched.push(token);
- } else {
- patternOffset--;
- }
- } else if (elem == MDTokenType.META_AnyNonWhitespace) {
- if (token instanceof MDToken && token.type == MDTokenType.Whitespace) {
- matchedAll = false;
- break;
- }
- matched.push(token);
- } else {
- if (!(token instanceof MDToken) || token.type != elem) {
- matchedAll = false;
- break;
- }
- matched.push(token);
- }
- }
- if (matchedAll) {
- return {
- 'tokens': matched,
- 'index': t,
- };
- }
- }
- return null;
- }
-
- /**
- * Searches an array of MDToken for a given starting pattern and ending
- * pattern and returns match info about both and the tokens in between.
- *
- * If `contentValidator` is specified, it will be called with the content
- * tokens of a potential match. If the validator returns `true`, the result
- * will be accepted and returned by this method. If the validator returns
- * `false`, this method will keep looking for another matching pair. If no
- * validator is given the first match will be returned regardless of content.
- *
- * If a match is found, returns an object with the given keys:
- * - `startTokens: MDToken[]` - tokens that matched `startPattern`
- * - `contentTokens: MDToken[]` - tokens between the start and end pattern. May be an empty array.
- * - `endTokens: MDToken[]` - tokens that matched `endPattern`
- * - `startIndex: number` - index into `tokensToSearch` where `startPattern` begins
- * - `contentIndex: number` - index into `tokensToSearch` of the first token that is between the start and end patterns
- * - `endIndex: number` - index into `tokensToSearch` where `endPattern` begins
- * - `totalLength: number` - total number of matched tokens
- *
- * @param {MDToken[]} tokensToSearch - array of `MDToken` to search in
- * @param {MDTokenType[]} startPattern - array of `MDTokenType` to find first
- * @param {MDTokenType[]} endPattern - array of `MDTokenType` to find positioned after `startPattern`
- * @param {function|null} contentValidator - optional validator function. If provided, will be passed an array of inner `MDToken`, and the function can return `true` to accept the contents or `false` to keep searching
- * @param {number} startIndex - token index where searching should begin
- * @returns {object|null} match object
- */
- static findPairedTokens(tokensToSearch, startPattern, endPattern, contentValidator=null, startIndex=0) {
- for (var s = startIndex; s < tokensToSearch.length; s++) {
- var startMatch = this.findFirstTokens(tokensToSearch, startPattern, s);
- if (startMatch === null) return null;
- var endStart = startMatch.index + startMatch.tokens.length;
- while (endStart < tokensToSearch.length) {
- var endMatch = this.findFirstTokens(tokensToSearch, endPattern, endStart);
- if (endMatch === null) break;
- var contents = tokensToSearch.slice(startMatch.index + startMatch.tokens.length, endMatch.index);
- if (contents.length > 0 && (contentValidator === null || contentValidator(contents))) {
- return {
- 'startTokens': startMatch.tokens,
- 'contentTokens': contents,
- 'endTokens': endMatch.tokens,
- 'startIndex': startMatch.index,
- 'contentIndex': startMatch.index + startMatch.tokens.length,
- 'endIndex': endMatch.index,
- 'totalLength': endMatch.index + endMatch.tokens.length - startMatch.index,
- };
- } else {
- // Contents rejected. Try next end match.
- endStart = endMatch.index + 1;
- }
- }
- // No end matches. Increment start match.
- s = startMatch.index;
- }
- return null;
- }
-
- equals(other) {
- if (!(other instanceof MDToken)) return false;
- if (other.original !== this.original) return false;
- if (!other.type.equals(this.type)) return false;
- if (other.content !== this.content) return false;
- if (other.extra !== this.extra) return false;
- if (!MDUtils.equal(other.tag, this.tag)) return false;
- if (!MDUtils.equals(other.modifier, this.modifier)) return false;
- return true
- }
- }
-
- class MDUtils {
- // Modified from https://urlregex.com/ to remove capture groups. Matches fully qualified URLs only.
- static baseURLRegex = /(?:(?:(?:[a-z]{3,9}:(?:\/\/)?)(?:[\-;:&=\+\$,\w]+@)?[a-z0-9\.\-]+|(?:www\.|[\-;:&=\+\$,\w]+@)[a-z0-9\.\-]+)(?:(?:\/[\+~%\/\.\w\-_]*)?\??(?:[\-\+=&;%@\.\w_]*)#?(?:[\.\!\/\\\w]*))?)/i;
- // Modified from https://emailregex.com/ to remove capture groups.
- static baseEmailRegex = /(?:(?:[^<>()\[\]\\.,;:\s@"]+(?:\.[^<>()\[\]\\.,;:\s@"]+)*)|(?:".+"))@(?:(?:\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(?:(?:[a-z\-0-9]+\.)+[a-z]{2,}))/i;
-
- /**
- * Escapes special HTML characters.
- *
- * @param {string} str - string to escape
- * @param {boolean} encodeNewlinesAsBreaks - whether to convert newline characters to `<br>` tags
- * @returns {string} escaped HTML
- */
- static escapeHTML(str, encodeNewlinesAsBreaks=false) {
- if (typeof str !== 'string') return '';
- var html = str.replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"');
- if (encodeNewlinesAsBreaks) {
- html = html.replace(/\n/g, "<br>\n");
- }
- return html;
- }
-
- /**
- * Converts HTML entities to characters. HTML tags are ignored.
- * @param {string} html
- * @returns {string} plain text
- */
- static unescapeHTML(html, decodeBRsAsNewlines=false) {
- if (decodeBRsAsNewlines) {
- html = html.replace(/<br[\/]?>\n?/g, "\n");
- }
- const doc = (new DOMParser()).parseFromString(html, "text/html");
- return doc.documentElement.textContent;
- }
-
- /**
- * Encodes characters as HTML numeric entities to make it marginally more
- * difficult for web scrapers to grab sensitive info. If `text` starts with
- * `mailto:` only the email address following it will be obfuscated.
- *
- * @param {string} text - text to escape
- * @returns {string} escaped HTML
- */
- static escapeObfuscated(text) {
- if (text.startsWith('mailto:')) {
- return 'mailto:' + this.escapeObfuscated(text.substring(7));
- }
- var html = '';
- for (var p = 0; p < text.length; p++) {
- const cp = text.codePointAt(p);
- html += `&#${cp};`;
- }
- return html;
- }
-
- /**
- * Removes illegal characters from an HTML attribute name.
- * @param {string} name
- * @returns {string}
- */
- static scrubAttributeName(name) {
- return name.replace(/[\t\n\f \/>"'=]+/, '');
- }
-
- /**
- * Strips one or more leading indents from a line or lines of markdown. An
- * indent is defined as 4 spaces or one tab. Incomplete indents (i.e. 1-3
- * spaces) are treated like one indent level.
- *
- * @param {string|string[]} line - string or strings to strip
- * @param {number} levels - how many indent levels to strip
- * @returns {string|string[]} stripped lines
- */
- static stripIndent(line, levels=1) {
- const regex = new RegExp(`^(?: {1,4}|\t){${levels}}`);
- return (line instanceof Array) ? line.map((l) => l.replace(regex, '')) : line.replace(regex, '');
- }
-
- /**
- * Returns a copy of an array without any whitespace-only lines at the end.
- *
- * @param {String[]} lines - text lines
- * @returns {String[]} - text lines without trailing blank lines
- */
- static withoutTrailingBlankLines(lines) {
- var stripped = lines.slice();
- while (stripped.length > 0 && stripped[stripped.length - 1].trim().length == 0) {
- stripped.pop();
- }
- return stripped;
- }
-
- /**
- * Tests if an array of lines contains at least one blank. A blank line
- * can contain whitespace.
- *
- * @param {String[]} lines
- * @returns {boolean} whether `lines` contains any whitespace-only lines
- */
- static containsBlankLine(lines) {
- for (const line of lines) {
- if (line.trim().length == 0) return true;
- }
- return false;
- }
-
- /**
- * Counts the number of indent levels in a line of text. Partial indents
- * (1 to 3 spaces) are counted as one indent level unless `fullIndentsOnly`
- * is `true`.
- *
- * @param {string} line - line of markdown
- * @param {boolean} fullIndentsOnly - whether to only count full indent levels (4 spaces or a tab)
- * @returns {number} number of indent levels found
- */
- static countIndents(line, fullIndentsOnly=false) {
- // normalize indents to tabs
- return line.replace(fullIndentsOnly
- ? /(?: {4}|\t)/g
- : /(?: {1,4}|\t)/g,
- "\t")
- // remove content after indent
- .replace(/^(\t*)(.*?)$/, '$1')
- // count tabs
- .length;
- }
-
- /**
- * Attempts to parse a label from the beginning of `line`. A label is of the
- * form `[content]`. If found, returns an array with element 0 being the
- * entire label and element 1 being the content of the label.
- *
- * @param {string} line
- * @returns {string[]|null} match groups or null if not found
- */
- static tokenizeLabel(line) {
- if (!line.startsWith('[')) return null;
- var parenCount = 0;
- var bracketCount = 0;
- for (var p = 1; p < line.length; p++) {
- let ch = line.substring(p, p + 1);
- if (ch == '\\') {
- p++;
- } else if (ch == '(') {
- parenCount++;
- } else if (ch == ')') {
- parenCount--;
- if (parenCount < 0) return null;
- } else if (ch == '[') {
- bracketCount++;
- } else if (ch == ']') {
- if (bracketCount > 0) {
- bracketCount--;
- } else {
- return [ line.substring(0, p + 1), line.substring(1, p) ];
- }
- }
- }
- return null;
- }
-
- static #urlWithTitleRegex = /^\((\S+?)\s+"(.*?)"\)/i; // 1=URL, 2=title
- static #urlRegex = /^\((\S+?)\)/i; // 1=URL
-
- /**
- * Attempts to parse a URL from the beginning of `line`. A URL is of the
- * form `(url)` or `(url "title")`. If found, returns an array with element
- * 0 being the entire URL token, 1 is the URL, 2 is the optional title.
- *
- * @param {string} line
- * @returns {string[]} token tuple
- */
- static tokenizeURL(line) {
- var groups;
- if (groups = this.#urlWithTitleRegex.exec(line)) {
- if (this.tokenizeEmail(line)) return null; // make sure it's not better described as an email address
- return groups;
- }
- if (groups = this.#urlRegex.exec(line)) {
- if (this.tokenizeEmail(line)) return null;
- return [...groups, null];
- }
- return null;
- }
-
- static #emailWithTitleRegex = new RegExp("^\\(\\s*(" + MDUtils.baseEmailRegex.source + ")\\s+\"(.*?)\"\\s*\\)", "i"); // 1=email, 2=title
- static #emailRegex = new RegExp("^\\(\\s*(" + MDUtils.baseEmailRegex.source + ")\\s*\\)", "i"); // 1=email
-
- /**
- * Attempts to parse an email address from the beginning of `line`. An
- * email address is of the form `(user@example.com)` or `(user@example.com "link title")`.
- * If found, returns an array with element 0 being the entire token, 1 is the
- * email address, and 2 is the optional link title.
- *
- * @param {string} line
- * @returns {string[]} token tuple
- */
- static tokenizeEmail(line) {
- var groups;
- if (groups = this.#emailWithTitleRegex.exec(line)) {
- return groups;
- }
- if (groups = this.#emailRegex.exec(line)) {
- return [...groups, null];
- }
- return null;
- }
-
- /**
- * Describes the type of a variable for debugging.
- *
- * @param {any} value - value
- * @returns {String} description of type
- */
- static typename(value) {
- if (value === null) return 'null';
- if (value instanceof Object) {
- return value.constructor.name;
- }
- return typeof value;
- }
-
- static #equalArrays(a, b) {
- if (a === b) return true;
- if (!(a instanceof Array) || !(b instanceof Array)) return false;
- if (a == null || b == null) return false;
- if (a.length != b.length) return false;
- for (var i = 0; i < a.length; i++) {
- if (!this.equal(a[i], b[i])) return false;
- }
- return true;
- }
-
- static #equalObjects(a, b) {
- if (a === b) return true;
- if (!(a instanceof Object) || !(b instanceof Object)) return false;
- if (a == null || b == null) return false;
- if (a.equals !== undefined) {
- return a.equals(b);
- }
- for (const key of Object.keys(a)) {
- if (!this.equal(a[key], b[key])) return false;
- }
- for (const key of Object.keys(b)) {
- if (!this.equal(a[key], b[key])) return false;
- }
- return true;
- }
-
- /**
- * Tests for equality on lots of different kinds of values including objects
- * and arrays. Will use `.equals` on objects that implement it.
- *
- * @param {any} a
- * @param {any} b
- * @returns {boolean}
- */
- static equal(a, b, floatDifferencePercent=0.0) {
- if (a instanceof Array && b instanceof Array) {
- return this.#equalArrays(a, b);
- }
- if (a instanceof Object && b instanceof Object) {
- return this.#equalObjects(a, b);
- }
- if (typeof a == 'number' && typeof b == 'number') {
- if (a === b) return true;
- const delta = b - a;
- const ratio = delta / a;
- return Math.abs(ratio) <= floatDifferencePercent;
- }
- return a == b;
- }
-
- /**
- * @param {string} text
- */
- static escapeRegex(text) {
- // Partially following escaping scheme from not-yet-widely-supported RegExp.escape.
- // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/escape
- const escapeHex = function(ch) {
- const codepoint = ch.codePointAt(0);
- const s = '00' + codepoint.toString(16);
- return `\\x${s.substring(s.length - 2)}`;
- }
- var escaped = '';
- const l = text.length;
- for (var i = 0; i < l; i++) {
- const ch = text.substring(i, i + 1);
- if (i == 0 && /[a-zA-Z0-9]/.exec(ch)) {
- escaped += escapeHex(ch);
- } else if ("^$\\.*+?()[]{}|/".indexOf(ch) >= 0) {
- escaped += `\\${ch}`;
- } else if (",-=<>#&!%:;@~'`\"".indexOf(ch) >= 0) {
- escaped += escapeHex(ch);
- } else if (ch == '\f') {
- escaped += "\\f";
- } else if (ch == '\n') {
- escaped += "\\n";
- } else if (ch == '\r') {
- escaped += "\\r";
- } else if (ch == '\t') {
- escaped += "\\t";
- } else if (ch == '\v') {
- escaped += "\\v";
- } else {
- escaped += ch;
- }
- }
- return escaped;
- }
-
- /**
- * Recursively search and replaces nodes in a tree. The given `replacer` is
- * passed every node in the tree. If the function returns a new `MDNode` the
- * original will be replaced with it. If the function returns `null` no
- * change will be made to that node. Traversal is depth-first.
- *
- * @param {MDState} state
- * @param {MDNode[]} nodes
- * @param {function} replacer - takes a node as an argument, returns either a new node or `null` to leave it unchanged
- */
- static replaceNodes(state, nodes, replacer) {
- for (var i = 0; i < nodes.length; i++) {
- var originalNode = nodes[i];
- const replacement = replacer(originalNode);
- if (replacement !== null) {
- nodes.splice(i, 1, replacement);
- } else {
- this.replaceNodes(state, originalNode.children, replacer);
- }
- }
- }
- }
-
- /**
- * Parsing and rendering state
- */
- class MDState {
- /**
- * Ascends the parent chain to the root `MDState` instance. This should be
- * used when referencing most stored fields except `lines` and `p`.
- *
- * @type {MDState}
- */
- get root() { return this.#parent ? this.#parent.root : this; }
-
- /**
- * Lines of the markdown document. The current line index is pointed to by `p`.
- *
- * @returns {string[]} markdown lines
- */
- get lines() { return this.#lines; }
-
- /**
- * The current line in `lines`.
- *
- * @returns {string|null} current line or `null` if out of content
- */
- get currentLine() { return (this.p < this.#lines.length) ? this.#lines[this.p] : null; }
-
- /**
- * Current line pointer into array `lines`.
- *
- * @type {number} line pointer
- */
- p = 0;
-
- /** @type {string[]} */
- #lines = [];
-
- /** @type {MDState|null} */
- #parent = null;
-
- /**
- * Tuples of `priority:number` and `MDReader` sorted by `blockPriority`.
- * @type {Array}
- */
- #readersByBlockPriority = [];
-
- /**
- * Tuples of `priority:number` and `MDReader` sorted by `tokenizePriority`.
- * @type {Array}
- */
- #readersByTokenPriority = [];
-
- /**
- * Tuples of `priority:number` and `MDReader` sorted by `substitutePriority`.
- * @type {Array}
- */
- #readersBySubstitutePriority = [];
-
- /**
- * Mapping of reference symbols to URLs.
- * @type {object}
- */
- #referenceToURL = {};
-
- /**
- * Mapping of reference symbols to titles.
- * @type {object}
- */
- #referenceToTitle = {};
-
- static #textWhitespaceRegex = /^(\s*)(?:(\S|\S.*\S)(\s*?))?$/; // 1=leading WS, 2=text, 3=trailing WS
-
- /**
- * @param {string[]} lines - lines of markdown text
- * @param {Array} readersByBlockPriority - tuple arrays of priority and MDReader
- * @param {Array} readersByTokenPriority - tuple arrays of priority and MDReader
- * @param {Array} readersBySubstitutePriority - tuple arrays of priority and MDReader
- */
- constructor(lines,
- readersByBlockPriority=null,
- readersByTokenPriority=null,
- readersBySubstitutePriority=null) {
- this.#lines = lines;
- this.#readersByBlockPriority = readersByBlockPriority
- this.#readersByTokenPriority = readersByTokenPriority
- this.#readersBySubstitutePriority = readersBySubstitutePriority
- }
-
- /**
- * Creates a copy of this state with new lines. Useful for parsing nested
- * content.
- *
- * @param {string[]} lines
- * @returns {MDState} copied sub-state
- */
- copy(lines) {
- let cp = new MDState(lines);
- cp.#parent = this;
- return cp;
- }
-
- /**
- * Tests if there are at least `minCount` lines available to read. If `p`
- * is not provided it will be relative to `this.p`.
- *
- * @param {number} minCount - minimum number of lines
- * @param {number|null} p - line pointer, or `null` to use `this.p`
- * @returns {boolean} whether at least the given number of lines is available
- */
- hasLines(minCount, p=null) {
- let relativeTo = (p === null) ? this.p : p;
- return relativeTo + minCount <= this.lines.length;
- }
-
- /**
- * Reads and returns an array of blocks from the current line pointer.
- *
- * @returns {MDBlockNode[]} parsed blocks
- */
- readBlocks() {
- var blocks = [];
- while (this.hasLines(1)) {
- let block = this.#readNextBlock();
- if (block) {
- blocks.push(block);
- } else {
- break;
- }
- }
- return blocks;
- }
-
- /**
- * Creates a simple `MDBlockNode` if no other registered blocks match.
- *
- * @returns {MDBlockNode|null} fallback block
- */
- #readFallbackBlock() {
- if (this.p >= this.lines.length) return null;
- const lines = MDUtils.withoutTrailingBlankLines(this.lines.slice(this.p));
- if (lines.length == 0) return null;
- this.p = this.lines.length;
- return this.inlineMarkdownToNode(lines.join("\n"));
- }
-
- /**
- * Attempts to read one block from the current line pointer. The pointer
- * will be positioned just after the end of the block.
- *
- * @param {MDState} state
- * @returns {MDBlockNode|null}
- */
- #readNextBlock() {
- while (this.hasLines(1) && this.lines[this.p].trim().length == 0) {
- this.p++;
- }
- if (!this.hasLines(1)) return null;
- for (const tuple of this.root.#readersByBlockPriority) {
- var reader = tuple[1];
- const startP = this.p;
- const block = reader.readBlock(this);
- if (block) {
- if (this.p == startP) {
- throw new Error(`${reader.constructor.name} returned an ${block.constructor.name} without incrementing MDState.p. This could lead to an infinite loop.`);
- }
- return block;
- }
- }
- const fallback = this.#readFallbackBlock();
- return fallback;
- }
-
- /**
- * @param {string} line
- * @returns {MDToken[]}
- */
- #inlineMarkdownToTokens(line) {
- if (this.#parent) return this.#parent.#inlineMarkdownToTokens(line);
-
- var tokens = [];
- var text = '';
- var expectLiteral = false;
-
- /**
- * Flushes accumulated content in `text` to `tokens`.
- */
- const endText = function() {
- if (text.length == 0) return;
- const textGroups = MDState.#textWhitespaceRegex.exec(text);
- if (textGroups !== null) {
- if (textGroups[1].length > 0) {
- tokens.push(new MDToken(textGroups[1], MDTokenType.Whitespace, textGroups[1]));
- }
- if (textGroups[2] !== undefined && textGroups[2].length > 0) {
- tokens.push(new MDToken(textGroups[2], MDTokenType.Text, textGroups[2]));
- }
- if (textGroups[3] !== undefined && textGroups[3].length > 0) {
- tokens.push(new MDToken(textGroups[3], MDTokenType.Whitespace, textGroups[3]));
- }
- } else {
- tokens.push(new MDToken(text, MDTokenType.Text, text));
- }
- text = '';
- }
-
- for (var p = 0; p < line.length; p++) {
- const ch = line.substring(p, p + 1);
- const remainder = line.substring(p);
- if (expectLiteral) {
- text += ch;
- expectLiteral = false;
- continue;
- }
- if (ch == '\\') {
- expectLiteral = true;
- continue;
- }
- var found = false;
- for (const readerTuple of this.root.#readersByTokenPriority) {
- /** @type {number} */
- const priority = readerTuple[0];
- /** @type {MDReader} */
- const reader = readerTuple[1];
- const token = reader.readToken(this, remainder);
- if (token === null) continue;
- if (token === undefined) {
- console.warn(`${reader.constructor.name}.readToken returned undefined instead of null`);
- }
- endText();
- tokens.push(token);
- if (token.original == null || token.original.length == 0) {
- throw new Error(`${reader.constructor.name} returned a token with an empty .original. This would cause an infinite loop.`);
- }
- p += token.original.length - 1;
- found = true;
- break;
- }
- if (!found) {
- text += ch;
- }
- }
- endText();
- return tokens;
- }
-
- /**
- * Converts a line of markdown to an `MDInlineNode`.
- *
- * @param {string|string[]} line
- * @returns {MDInlineNode}
- */
- inlineMarkdownToNode(line) {
- let nodes = this.inlineMarkdownToNodes(line);
- return (nodes.length == 1) ? nodes[0] : new MDInlineNode(nodes);
- }
-
- /**
- * Converts a line of markdown to an array of `MDInlineNode`s.
- *
- * @param {string|string[]} line
- * @returns {MDInlineNode[]}
- */
- inlineMarkdownToNodes(line) {
- var tokens = this.#inlineMarkdownToTokens((line instanceof Array) ? line.join('\n') : line);
- return this.tokensToNodes(tokens);
- }
-
- /**
- * Converts a mixed array of `MDToken` and `MDInlineNode` elements into an array
- * of only `MDInlineNode`.
- *
- * @param {MDToken[]|MDInlineNode[]} tokens
- * @returns {MDInlineNode[]}
- */
- tokensToNodes(tokens) {
- var nodes = tokens.slice();
-
- // Perform repeated substitutions, converting sequences of tokens into
- // nodes, until no more substitutions can be made.
- var anyChanges = false;
- do {
- anyChanges = false;
- for (const readerTuple of this.root.#readersBySubstitutePriority) {
- /** @type {number} */
- const priority = readerTuple[0];
- /** @type {MDReader} */
- const reader = readerTuple[1];
- const changed = reader.substituteTokens(this, priority, nodes);
- if (!changed) continue;
- anyChanges = true;
- break;
- }
- } while (anyChanges);
-
- // Convert any remaining tokens to nodes, apply CSS modifiers.
- var lastNode = null;
- nodes = nodes.map(function(node) {
- if (node instanceof MDToken) {
- /** @type {MDToken} */
- const token = node;
- if (token.type == MDTokenType.Modifier && lastNode) {
- token.modifier.applyTo(lastNode);
- lastNode = null;
- return new MDTextNode('');
- }
- lastNode = null;
- return new MDTextNode(token.original);
- } else if (node instanceof MDNode) {
- lastNode = (node instanceof MDTextNode) ? null : node;
- return node;
- } else {
- throw new Error(`Unexpected node type ${node.constructor.name}`);
- }
- });
-
- return nodes;
- }
-
- /**
- * Defines a URL by reference symbol.
- *
- * @param {string} reference - case-insensitive reference symbol
- * @param {string} url - URL to map the symbol to
- * @param {string|null} title - optional link title
- */
- defineURL(reference, url, title=null) {
- this.root.#referenceToURL[reference.toLowerCase()] = url;
- if (title !== null) this.root.#referenceToTitle[reference.toLowerCase()] = title;
- }
-
- /**
- * Returns the URL associated with a reference symbol.
- *
- * @param {string} reference - case-insensitive reference symbol
- * @returns {string|null} URL for the given reference, or `null` if not defined
- */
- urlForReference(reference) {
- return this.root.#referenceToURL[reference.toLowerCase()] ?? null;
- }
-
- /**
- * Returns the link title associated with a reference symbol.
- *
- * @param {string} reference - case-insensitive reference symbol
- * @returns {string|null} link title for the given reference, or `null` if not defined
- */
- urlTitleForReference(reference) {
- return this.root.#referenceToTitle[reference.toLowerCase()] ?? null;
- }
- }
-
-
- // -- Readers ---------------------------------------------------------------
-
-
- /**
- * Base class for readers of various markdown syntax. A `Markdown` instance can
- * be created with any combination of subclasses of these to customize the
- * flavor of markdown parsed.
- *
- * Parsing occurs in three phases, and `MDReader` implementations can implement
- * any combination of these.
- * 1. **Blocks** - Processing an array of lines to find block-level structures,
- * such as paragraphs, lists, tables, blockquotes, etc. and converting them
- * into block-level `MDNode`s.
- * 2. **Inline tokens** - Carving up single lines of markdown into tokens for
- * inline formatting, such as strong, emphasis, links, images, etc.
- * 3. **Inline substitution** - Finding patterns of tokens and substituting them
- * with `MDNode`s.
- *
- * Each parsing phase consults each registered reader, checking if its
- * recognized syntax is located in a given place in the markdown. The order
- * the readers are tested is affected by priority values for each phase. This
- * allows syntactic ambiguities to be resolved in a consistent way (e.g.
- * `\*\*strong\*\*` and `\*emphasis\*` using similar syntax).
- */
- class MDReader {
- /**
- * Block reading priority for this reader. Priority is a unitless relative
- * value used for sorting readers in the block reading process. Core readers
- * use a range of 0 to 100 but any value is permitted. Generally, more
- * distinctive, unambiguous block syntax should be prioritized first (low
- * priority number), while more general block syntax like paragraphs should
- * be prioritized last (high priority number). If the reader has no block-level
- * elements, can be set to `null` to skip during that phase.
- *
- * @type {number|null}
- */
- get blockPriority() { return this.#blockPriority; };
- #blockPriority;
-
- /**
- * Inline tokenization priority for this reader. Priority is a unitless
- * relative value used for sorting readers in the tokenization process.
- * Core readers use a range of 0 to 100 but any value is permitted.
- * Generally, more distinctive, unambiguous token formats should be
- * prioritized first (low priority number), while more general, ambiguous
- * tokens should be prioritized last (high priority number). If the reader
- * has no inline-level elements, can be set to `null` to skip that phase.
- *
- * @type {number|null}
- */
- get tokenizePriority() { return this.#tokenizePriority; };
- #tokenizePriority;
-
- /**
- * Inline token substitution priority/priorities for this reader. Priority
- * is a unitless relative value or values for sorting readers in the
- * tokenization process. Core readers use a range of 0 to 100 but any value
- * is permitted. Generally, more distinctive, unambiguous patterns should
- * be prioritized first (low priority number), while more general, ambiguous
- * patterns should be prioritized last (high priority number).
- *
- * This property can be an array of numbers, in monotonically increasing
- * order. In that case, the same reader will occur 2 or more times in the
- * prioritization list. This can be useful when a reader handles multiple
- * patterns of differing priority. When `substituteTokens` is called, the
- * current priority is passed to differentiate which pass is being done.
- *
- * If the reader has no inline-level elements, can be set to `null` to skip
- * that phase.
- *
- * @type {number|number[]|null}
- */
- get substitutePriority() { return this.#substitutePriority; };
- #substitutePriority;
-
- constructor(blockPriority=100, tokenizePriority=100, substitutePriority=100) {
- this.#blockPriority = blockPriority;
- this.#tokenizePriority = tokenizePriority;
- this.#substitutePriority = substitutePriority;
- }
-
- /**
- * Called before processing begins. `state.lines` is populated and the
- * line pointer `state.p` will be at `0`. Default implementation does nothing.
- *
- * @param {MDState} state
- */
- preProcess(state) {}
-
- /**
- * Attempts to read an `MDBlockNode` subclass at the current line pointer
- * `state.p`. Only matches if the block pattern starts at the line pointer,
- * not elsewhere in the `state.lines` array. If a block is found, `state.p`
- * should be incremented to the next line _after_ the block structure and
- * a `MDBlockNode` subclass instance is returned. If no block is found,
- * returns `null`.
- *
- * @param {MDState} state
- * @returns {MDBlockNode|null} found block, or `null` if not found
- */
- readBlock(state) { return null; }
-
- /**
- * Attempts to read a token from the beginning of `line`. Only the start of
- * the given `line` is considered. If a matching token is found, an
- * `MDToken` is returned. Otherwise `null` is returned.
- *
- * @param {MDState} state
- * @param {string} line - string to check for a leading token
- * @returns {MDToken|null} found token, or `null` if not found
- */
- readToken(state, line) { return null; }
-
- /**
- * Attempts to find a pattern in `tokens` and perform an in-place substitution
- * with one or more `MDNode` subclass instances.
- *
- * @param {MDState} state
- * @param {number} priority
- * @param {Array} tokens - mixed array of `MDToken` and `MDInlineNode` elements
- * @returns {boolean} `true` if a substitution was performed, `false` if not
- */
- substituteTokens(state, priority, tokens) { return false; }
-
- /**
- * Called after all parsing has completed. An array `blocks` is passed of all
- * top-level `MDBlockNode` elements is passed which can be altered in-place
- * via `.splice` operations if necessary.
- *
- * `MDNode.visitChildren` is useful for recursively looking for certain
- * `MDNode` instances. `MDUtils.replaceNodes` is useful for swapping in
- * replacements.
- *
- * @param {MDState} state
- * @param {MDBlockNode[]} blocks
- */
- postProcess(state, blocks) {}
- }
-
- /**
- * Reads markdown blocks for headers denoted with the underline syntax.
- *
- * Example:
- *
- * > ```markdown
- * > Header 1
- * > ========
- * > ```
- */
- class MDUnderlinedHeaderReader extends MDReader {
- readBlock(state) {
- var p = state.p;
- if (!state.hasLines(2)) return null;
- var modifier;
- let contentLine = state.lines[p++].trim();
- [contentLine, modifier] = MDTagModifier.fromLine(contentLine);
- let underLine = state.lines[p++].trim();
- if (contentLine == '') return null;
- if (/^=+$/.exec(underLine)) {
- state.p = p;
- let block = new MDHeaderNode(1, state.inlineMarkdownToNodes(contentLine));
- if (modifier) modifier.applyTo(block);
- return block;
- }
- if (/^\-+$/.exec(underLine)) {
- state.p = p;
- let block = new MDHeaderNode(2, state.inlineMarkdownToNodes(contentLine));
- if (modifier) modifier.applyTo(block);
- return block;
- }
- return null;
- }
- }
-
- /**
- * Reads markdown blocks for headers denoted with hash marks. Header levels 1 to
- * 6 are supported.
- *
- * Examples:
- *
- * > ```markdown
- * > # Header 1
- * >
- * > ## Header 2
- * >
- * > # Enclosing Hashes Are Optional #
- * >
- * > ## Trailing Hashes Don't Have to Match in Number ####
- * > ```
- */
- class MDHashHeaderReader extends MDReader {
- static #hashHeaderRegex = /^(#{1,6})\s*([^#].*?)\s*\#*\s*$/; // 1=hashes, 2=content
-
- readBlock(state) {
- var p = state.p;
- let line = state.lines[p++];
- var modifier;
- [line, modifier] = MDTagModifier.fromLine(line);
- var groups = MDHashHeaderReader.#hashHeaderRegex.exec(line);
- if (groups === null) return null;
- state.p = p;
- const level = groups[1].length;
- const content = groups[2];
- let block = new MDHeaderNode(level, state.inlineMarkdownToNodes(content));
- if (modifier) modifier.applyTo(block);
- return block;
- }
- }
-
- class MDSubtextReader extends MDReader {
- static #subtextRegex = /^\-#\s*(.*?)\s*$/; // 1=content
-
- readBlock(state) {
- var p = state.p;
- let line = state.lines[p++];
- var modifier;
- [line, modifier] = MDTagModifier.fromLine(line);
- var groups = MDSubtextReader.#subtextRegex.exec(line);
- if (groups === null) return null;
- state.p = p;
- const content = groups[1];
- let block = new MDSubtextNode(state.inlineMarkdownToNodes(content));
- if (modifier) modifier.applyTo(block);
- return block;
- }
- }
-
- /**
- * Reads markdown blocks for blockquoted text.
- *
- * Example:
- *
- * > ```markdown
- * > > Blockquoted text
- * > ```
- */
- class MDBlockQuoteReader extends MDReader {
- readBlock(state) {
- var blockquoteLines = [];
- var p = state.p;
- while (p < state.lines.length) {
- let line = state.lines[p++];
- if (line.startsWith(">")) {
- blockquoteLines.push(line);
- } else {
- break;
- }
- }
- if (blockquoteLines.length > 0) {
- let contentLines = blockquoteLines.map(function(line) {
- return line.substring(1).replace(/^ {0,3}\t?/, '');
- });
- let substate = state.copy(contentLines);
- let quotedBlocks = substate.readBlocks();
- state.p = p;
- return new MDBlockquoteNode(quotedBlocks);
- }
- return null;
- }
- }
-
- /**
- * Abstract base class for ordered and unordered lists.
- */
- class _MDListReader extends MDReader {
- #readItemLines(state, firstLineStartPos) {
- var p = state.p;
- var lines = [];
- var seenBlankLine = false;
- var stripTrailingBlankLines = true;
- while (state.hasLines(1, p)) {
- const isFirstLine = p == state.p;
- var line = state.lines[p++];
- if (isFirstLine) {
- line = line.substring(firstLineStartPos);
- }
- if (/^(?:\*|\+|\-|\d+\.)\s+/.exec(line)) {
- // Found next list item
- stripTrailingBlankLines = false; // because this signals extra spacing intended
- break;
- }
- const isBlankLine = line.trim().length == 0;
- const isIndented = /^\s+\S/.exec(line) !== null;
- if (isBlankLine) {
- seenBlankLine = true;
- } else if (!isIndented && seenBlankLine) {
- // Post-list content
- break;
- }
- lines.push(line);
- }
- lines = MDUtils.withoutTrailingBlankLines(lines);
- return MDUtils.stripIndent(lines);
- }
-
- /**
- * @param {MDState} state
- * @param {number} firstLineStart
- * @return {MDBlockNode}
- */
- _readListItemContent(state, firstLineStartPos) {
- const itemLines = this.#readItemLines(state, firstLineStartPos);
- state.p += Math.max(itemLines.length, 1);
-
- if (itemLines.length == 1) {
- return state.inlineMarkdownToNode(itemLines[0]);
- }
-
- const hasBlankLines = itemLines.filter((line) => line.trim().length == 0).length > 0;
- if (hasBlankLines) {
- const substate = state.copy(itemLines);
- const blocks = substate.readBlocks();
- return (blocks.length == 1) ? blocks[0] : new MDNode(blocks);
- }
-
- // Multiline content with no blank lines. Search for new block
- // boundaries without the benefit of a blank line to demarcate it.
- for (var p = 1; p < itemLines.length; p++) {
- const line = itemLines[p];
- if (/^(?:\*|\-|\+|\d+\.)\s+/.exec(line)) {
- // Nested list found
- const firstBlock = state.inlineMarkdownToNode(itemLines.slice(0, p).join("\n"));
- const substate = state.copy(itemLines.slice(p));
- const blocks = substate.readBlocks();
- return new MDNode([ firstBlock, ...blocks ]);
- }
- }
-
- // Ok, give up and just do a standard block read
- {
- const substate = state.copy(itemLines);
- const blocks = substate.readBlocks();
- return (blocks.length == 1) ? blocks[0] : new MDNode(blocks);
- }
- }
-
- readBlock(state) {
- throw new Error(`Abstract readBlock must be overridden in ${this.constructor.name}`);
- }
- }
-
- /**
- * Block reader for unordered (bulleted) lists.
- *
- * Example:
- *
- * > ```markdown
- * > * First item
- * > * Second item
- * > * Third item
- * > ```
- */
- class MDUnorderedListReader extends _MDListReader {
- static #unorderedListRegex = /^([\*\+\-]\s+)(.*)$/; // 1=bullet, 2=content
-
- /**
- * @param {MDState} state
- * @returns {MDListItemNode|null}
- */
- #readUnorderedListItem(state) {
- var p = state.p;
- let line = state.lines[p];
- let groups = MDUnorderedListReader.#unorderedListRegex.exec(line);
- if (groups === null) return null;
- const firstLineOffset = groups[1].length;
- return new MDListItemNode(this._readListItemContent(state, firstLineOffset));
- }
-
- readBlock(state) {
- var items = [];
- var item = null;
- do {
- item = this.#readUnorderedListItem(state);
- if (item) items.push(item);
- } while (item);
- if (items.length == 0) return null;
- return new MDUnorderedListNode(items);
- }
- }
-
- /**
- * Block reader for ordered (numbered) lists. The number of the first item is
- * used to begin counting. The subsequent items increase by 1, regardless of
- * their value.
- *
- * Example:
- *
- * > ```markdown
- * > 1. First
- * > 2. Second
- * > 3. Third
- * > ```
- */
- class MDOrderedListReader extends _MDListReader {
- static #orderedListRegex = /^(\d+)(\.\s+)(.*)$/; // 1=number, 2=dot, 3=content
-
- /**
- * @param {MDState} state
- * @returns {MDListItemNode|null}
- */
- #readOrderedListItem(state) {
- var p = state.p;
- let line = state.lines[p];
- let groups = MDOrderedListReader.#orderedListRegex.exec(line);
- if (groups === null) return null;
- const ordinal = parseInt(groups[1]);
- const firstLineOffset = groups[1].length + groups[2].length;
- return new MDListItemNode(this._readListItemContent(state, firstLineOffset), ordinal);
- }
-
- readBlock(state) {
- var items = [];
- var item = null;
- do {
- item = this.#readOrderedListItem(state);
- if (item) items.push(item);
- } while (item);
- if (items.length == 0) return null;
- return new MDOrderedListNode(items, items[0].ordinal);
- }
- }
-
- /**
- * Block reader for code blocks denoted by pairs of triple tickmarks.
- *
- * Example:
- *
- * > ```markdown
- * > \`\`\`
- * > function formattedAsCode() {
- * > }
- * > \`\`\`
- * > ```
- */
- class MDFencedCodeBlockReader extends MDReader {
- readBlock(state) {
- if (!state.hasLines(2)) return null;
- var p = state.p;
- let openFenceLine = state.lines[p++];
- var modifier;
- [openFenceLine, modifier] = MDTagModifier.fromLine(openFenceLine);
- if (openFenceLine.trim() != '```') return null;
- var codeLines = [];
- while (state.hasLines(1, p)) {
- let line = state.lines[p++];
- if (line.trim() == '```') {
- state.p = p;
- let block = new MDCodeBlockNode(codeLines.join("\n"));
- if (modifier) modifier.applyTo(block);
- return block;
- }
- codeLines.push(line);
- }
- return null;
- }
- }
-
- /**
- * Block reader for code blocks denoted by indenting text.
- *
- * Example (indent spaces rendered visibly for clarity):
- *
- * > ```markdown
- * > ⎵⎵⎵⎵function formattedAsCode() {
- * > ⎵⎵⎵⎵}
- * > ```
- */
- class MDIndentedCodeBlockReader extends MDReader {
- readBlock(state) {
- var p = state.p;
- var codeLines = [];
- while (state.hasLines(1, p)) {
- let line = state.lines[p++];
- if (MDUtils.countIndents(line, true) < 1) {
- p--;
- break;
- }
- codeLines.push(MDUtils.stripIndent(line));
- }
- if (codeLines.length == 0) return null;
- state.p = p;
- return new MDCodeBlockNode(codeLines.join("\n"));
- }
- }
-
- /**
- * Block reader for horizontal rules. Composed of three or more hypens or
- * asterisks on a line by themselves, with or without intermediate whitespace.
- *
- * Examples:
- *
- * > ```markdown
- * > ---
- * >
- * > - - -
- * >
- * > * * * * *
- * >
- * > ****
- * > ```
- */
- class MDHorizontalRuleReader extends MDReader {
- static #horizontalRuleRegex = /^\s*(?:\-(?:\s*\-){2,}|\*(?:\s*\*){2,})\s*$/;
-
- readBlock(state) {
- var p = state.p;
- let line = state.lines[p++];
- var modifier;
- [line, modifier] = MDTagModifier.fromLine(line);
- if (MDHorizontalRuleReader.#horizontalRuleRegex.exec(line)) {
- state.p = p;
- let block = new MDHorizontalRuleNode();
- if (modifier) modifier.applyTo(block);
- return block;
- }
- return null;
- }
- }
-
- /**
- * Block reader for tables.
- *
- * Examples:
- *
- * > ```markdown
- * > Name | Age
- * > --- | ---
- * > Joe | 34
- * > Alice | 25
- * >
- * > | Leading | And Trailing |
- * > | - | - |
- * > | Required | for single column tables |
- * >
- * > | Left aligned column | Center aligned | Right aligned |
- * > | :-- | :--: | --: |
- * > | Joe | x | 34 |
- * > ```
- */
- class MDTableReader extends MDReader {
- /**
- * @param {MDState} state
- * @param {boolean} isHeader
- * @return {MDTableRowNode|null}
- */
- #readTableRow(state, isHeader) {
- if (!state.hasLines(1)) return null;
- var p = state.p;
- let line = MDTagModifier.strip(state.lines[p++].trim());
- if (/.*\|.*/.exec(line) === null) return null;
- if (line.startsWith('|')) line = line.substring(1);
- if (line.endsWith('|')) line = line.substring(0, line.length - 1);
- let cellTokens = line.split('|');
- let cells = cellTokens.map(function(token) {
- let content = state.inlineMarkdownToNode(token.trim());
- return isHeader ? new MDTableHeaderCellNode(content) : new MDTableCellNode(content);
- });
- state.p = p;
- return new MDTableRowNode(cells);
- }
-
- /**
- * @param {string} line
- * @returns {string[]}
- */
- #parseColumnAlignments(line) {
- line = line.trim();
- if (line.startsWith('|')) line = line.substring(1);
- if (line.endsWith('|')) line = line.substring(0, line.length - 1);
- return line.split(/\s*\|\s*/).map(function(token) {
- if (token.startsWith(':')) {
- if (token.endsWith(':')) {
- return 'center';
- }
- return 'left';
- } else if (token.endsWith(':')) {
- return 'right';
- }
- return null;
- });
- }
-
- static #tableDividerRegex = /^\s*[|]?\s*(?:[:]?-+[:]?)(?:\s*\|\s*[:]?-+[:]?)*\s*[|]?\s*$/;
-
- readBlock(state) {
- if (!state.hasLines(2)) return null;
- let startP = state.p;
- let firstLine = state.lines[startP];
- var modifier = MDTagModifier.fromLine(firstLine)[1];
- let headerRow = this.#readTableRow(state, true);
- if (headerRow === null) {
- state.p = startP;
- return null;
- }
- let dividerLine = state.lines[state.p++];
- let dividerGroups = MDTableReader.#tableDividerRegex.exec(dividerLine);
- if (dividerGroups === null) {
- state.p = startP;
- return null;
- }
- let columnAlignments = this.#parseColumnAlignments(dividerLine);
- var bodyRows = [];
- while (state.hasLines(1)) {
- let row = this.#readTableRow(state, false);
- if (row === null) break;
- bodyRows.push(row);
- }
- let table = new MDTableNode(headerRow, bodyRows);
- table.columnAlignments = columnAlignments;
- if (modifier) modifier.applyTo(table);
- return table;
- }
- }
-
- /**
- * Block reader for definition lists. Definitions go directly under terms starting
- * with a colon.
- *
- * Example:
- *
- * > ```markdown
- * > markdown
- * > : a language for generating HTML from simplified syntax
- * > parser
- * > : code that converts human-readable code into machine language
- * > ```
- */
- class MDDefinitionListReader extends MDReader {
- readBlock(state) {
- var p = state.p;
- var groups;
- var termCount = 0;
- var definitionCount = 0;
- var defLines = [];
- while (state.hasLines(1, p)) {
- let line = state.lines[p++];
- if (line.trim().length == 0) {
- break;
- }
- if (/^\s+/.exec(line)) {
- if (defLines.length == 0) return null;
- defLines[defLines.length - 1] += "\n" + line;
- } else if (/^:\s+/.exec(line)) {
- defLines.push(line);
- definitionCount++;
- } else {
- defLines.push(line);
- termCount++;
- }
- }
- if (termCount == 0 || definitionCount == 0) return null;
- let blocks = defLines.map(function(line) {
- if (groups = /^:\s+(.*?)$/s.exec(line)) {
- return new MDDefinitionListDefinitionNode(state.inlineMarkdownToNodes(groups[1]));
- } else {
- return new MDDefinitionListTermNode(state.inlineMarkdownToNodes(line));
- }
- });
- state.p = p;
- return new MDDefinitionListNode(blocks);
- }
- }
-
- /**
- * Block reader for defining footnote contents. Footnotes can be defined anywhere
- * in the document but will always be rendered at the end of a page or end of
- * the document.
- *
- * Examples:
- *
- * > ```markdown
- * > [^1]: Content of a footnote. Anywhere `[^1]` appears in the
- * > main text, it will hyperlink to this content at the bottom
- * > of the document. There will also be backlinks at the end
- * > of this footnote to all references to it.
- * > ```
- */
- class MDFootnoteReader extends MDReader {
- static #footnoteWithTitleRegex = /^\[\^([^\]]+?)\s+"(.*?)"\]/; // 1=symbol, 2=title
- static #footnoteRegex = /^\[\^([^\]]+?)\]/; // 1=symbol
-
- /**
- * @param {MDState} state
- * @param {string} symbol
- * @param {MDNode[]} content
- */
- #defineFootnote(state, symbol, footnote) {
- var footnotes = state.root['footnotes'] ?? {};
- footnotes[symbol] = footnote;
- state.root['footnotes'] = footnotes;
- }
-
- /**
- * @param {MDState} state
- * @param {string} symbol
- * @param {number} unique
- */
- #registerUniqueInstance(state, symbol, unique) {
- var footnoteInstances = state.root['footnoteInstances'];
- var instances = footnoteInstances[symbol] ?? [];
- instances.push(unique);
- footnoteInstances[symbol] = instances;
- }
-
- #idForFootnoteSymbol(state, symbol) {
- var footnoteIds = state.root['footnoteIds'];
- const existing = footnoteIds[symbol];
- if (existing) return existing;
- var nextFootnoteId = state.root['nextFootnoteId'];
- const id = nextFootnoteId++;
- footnoteIds[symbol] = id;
- state.root['nextFootnoteId'] = nextFootnoteId;
- return id;
- }
-
- preProcess(state) {
- state.root['footnoteInstances'] = {};
- state.root['footnotes'] = {};
- state.root['footnoteIds'] = {};
- state.root['nextFootnoteId'] = 1;
- }
-
- /**
- * @param {MDState} state
- */
- readBlock(state) {
- var p = state.p;
- let groups = /^\s*\[\^\s*([^\]]+)\s*\]:\s+(.*)\s*$/.exec(state.lines[p++]);
- if (groups === null) return null;
- let symbol = groups[1];
- let def = groups[2];
- while (state.hasLines(1, p)) {
- let line = state.lines[p++];
- if (/^\s+/.exec(line)) {
- def += "\n" + line;
- } else {
- p--;
- break;
- }
- }
- let content = state.inlineMarkdownToNodes(def);
- this.#defineFootnote(state, symbol, content);
- state.p = p;
- return new MDNode(); // empty
- }
-
- readToken(state, line) {
- var groups;
- if (groups = MDFootnoteReader.#footnoteWithTitleRegex.exec(line)) {
- return new MDToken(groups[0], MDTokenType.Footnote, groups[1], groups[2]);
- }
- if (groups = MDFootnoteReader.#footnoteRegex.exec(line)) {
- return new MDToken(groups[0], MDTokenType.Footnote, groups[1]);
- }
- return null;
- }
-
- substituteTokens(state, priority, tokens) {
- var match;
- if (match = MDToken.findFirstTokens(tokens, [ MDTokenType.Footnote ])) {
- let symbol = match.tokens[0].content;
- tokens.splice(match.index, 1, new MDFootnoteNode(symbol));
- return true;
- }
- return false;
- }
-
- /**
- * @param {MDState} state
- * @param {MDBlockNode[]} blocks
- */
- postProcess(state, blocks) {
- var nextOccurrenceId = 1;
- for (const block of blocks) {
- const me = this;
- block.visitChildren((function(node) {
- if (!(node instanceof MDFootnoteNode)) return;
- node.footnoteId = me.#idForFootnoteSymbol(state, node.symbol);
- node.occurrenceId = nextOccurrenceId++;
- node.displaySymbol = `${node.footnoteId}`;
- me.#registerUniqueInstance(state, node.symbol, node.occurrenceId);
- }).bind(this));
- }
- if (Object.keys(state.footnotes).length == 0) return;
- blocks.push(new MDFootnoteListNode());
- }
- }
-
- /**
- * Block reader for abbreviation definitions. Anywhere the abbreviation appears
- * in the text will have its definition available when hovering over it.
- * Definitions can appear anywhere in the document. Their content should only
- * contain simple text, not markdown.
- *
- * Example:
- *
- * > ```markdown
- * > *[HTML]: Hyper Text Markup Language
- * > ```
- */
- class MDAbbreviationReader extends MDReader {
- /**
- * @param {MDState} state
- * @param {string} abbreviation
- * @param {string} definition
- */
- #defineAbbreviation(state, abbreviation, definition) {
- state.abbreviations[abbreviation] = definition;
- const regex = new RegExp("\\b(" + MDUtils.escapeRegex(abbreviation) + ")\\b", "ig");
- state.abbreviationRegexes[abbreviation] = regex;
- }
-
- preProcess(state) {
- state.root['abbreviations'] = {};
- state.root['abbreviationRegexes'] = {};
- }
-
- readBlock(state) {
- var p = state.p;
- let line = state.lines[p++];
- let groups = /^\s*\*\[([^\]]+?)\]:\s+(.*?)\s*$/.exec(line);
- if (groups === null) return null;
- let abbrev = groups[1];
- let def = groups[2];
- this.#defineAbbreviation(state, abbrev, def);
- state.p = p;
- return new MDNode(); // empty
- }
-
- /**
- * @param {MDState} state
- * @param {MDNode[]} blocks
- */
- postProcess(state, blocks) {
- const abbreviations = state.root['abbreviations'];
- const regexes = state.root['abbreviationRegexes'];
- MDUtils.replaceNodes(state, blocks, (original) => {
- if (!(original instanceof MDTextNode)) return null;
- var changed = false;
- var elems = [ original.text ]; // mix of strings and MDNodes
- for (var i = 0; i < elems.length; i++) {
- var text = elems[i];
- if (typeof text !== 'string') continue;
- for (const abbreviation in abbreviations) {
- const groups = regexes[abbreviation].exec(text);
- if (groups === null) continue;
- const definition = abbreviations[abbreviation];
- const prefix = text.substring(0, groups.index);
- const suffix = text.substring(groups.index + groups[0].length);
- elems.splice(i, 1, prefix, new MDAbbreviationNode(groups[0], definition), suffix);
- i = -1; // start over
- changed = true;
- break;
- }
- }
- if (!changed) return null;
- const nodes = elems.map((elem) => typeof elem === 'string' ? new MDTextNode(elem) : elem);
- return new MDNode(nodes);
- });
- }
- }
-
- /**
- * Block reader for simple paragraphs. Paragraphs are separated by a blank (or
- * whitespace-only) line. This reader should be prioritized last since there
- * is no distinguishing syntax.
- *
- * Example:
- *
- * > ```markdown
- * > Lorem ipsum dolor
- * > sit amet. This is all one paragraph.
- * >
- * > Beginning of a new paragraph.
- * > ```
- */
- class MDParagraphReader extends MDReader {
- readBlock(state) {
- var paragraphLines = [];
- var p = state.p;
- while (p < state.lines.length) {
- let line = state.lines[p++];
- if (line.trim().length == 0) {
- break;
- }
- paragraphLines.push(line);
- }
- if (state.p == 0 && p >= state.lines.length) {
- // If it's the entire document don't wrap it in a paragraph
- return null;
- }
- if (paragraphLines.length > 0) {
- state.p = p;
- let content = paragraphLines.join("\n");
- return new MDParagraphNode(state.inlineMarkdownToNodes(content));
- }
- return null;
- }
- }
-
- /**
- * Abstract base class for readers that look for one or more delimiting tokens
- * around some content.
- */
- class MDSimplePairInlineReader extends MDReader {
- /**
- * Attempts a substitution of a matched pair of delimiting token types.
- * If successful, the substitution is performed on `tokens` and `true` is
- * returned, otherwise `false` is returned and the array is untouched.
- *
- * If multiple `substitutePriority` values are specified, the first pass
- * will reject matches with the delimiting character inside the content
- * tokens. If a single `substitutePriority` is given or a subsequent pass
- * is performed with multiple values any contents will be accepted.
- *
- * @param {MDState} state
- * @param {number} priority
- * @param {MDToken[]} tokens
- * @param {class} nodeClass
- * @param {MDTokenType} delimiter
- * @param {number} count - how many times the token is repeated to form the delimiter
- * @returns {boolean} `true` if substitution performed, `false` if not
- */
- attemptPair(state, priority, tokens, nodeClass, delimiter, count=1, plaintext=false) {
- let delimiters = Array(count).fill(delimiter);
- let firstPassPriority = (this.substitutePriority instanceof Array) ? this.substitutePriority[0] : null;
- let match = MDToken.findPairedTokens(tokens, delimiters, delimiters, function(content) {
- const firstType = content[0] instanceof MDToken ? content[0].type : null;
- const lastType = content[content.length - 1] instanceof MDToken ? content[content.length - 1].type : null;
- if (firstType == MDTokenType.Whitespace) return false;
- if (lastType == MDTokenType.Whitespace) return false;
- if (priority == firstPassPriority) {
- var innerCount = 0;
- for (let token of content) {
- if (token instanceof MDToken && token.type == delimiter) innerCount++;
- }
- if ((innerCount % 2) != 0) return false;
- }
- return true;
- });
- if (match === null) return false;
- let content = (plaintext)
- ? match.contentTokens.map((token) => token.original).join('')
- : state.tokensToNodes(match.contentTokens);
- tokens.splice(match.startIndex, match.totalLength, new nodeClass(content));
- return true;
- }
- }
-
- class MDEmphasisReader extends MDSimplePairInlineReader {
- readToken(state, line) {
- if (line.startsWith('*')) return new MDToken('*', MDTokenType.Asterisk);
- if (line.startsWith('_')) return new MDToken('_', MDTokenType.Underscore);
- return null;
- }
-
- substituteTokens(state, priority, tokens) {
- if (this.attemptPair(state, priority, tokens, MDEmphasisNode, MDTokenType.Asterisk)) return true;
- if (this.attemptPair(state, priority, tokens, MDEmphasisNode, MDTokenType.Underscore)) return true;
- return false;
- }
- }
-
- class MDStrongReader extends MDSimplePairInlineReader {
- readToken(state, line) {
- if (line.startsWith('*')) return new MDToken('*', MDTokenType.Asterisk);
- if (line.startsWith('_')) return new MDToken('_', MDTokenType.Underscore);
- return null;
- }
-
- substituteTokens(state, priority, tokens) {
- if (this.attemptPair(state, priority, tokens, MDStrongNode, MDTokenType.Asterisk, 2)) return true;
- if (this.attemptPair(state, priority, tokens, MDStrongNode, MDTokenType.Underscore, 2)) return true;
- return false;
- }
- }
-
- class MDStrikethroughReader extends MDSimplePairInlineReader {
- readToken(state, line) {
- if (line.startsWith('~')) return new MDToken('~', MDTokenType.Tilde);
- return null;
- }
-
- substituteTokens(state, priority, tokens) {
- if (this.attemptPair(state, priority, tokens, MDStrikethroughNode, MDTokenType.Tilde, 2)) return true;
- if (this.attemptPair(state, priority, tokens, MDStrikethroughNode, MDTokenType.Tilde)) return true;
- return false;
- }
- }
-
- class MDUnderlineReader extends MDSimplePairInlineReader {
- readToken(state, line) {
- if (line.startsWith('_')) return new MDToken('_', MDTokenType.Underscore);
- return null;
- }
-
- substituteTokens(state, priority, tokens) {
- return this.attemptPair(state, priority, tokens, MDUnderlineNode, MDTokenType.Underscore, 2);
- }
- }
-
- class MDHighlightReader extends MDSimplePairInlineReader {
- readToken(state, line) {
- if (line.startsWith('=')) return new MDToken('=', MDTokenType.Equal);
- return null;
- }
-
- substituteTokens(state, priority, tokens) {
- return this.attemptPair(state, priority, tokens, MDHighlightNode, MDTokenType.Equal, 2);
- }
- }
-
- class MDLinkReader extends MDReader {
- static #simpleEmailRegex = new RegExp("^<(" + MDUtils.baseEmailRegex.source + ")>", "i"); // 1=email
- static #simpleURLRegex = new RegExp("^<(" + MDUtils.baseURLRegex.source + ")>", "i"); // 1=URL
-
- constructor(tokenizePriority=0.0, substitutePriority=0.0) {
- super(tokenizePriority, substitutePriority);
- }
-
- readToken(state, line) {
- var groups;
- if (groups = MDUtils.tokenizeLabel(line)) {
- return new MDToken(groups[0], MDTokenType.Label, groups[1]);
- }
- if (groups = MDUtils.tokenizeEmail(line)) {
- return new MDToken(groups[0], MDTokenType.Email, groups[1], groups[2]);
- }
- if (groups = MDUtils.tokenizeURL(line)) {
- return new MDToken(groups[0], MDTokenType.URL, groups[1], groups[2]);
- }
- if (groups = MDLinkReader.#simpleEmailRegex.exec(line)) {
- return new MDToken(groups[0], MDTokenType.SimpleEmail, groups[1]);
- }
- if (groups = MDLinkReader.#simpleURLRegex.exec(line)) {
- return new MDToken(groups[0], MDTokenType.SimpleLink, groups[1]);
- }
- return null;
- }
-
- substituteTokens(state, priority, tokens) {
- var match;
- if (match = MDToken.findFirstTokens(tokens, [ MDTokenType.Label, MDTokenType.META_OptionalWhitespace, MDTokenType.URL ])) {
- let text = match.tokens[0].content;
- let url = match.tokens[match.tokens.length - 1].content;
- let title = match.tokens[match.tokens.length - 1].extra;
- tokens.splice(match.index, match.tokens.length, new MDLinkNode(url, state.inlineMarkdownToNode(text), title));
- return true;
- }
- if (match = MDToken.findFirstTokens(tokens, [ MDTokenType.Label, MDTokenType.META_OptionalWhitespace, MDTokenType.Email ])) {
- let text = match.tokens[0].content;
- let email = match.tokens[match.tokens.length - 1].content;
- let url = `mailto:${email}`;
- let title = match.tokens[match.tokens.length - 1].extra;
- tokens.splice(match.index, match.tokens.length, new MDLinkNode(url, state.inlineMarkdownToNodes(text), title));
- return true;
- }
- if (match = MDToken.findFirstTokens(tokens, [ MDTokenType.SimpleEmail ])) {
- const token = match.tokens[0];
- const link = `mailto:${token.content}`;
- const node = new MDLinkNode(link, new MDObfuscatedTextNode(token.content));
- tokens.splice(match.index, 1, node);
- return true;
- }
- if (match = MDToken.findFirstTokens(tokens, [ MDTokenType.SimpleLink ])) {
- const token = match.tokens[0];
- const link = token.content;
- const node = new MDLinkNode(link, new MDTextNode(link));
- tokens.splice(match.index, 1, node);
- return true;
- }
- return false;
- }
- }
-
- /**
- * Block reader for URL definitions. Links in the document can include a
- * reference instead of a verbatim URL so it can be defined in one place and
- * reused in many places. These can be defined anywhere in the document. Nothing
- * of the definition is rendered in the document.
- *
- * Example:
- *
- * > ```markdown
- * > [foo]: https://example.com
- * > ```
- */
- class MDReferencedLinkReader extends MDLinkReader {
- /**
- * @param {MDState} state
- */
- readBlock(state) {
- var p = state.p;
- let line = state.lines[p++];
- var symbol;
- var url;
- var title = null;
- let groups = /^\s*\[(.+?)]:\s*(\S+)\s+"(.*?)"\s*$/.exec(line);
- if (groups) {
- symbol = groups[1];
- url = groups[2];
- title = groups[3];
- } else {
- groups = /^\s*\[(.+?)]:\s*(\S+)\s*$/.exec(line);
- if (groups) {
- symbol = groups[1];
- url = groups[2];
- } else {
- return null;
- }
- }
- state.defineURL(symbol, url, title);
- state.p = p;
- return new MDNode([]); // empty
- }
-
- substituteTokens(state, priority, tokens) {
- var match;
- if (match = MDToken.findFirstTokens(tokens, [ MDTokenType.Label, MDTokenType.META_OptionalWhitespace, MDTokenType.Label ])) {
- let text = match.tokens[0].content;
- let ref = match.tokens[match.tokens.length - 1].content;
- tokens.splice(match.index, match.tokens.length, new MDReferencedLinkNode(ref, state.inlineMarkdownToNodes(text)));
- return true;
- }
- return false;
- }
- }
-
- class MDImageReader extends MDLinkReader {
- substituteTokens(state, priority, tokens) {}
-
- readToken(state, line) {
- const s = super.readToken(state, line);
- if (s) return s;
- if (line.startsWith('!')) return new MDToken('!', MDTokenType.Bang);
- return null;
- }
-
- substituteTokens(state, priority, tokens) {
- var match;
- if (match = MDToken.findFirstTokens(tokens, [ MDTokenType.Bang, MDTokenType.Label, MDTokenType.META_OptionalWhitespace, MDTokenType.URL ])) {
- let alt = match.tokens[1].content;
- let url = match.tokens[match.tokens.length - 1].content;
- let title = match.tokens[match.tokens.length - 1].extra;
- const node = new MDImageNode(url, alt);
- if (title !== null) {
- node.attributes['title'] = title;
- }
- tokens.splice(match.index, match.tokens.length, node);
- return true;
- }
- if (match = MDToken.findFirstTokens(tokens, [ MDTokenType.Bang, MDTokenType.Label, MDTokenType.META_OptionalWhitespace, MDTokenType.Label ])) {
- let alt = match.tokens[1].content;
- let ref = match.tokens[match.tokens.length - 1].content;
- tokens.splice(match.index, match.tokens.length, new MDReferencedImageNode(ref, alt));
- return true;
- }
- return false;
- }
- }
-
- class MDReferencedImageReader extends MDReferencedLinkReader {
- readBlock(state) { return null; }
- }
-
- class MDCodeSpanReader extends MDSimplePairInlineReader {
- readToken(state, line) {
- if (line.startsWith('`')) return new MDToken('`', MDTokenType.Backtick);
- return null;
- }
-
- substituteTokens(state, priority, tokens) {
- if (this.attemptPair(state, priority, tokens, MDCodeNode, MDTokenType.Backtick, 2, true)) return true;
- if (this.attemptPair(state, priority, tokens, MDCodeNode, MDTokenType.Backtick, 1, true)) return true;
- }
- }
-
- class MDSubscriptReader extends MDSimplePairInlineReader {
- readToken(state, line) {
- if (line.startsWith('~')) return new MDToken('~', MDTokenType.Tilde);
- return null;
- }
-
- substituteTokens(state, priority, tokens) {
- return this.attemptPair(state, priority, tokens, MDSubscriptNode, MDTokenType.Tilde);
- }
- }
-
- class MDSuperscriptReader extends MDSimplePairInlineReader {
- readToken(state, line) {
- if (line.startsWith('^')) return new MDToken('^', MDTokenType.Caret);
- return null;
- }
-
- substituteTokens(state, priority, tokens) {
- return this.attemptPair(state, priority, tokens, MDSuperscriptNode, MDTokenType.Caret);
- }
- }
-
- class MDHTMLTagReader extends MDReader {
- readToken(state, line) {
- const tag = MDHTMLTag.fromLineStart(line)
- if (tag === null) return null;
- return new MDToken(tag.original, MDTokenType.HTMLTag, null, null, tag)
- }
-
- substituteTokens(state, priority, tokens) {
- var match;
- if (match = MDToken.findFirstTokens(tokens, [ MDTokenType.HTMLTag ])) {
- const tag = match.tokens[0].tag
- tokens.splice(match.index, match.tokens.length, new MDHTMLTagNode(tag))
- return true;
- }
- return false;
- }
- }
-
- class MDModifierReader extends MDReader {
- readToken(state, line) {
- var modifier = MDTagModifier.fromStart(line);
- if (modifier) return new MDToken(modifier.original, MDTokenType.Modifier, modifier);
- return null;
- }
-
- substituteTokens(state, priority, tokens) {
- // Modifiers are applied elsewhere, and if they're not it's fine if they're
- // rendered as the original syntax.
- return false;
- }
- }
-
-
- // -- Document nodes --------------------------------------------------------
-
-
- class MDNode {
- /**
- * Array of CSS classes to add to the node when rendered as HTML.
- * @type {string[]}
- */
- cssClasses = [];
- /** @type {string|null} */
- cssId = null;
- /**
- * Mapping of CSS attributes to values.
- * @type {object}
- */
- cssStyles = {};
- /**
- * Mapping of arbitrary attributes and values to add to this node's top-level
- * tag when rendered as HTML. For `class`, `id`, and `style` attributes, use
- * `cssClasses`, `cssId`, and `cssStyles` instead.
- * @type {object}
- */
- attributes = {};
- /**
- * All child nodes in this node.
- * @type {MDNode[]}
- */
- children;
-
- /**
- * @param {MDNode[]} children
- */
- constructor(children=[]) {
- if (children instanceof Array) {
- for (const elem of children) {
- if (!(elem instanceof MDNode)) {
- throw new Error(`${this.constructor.name} expects children of type MDNode[] or MDNode, got array with ${MDUtils.typename(elem)} element`);
- }
- }
- this.children = children;
- } else if (children instanceof MDNode) {
- this.children = [ children ];
- } else {
- throw new Error(`${this.constructor.name} expects children of type MDNode[] or MDNode, got ${MDUtils.typename(children)}`);
- }
- }
-
- /**
- * Renders this node and any children as an HTML string. If the node has no
- * content an empty string should be returned.
- *
- * @param {MDState} state
- * @returns {string} HTML string
- */
- toHTML(state) {
- return MDNode.toHTML(this.children, state);
- }
-
- /**
- * Renders this node and any children as a plain text string. The conversion
- * should only render ordinary text, not attempt markdown-like formatting
- * (e.g. list items should not be prefixed with asterisks, only have their
- * content text returned). If the node has no renderable content an empty
- * string should be returned.
- *
- * @param {MDState} state
- * @returns {string} plaintext string
- */
- toPlaintext(state) {
- return MDNode.toPlaintext(this.children, state);
- }
-
- /**
- * Helper that renders an HTML fragment of the attributes to apply to the
- * root HTML tag representation of this node.
- *
- * Example result with a couple `cssClasses`, a `cssId`, and a custom
- * `attributes` key-value pair:
- *
- * ```
- * class="foo bar" id="baz" lang="en"
- * ```
- *
- * The value includes a leading space if it's non-empty so that it can be
- * concatenated directly after the tag name and before the closing `>`.
- *
- * @returns {string} HTML fragment
- */
- _htmlAttributes() {
- var html = '';
- if (this.cssClasses.length > 0) {
- html += ` class="${this.cssClasses.join(' ')}"`;
- }
- if (this.cssId !== null && this.cssId.length > 0) {
- html += ` id="${this.cssId}"`;
- }
- var styles = [];
- for (const key in this.cssStyles) {
- styles.push(`${key}: ${this.cssStyles[key]};`)
- }
- if (styles.length > 0) {
- html += ` style="${MDUtils.escapeHTML(styles.join(' '))}"`;
- }
- for (const key in this.attributes) {
- if (key == 'class' || key == 'id' || key == 'style') continue;
- const value = `${this.attributes[key]}`;
- const cleanKey = MDUtils.scrubAttributeName(key);
- if (cleanKey.length == 0) continue;
- const cleanValue = MDUtils.escapeHTML(value);
- html += ` ${cleanKey}="${cleanValue}"`;
- }
- return html;
- }
-
- /**
- * Helper that renders the children of this node to HTML. Mostly for use by
- * subclasses in their `toHTML` implementation.
- *
- * @param {MDState} state
- * @returns {string}
- */
- _childHTML(state) {
- return this.children.map((child) => child.toHTML(state)).join('');
- }
-
- /**
- * @param {MDState} state
- * @param {string} tagName
- * @param {boolean} innerNewLines
- * @returns {string}
- */
- _simplePairedTagHTML(state, tagName, innerNewLines=false) {
- const openTagSuffix = this.children[0] instanceof MDBlockNode ? '\n' : ''
- const closeTagPrefix = this.children[this.children.length - 1] instanceof MDBlockNode ? '\n' : '';
- const closeTagSuffix = this instanceof MDBlockNode ? '\n' : '';
- return `<${tagName}${this._htmlAttributes()}>${openTagSuffix}${this._childHTML(state)}${closeTagPrefix}</${tagName}>${closeTagSuffix}`;
- }
-
- /**
- * Calls the given callback function with every child node, recursively.
- * Nodes are visited depth-first.
- *
- * @param {function} fn - callback that takes one `MDNode` argument
- */
- visitChildren(fn) {
- if (this.children === undefined || !Array.isArray(this.children)) {
- return;
- }
- for (const child of this.children) {
- fn(child);
- child.visitChildren(fn);
- }
- }
-
- /**
- * @param {MDNode[]} nodes
- * @param {MDState} state
- * @returns {string}
- */
- static toHTML(nodes, state) {
- return nodes.map((node) => node.toHTML(state) + (node instanceof MDBlockNode ? '\n' : '')).join('');
- }
-
- /**
- * @param {MDNode[]} nodes
- * @param {MDState} state
- * @returns {string}
- */
- static toPlaintext(nodes, state) {
- return nodes.map((node) => node.toPlaintext(state)).join('');
- }
- }
-
- class MDBlockNode extends MDNode {}
-
- class MDParagraphNode extends MDBlockNode {
- toHTML(state) {
- return this._simplePairedTagHTML(state, 'p');
- }
- }
-
- class MDHeaderNode extends MDBlockNode {
- /** @type {number} */
- level;
-
- constructor(level, children) {
- super(children);
- if (typeof level !== 'number' || (level < 1 || level > 6)) {
- throw new Error(`${this.constructor.name} requires header level 1 to 6`);
- }
- this.level = level;
- }
-
- toHTML(state) {
- return this._simplePairedTagHTML(state, `h${this.level}`);
- }
- }
-
- class MDSubtextNode extends MDBlockNode {
- toHTML(state) {
- if (this.cssClasses.indexOf('subtext') < 0) {
- this.cssClasses.push('subtext');
- }
- return this._simplePairedTagHTML(state, 'div');
- }
- }
-
- class MDHorizontalRuleNode extends MDBlockNode {
- toHTML(state) {
- return `<hr${this._htmlAttributes()}>`;
- }
- }
-
- class MDBlockquoteNode extends MDBlockNode {
- toHTML(state) {
- return this._simplePairedTagHTML(state, 'blockquote', true);
- }
- }
-
- class MDUnorderedListNode extends MDBlockNode {
- /** @type {MDListItemNode[]} children */
-
- /**
- * @param {MDListItemNode[]} children
- */
- constructor(children) {
- super(children);
- }
-
- toHTML(state) {
- return this._simplePairedTagHTML(state, 'ul', true);
- }
- }
-
- class MDOrderedListNode extends MDBlockNode {
- /** @type {MDListItemNode[]} children */
-
- /** @type {number|null} */
- startOrdinal;
-
- /**
- * @param {MDListItemNode[]} children
- * @param {number|null} startOrdinal
- */
- constructor(children, startOrdinal=null) {
- super(children);
- this.startOrdinal = startOrdinal;
- }
-
- toHTML(state) {
- if (this.startOrdinal !== null && this.startOrdinal != 1) this.attributes['start'] = this.startOrdinal;
- return this._simplePairedTagHTML(state, 'ol', true);
- }
- }
-
- class MDListItemNode extends MDBlockNode {
- /** @type {number|null} */
- ordinal;
-
- /**
- * @param {MDNode|MDNode[]} children
- * @param {number|null} ordinal
- */
- constructor(children, ordinal=null) {
- super(children);
- this.ordinal = ordinal;
- }
-
- toHTML(state) {
- return this._simplePairedTagHTML(state, 'li');
- }
- }
-
- class MDCodeBlockNode extends MDBlockNode {
- /** @type {string} */
- text;
-
- /**
- * @param {string} text
- */
- constructor(text) {
- super([]);
- this.text = text;
- }
-
- toHTML(state) {
- return `<pre${this._htmlAttributes()}><code>${MDUtils.escapeHTML(this.text)}</code></pre>\n`;
- }
- }
-
- class MDTableNode extends MDBlockNode {
- /** @param {MDTableRowNode[]} children */
-
- /** @type {MDTableRowNode} */
- get headerRow() { return this.#headerRow; }
- set headerRow(newValue) {
- this.#headerRow = newValue;
- this.#recalculateChildren();
- }
- #headerRow;
-
- /** @type {MDTableRowNode[]} */
- get bodyRows() { return this.#bodyRows; }
- set bodyRows(newValue) {
- this.#bodyRows = newValue;
- this.#recalculateChildren();
- }
- #bodyRows;
-
- /**
- * How to align each column. Columns beyond the length of the array or with
- * corresponding `null` elements will have no alignment set. Values should
- * be valid CSS `text-align` values.
- *
- * @type {string[]}
- */
- columnAlignments = [];
-
- /**
- * @param {MDTableRowNode} headerRow
- * @param {MDTableRowNode[]} bodyRows
- */
- constructor(headerRow, bodyRows) {
- super([ headerRow, ...bodyRows ]);
- this.#headerRow = headerRow;
- this.#bodyRows = bodyRows;
- }
-
- #recalculateChildren() {
- this.children = [ this.#headerRow, ...this.#bodyRows ];
- }
-
- #applyAlignments() {
- this.children.forEach((child) => this.#applyAlignmentsToRow(child));
- }
-
- /**
- * @param {MDTableRowNode} row
- */
- #applyAlignmentsToRow(row) {
- for (const [columnIndex, cell] of row.children.entries()) {
- const alignment = columnIndex < this.columnAlignments.length ? this.columnAlignments[columnIndex] : null;
- this.#applyAlignmentToCell(cell, alignment);
- }
- }
-
- /**
- * @param {MDTableCellNode} cell
- * @param {string|null} alignment
- */
- #applyAlignmentToCell(cell, alignment) {
- if (alignment) {
- cell.cssStyles['text-align'] = alignment;
- } else {
- delete cell.cssStyles['text-align'];
- }
- }
-
- toHTML(state) {
- this.#applyAlignments();
- var html = '';
- html += `<table${this._htmlAttributes()}>\n`;
- html += '<thead>\n';
- html += this.headerRow.toHTML(state) + '\n';
- html += '</thead>\n';
- html += '<tbody>\n';
- html += MDNode.toHTML(this.bodyRows, state) + '\n';
- html += '</tbody>\n';
- html += '</table>\n';
- return html;
- }
- }
-
- class MDTableRowNode extends MDBlockNode {
- /** @type {MDTableCellNode[]} children */
-
- toHTML(state) {
- return this._simplePairedTagHTML(state, 'tr', true);
- }
- }
-
- class MDTableCellNode extends MDBlockNode {
- toHTML(state) {
- return this._simplePairedTagHTML(state, 'td');
- }
- }
-
- class MDTableHeaderCellNode extends MDBlockNode {
- toHTML(state) {
- return this._simplePairedTagHTML(state, 'th');
- }
- }
-
- class MDDefinitionListNode extends MDBlockNode {
- toHTML(state) {
- return this._simplePairedTagHTML(state, 'dl', true);
- }
- }
-
- class MDDefinitionListTermNode extends MDBlockNode {
- toHTML(state) {
- return this._simplePairedTagHTML(state, 'dt');
- }
- }
-
- class MDDefinitionListDefinitionNode extends MDBlockNode {
- toHTML(state) {
- return this._simplePairedTagHTML(state, 'dd');
- }
- }
-
- class MDFootnoteListNode extends MDBlockNode {
- toHTML(state) {
- const footnotes = state.footnotes;
- var symbolOrder = Object.keys(footnotes);
- if (Object.keys(footnotes).length == 0) return '';
- const footnoteUniques = state.root.footnoteInstances;
- var html = '';
- html += '<div class="footnotes"><hr/>';
- html += '<ol>';
- for (const symbol of symbolOrder) {
- /** @type {MDNode[]} */
- let content = footnotes[symbol];
- if (!content) continue;
- const contentHTML = MDNode.toHTML(content, state);
- html += `<li value="${symbol}" id="footnote_${symbol}">${contentHTML}`;
- const uniques = footnoteUniques[symbol];
- if (uniques) {
- for (const unique of uniques) {
- html += ` <a href="#footnoteref_${unique}" class="footnote-backref">↩︎</a>`;
- }
- }
- html += `</li>\n`;
- }
- html += '</ol>';
- html += '</div>';
- return html;
- }
-
- toPlaintext(state) {
- const footnotes = state.footnotes;
- var symbolOrder = Object.keys(footnotes);
- if (Object.keys(footnotes).length == 0) return '';
- var text = '';
- for (const symbol of symbolOrder) {
- let content = footnotes[symbol];
- if (!content) continue;
- text += `${symbol}. ${content.toPlaintext(state)}\n`;
- }
- return text.trim();
- }
- }
-
- class MDInlineNode extends MDNode {}
-
- class MDTextNode extends MDInlineNode {
- text;
-
- constructor(text) {
- super([]);
- this.text = text;
- }
-
- toHTML(state) {
- return MDUtils.escapeHTML(this.text);
- }
-
- toPlaintext(state) {
- return this.text;
- }
- }
-
- class MDObfuscatedTextNode extends MDTextNode {
- toHTML(state) {
- return MDUtils.escapeObfuscated(this.text);
- }
- }
-
- class MDEmphasisNode extends MDInlineNode {
- toHTML(state) {
- return this._simplePairedTagHTML(state, 'em');
- }
- }
-
- class MDStrongNode extends MDInlineNode {
- toHTML(state) {
- return this._simplePairedTagHTML(state, 'strong');
- }
- }
-
- class MDStrikethroughNode extends MDInlineNode {
- toHTML(state) {
- return this._simplePairedTagHTML(state, 's');
- }
- }
-
- class MDUnderlineNode extends MDInlineNode {
- toHTML(state) {
- return this._simplePairedTagHTML(state, 'u');
- }
- }
-
- class MDHighlightNode extends MDInlineNode {
- toHTML(state) {
- return this._simplePairedTagHTML(state, 'mark');
- }
- }
-
- class MDSuperscriptNode extends MDInlineNode {
- toHTML(state) {
- return this._simplePairedTagHTML(state, 'sup');
- }
- }
-
- class MDSubscriptNode extends MDInlineNode {
- toHTML(state) {
- return this._simplePairedTagHTML(state, 'sub');
- }
- }
-
- class MDCodeNode extends MDInlineNode {
- /** @type {string} */
- text;
-
- constructor(text) {
- super([]);
- this.text = text;
- }
-
- toHTML(state) {
- return `<code${this._htmlAttributes()}>${MDUtils.escapeHTML(this.text)}</code>`;
- }
- }
-
- class MDFootnoteNode extends MDInlineNode {
- /**
- * Symbol the author used to match up the footnote to its content definition.
- * @type {string}
- */
- symbol;
-
- /**
- * The superscript symbol rendered in HTML. May be the same or different
- * than `symbol`.
- * @type {string} display symbol
- */
- displaySymbol = null;
-
- /**
- * Unique ID for the footnote definition.
- * @type {number|null}
- */
- footnoteId = null;
-
- /**
- * Unique number for backlinking to a footnote occurrence. Populated by
- * `MDFootnoteReader.postProcess`.
- * @type {number|null}
- */
- occurrenceId = null;
-
- /**
- * @param {string} symbol
- * @param {string|null} title
- */
- constructor(symbol, title=null) {
- super([]);
- this.symbol = symbol;
- if (title) this.attributes['title'] = title;
- }
-
- toHTML(state) {
- if (this.differentiator !== null) {
- return `<sup id="footnoteref_${this.occurrenceId}"${this._htmlAttributes()}><a href="#footnote_${this.footnoteId}">${MDUtils.escapeHTML(this.displaySymbol ?? this.symbol)}</a></sup>`;
- }
- return `<!--FNREF:{${this.symbol}}-->`;
- }
- }
-
- class MDLinkNode extends MDInlineNode {
- /** @type {string} */
- href;
-
- /**
- * @param {string} href
- * @param {MDNode[]|MDNode} children
- */
- constructor(href, children, title=null) {
- super(children);
- this.href = href;
- if (title !== null) this.attributes['title'] = title;
- }
-
- toHTML(state) {
- var escapedLink;
- if (this.href.startsWith('mailto:')) {
- escapedLink = MDUtils.escapeObfuscated(this.href);
- } else {
- escapedLink = MDUtils.escapeHTML(this.href);
- }
- return `<a href="${escapedLink}"${this._htmlAttributes()}>${this._childHTML(state)}</a>`;
- }
- }
-
- class MDReferencedLinkNode extends MDLinkNode {
- /** @type {string} */
- reference;
-
- constructor(reference, children) {
- super('', children);
- this.reference = reference;
- }
-
- /**
- * @param {MDState} state
- */
- toHTML(state) {
- if (this.href === '') {
- this.href = state.urlForReference(this.reference);
- const title = state.urlTitleForReference(this.reference);
- if (title) this.attributes['title'] = title;
- }
- return super.toHTML(state);
- }
- }
-
- class MDImageNode extends MDInlineNode {
- /** @type {string} */
- src;
-
- /** @type {string|null} */
- alt;
-
- /**
- * @param {string} src
- * @param {string|null} alt
- */
- constructor(src, alt) {
- super([]);
- this.src = src;
- this.alt = alt;
- }
-
- toHTML(state) {
- var html = `<img src="${MDUtils.escapeHTML(this.src)}"`;
- if (this.alt) html += ` alt="${MDUtils.escapeHTML(this.alt)}"`;
- html += `${this._htmlAttributes()}>`;
- return html;
- }
- }
-
- class MDReferencedImageNode extends MDImageNode {
- /** @type {string} */
- reference;
-
- /**
- * @param {string} reference
- * @param {string|null} alt
- */
- constructor(reference, alt='') {
- super('', alt, []);
- this.reference = reference;
- }
-
- toHTML(state) {
- if (this.src === '') {
- this.src = state.urlForReference(this.reference);
- this.attributes['title'] = state.urlTitleForReference(this.reference);
- }
- return super.toHTML(state);
- }
- }
-
- class MDAbbreviationNode extends MDInlineNode {
- /** @type {string} */
- abbreviation;
-
- /** @type {string} */
- get definition() { return this.attributes['title'] ?? null; }
- set definition(newValue) { this.attributes['title'] = newValue; }
-
- /**
- * @param {string} abbreviation
- * @param {string} definition
- */
- constructor(abbreviation, definition) {
- super([]);
- this.abbreviation = abbreviation;
- this.attributes['title'] = definition;
- }
-
- toHTML(state) {
- return `<abbr${this._htmlAttributes()}>${MDUtils.escapeHTML(this.abbreviation)}</abbr>`;
- }
- }
-
- class MDLineBreakNode extends MDInlineNode {
- toHTML(state) {
- return '<br>';
- }
-
- toPlaintext(state) {
- return '\n';
- }
- }
-
- class MDHTMLTagNode extends MDInlineNode {
- /** @type {MDHTMLTag} */
- tag;
-
- constructor(tag) {
- super([]);
- this.tag = tag;
- }
-
- toHTML(state) {
- return this.tag.toString();
- }
- }
-
-
- // -- Other -----------------------------------------------------------------
-
-
- class MDHTMLTag {
- /** @type {string} */
- original;
- /** @type {string} */
- tagName;
- /** @type {boolean} */
- isCloser;
- /** @type {object} */
- attributes;
-
- /**
- * @param {string} original
- * @param {string} tagName
- * @param {boolean} isCloser
- * @param {object} attributes
- */
- constructor(original, tagName, isCloser, attributes) {
- this.original = original;
- this.tagName = tagName;
- this.isCloser = isCloser;
- this.attributes = attributes;
- }
-
- toString() {
- var html = '<';
- if (this.isCloser) html += '/';
- html += this.tagName;
- for (const key in this.attributes) {
- const safeName = MDUtils.scrubAttributeName(key);
- const value = this.attributes[key];
- if (value === true) {
- html += ` ${safeName}`;
- } else {
- const escapedValue = MDUtils.escapeHTML(value);
- html += ` ${safeName}="${escapedValue}"`;
- }
- }
- html += '>';
- return html;
- }
-
- equals(other) {
- if (!(other instanceof MDHTMLTag)) return false;
- if (other.tagName != this.tagName) return false;
- if (other.isCloser != this.isCloser) return false;
- return MDUtils.equal(other.attributes, this.attributes);
- }
-
- static #htmlTagNameFirstRegex = /[a-z]/i;
- static #htmlTagNameMedialRegex = /[a-z0-9]/i;
- static #htmlAttributeNameFirstRegex = /[a-z]/i;
- static #htmlAttributeNameMedialRegex = /[a-z0-9-]/i;
- static #whitespaceCharRegex = /\s/;
-
- /**
- * @param {string} line
- * @returns {MDHTMLTag|null} HTML tag if possible
- */
- static fromLineStart(line) {
- let expectOpenBracket = 0;
- let expectCloserOrName = 1;
- let expectName = 2;
- let expectAttributeNameOrEnd = 3;
- let expectEqualsOrAttributeOrEnd = 4;
- let expectAttributeValue = 5;
- let expectCloseBracket = 6;
-
- var isCloser = false;
- var tagName = '';
- var attributeName = '';
- var attributeValue = '';
- var attributeQuote = null;
- var attributes = {};
- var fullTag = null;
- let endAttribute = function(unescape=false) {
- if (attributeName.length > 0) {
- if (attributeValue.length > 0 || attributeQuote) {
- attributes[attributeName] = unescape ? MDUtils.unescapeHTML(attributeValue) : attributeValue;
- } else {
- attributes[attributeName] = true;
- }
- }
- attributeName = '';
- attributeValue = '';
- attributeQuote = null;
- };
-
- var expect = expectOpenBracket;
- for (var p = 0; p < line.length && fullTag === null; p++) {
- let ch = line.substring(p, p + 1);
- let isWhitespace = this.#whitespaceCharRegex.exec(ch) !== null;
- switch (expect) {
- case expectOpenBracket:
- if (ch != '<') return null;
- expect = expectCloserOrName;
- break;
- case expectCloserOrName:
- if (ch == '/') {
- isCloser = true;
- } else {
- p--;
- }
- expect = expectName;
- break;
- case expectName:
- if (tagName.length == 0) {
- if (this.#htmlTagNameFirstRegex.exec(ch) === null) return null;
- tagName += ch;
- } else {
- if (this.#htmlTagNameMedialRegex.exec(ch)) {
- tagName += ch;
- } else {
- p--;
- expect = (isCloser) ? expectCloseBracket : expectAttributeNameOrEnd;
- }
- }
- break;
- case expectAttributeNameOrEnd:
- if (attributeName.length == 0) {
- if (isWhitespace) {
- // skip whitespace
- } else if (ch == '/') {
- expect = expectCloseBracket;
- } else if (ch == '>') {
- fullTag = line.substring(0, p + 1);
- break;
- } else if (this.#htmlAttributeNameFirstRegex.exec(ch)) {
- attributeName += ch;
- } else {
- return null;
- }
- } else if (isWhitespace) {
- expect = expectEqualsOrAttributeOrEnd;
- } else if (ch == '/') {
- endAttribute();
- expect = expectCloseBracket;
- } else if (ch == '>') {
- endAttribute();
- fullTag = line.substring(0, p + 1);
- break;
- } else if (ch == '=') {
- expect = expectAttributeValue;
- } else if (this.#htmlAttributeNameMedialRegex.exec(ch)) {
- attributeName += ch;
- } else {
- return null;
- }
- break;
- case expectEqualsOrAttributeOrEnd:
- if (ch == '=') {
- expect = expectAttributeValue;
- } else if (isWhitespace) {
- // skip whitespace
- } else if (ch == '/') {
- expect = expectCloseBracket;
- } else if (ch == '>') {
- fullTag = line.substring(0, p + 1);
- break;
- } else if (this.#htmlAttributeNameFirstRegex.exec(ch)) {
- endAttribute();
- expect = expectAttributeNameOrEnd;
- p--;
- }
- break;
- case expectAttributeValue:
- if (attributeValue.length == 0) {
- if (attributeQuote === null) {
- if (isWhitespace) {
- // skip whitespace
- } else if (ch == '"' || ch == "'") {
- attributeQuote = ch;
- } else {
- attributeQuote = ''; // explicitly unquoted
- p--;
- }
- } else {
- if (ch === attributeQuote) {
- // Empty string
- endAttribute(attributeQuote != '');
- expect = expectAttributeNameOrEnd;
- } else if (attributeQuote === '' && (ch == '/' || ch == '>')) {
- return null;
- } else {
- attributeValue += ch;
- }
- }
- } else {
- if (ch === attributeQuote) {
- endAttribute();
- expect = expectAttributeNameOrEnd;
- } else if (attributeQuote === '' && isWhitespace) {
- endAttribute();
- expect = expectAttributeNameOrEnd;
- } else {
- attributeValue += ch;
- }
- }
- break;
- case expectCloseBracket:
- if (isWhitespace) {
- // ignore whitespace
- } else if (ch == '>') {
- fullTag = line.substring(0, p + 1);
- break;
- }
- break;
- }
- }
- if (fullTag === null) return null;
- endAttribute();
- return new MDHTMLTag(fullTag, tagName, isCloser, attributes);
- }
- }
-
- class MDTagModifier {
- /** @type {string} */
- original;
- /** @type {string[]} */
- cssClasses = [];
- /** @type {string|null} */
- cssId = null;
- /** @type {object} */
- cssStyles = {};
- /** @type {object} */
- attributes = {};
-
- static #baseClassRegex = /\.([a-z_\-][a-z0-9_\-]*?)/i;
- static #baseIdRegex = /#([a-z_\-][a-z0-9_\-]*?)/i;
- static #baseAttributeRegex = /([a-z0-9]+?)=([^\s\}]+?)/i;
- static #baseRegex = /\{([^}]+?)}/i;
- static #leadingClassRegex = new RegExp('^' + this.#baseRegex.source, 'i');
- static #trailingClassRegex = new RegExp('^(.*?)\\s*' + this.#baseRegex.source + '\\s*$', 'i');
- static #classRegex = new RegExp('^' + this.#baseClassRegex.source + '$', 'i'); // 1=classname
- static #idRegex = new RegExp('^' + this.#baseIdRegex.source + '$', 'i'); // 1=id
- static #attributeRegex = new RegExp('^' + this.#baseAttributeRegex.source + '$', 'i'); // 1=attribute name, 2=attribute value
-
- /**
- * @param {MDNode} node
- */
- applyTo(node) {
- if (node instanceof MDNode) {
- node.cssClasses = node.cssClasses.concat(this.cssClasses);
- if (this.cssId) node.cssId = this.cssId;
- for (const name in this.attributes) {
- node.attributes[name] = this.attributes[name];
- }
- for (const name in this.cssStyles) {
- node.cssStyles[name] = this.cssStyles[name];
- }
- }
- }
-
- equals(other) {
- if (!(other instanceof MDTagModifier)) return false;
- if (!MDUtils.equal(other.cssClasses, this.cssClasses)) return false;
- if (other.cssId !== this.cssId) return false;
- if (!MDUtils.equal(other.attributes, this.attributes)) return false;
- return true;
- }
-
- toString() {
- return this.original;
- }
-
- static #fromContents(contents) {
- let modifierTokens = contents.split(/\s+/);
- let mod = new MDTagModifier();
- mod.original = `{${contents}}`;
- var groups;
- for (const token of modifierTokens) {
- if (token.trim() == '') continue;
- if (groups = this.#classRegex.exec(token)) {
- mod.cssClasses.push(groups[1]);
- } else if (groups = this.#idRegex.exec(token)) {
- mod.cssId = groups[1];
- } else if (groups = this.#attributeRegex.exec(token)) {
- if (groups[1] == 'style') {
- const pairs = groups[2].split(';');
- for (const pair of pairs) {
- const keyValue = pair.split(':');
- if (keyValue.length != 2) continue;
- mod.cssStyles[keyValue[0]] = keyValue[1];
- }
- } else {
- mod.attributes[groups[1]] = groups[2];
- }
- } else {
- return null;
- }
- }
- return mod;
- }
-
- /**
- * Extracts modifier from line.
- * @param {string} line
- * @returns {Array} Tuple with remaining line and MDTagModifier.
- */
- static fromLine(line) {
- let groups = this.#trailingClassRegex.exec(line);
- if (groups === null) return [ line, null ];
- let bareLine = groups[1];
- let mod = this.#fromContents(groups[2]);
- return [ bareLine, mod ];
- }
-
- /**
- * Extracts modifier from head of string.
- * @param {string} line
- * @returns {MDTagModifier}
- */
- static fromStart(line) {
- let groups = this.#leadingClassRegex.exec(line);
- if (groups === null) return null;
- return this.#fromContents(groups[1]);
- }
-
- /**
- * @param {string} line
- * @returns {string}
- */
- static strip(line) {
- let groups = this.#trailingClassRegex.exec(line);
- if (groups === null) return line;
- return groups[1];
- }
- }
-
- class MDConfig {
-
- }
-
- class Markdown {
- /**
- * Set of standard readers.
- * @type {MDReader[]}
- */
- static standardReaders = [
- new MDUnderlinedHeaderReader(0),
- new MDHashHeaderReader(1),
- new MDBlockQuoteReader(3),
- new MDHorizontalRuleReader(9), // prioritize before unordered list
- new MDUnorderedListReader(10),
- new MDOrderedListReader(11),
- new MDFencedCodeBlockReader(20),
- new MDIndentedCodeBlockReader(21),
- new MDParagraphReader(100),
-
- new MDStrongReader(101, 10, [ 0, 2 ]), // prioritize before emphasis (both use * and _)
- new MDEmphasisReader(101, 15, [ 5, 55 ]),
- new MDCodeSpanReader(101, 20, [ 10, 60 ]),
- new MDImageReader(101, 30, 15), // prioritize before links
- new MDLinkReader(101, 35, 20),
- new MDHTMLTagReader(101, 80, 30),
- ];
-
- /**
- * All supported readers.
- * @type {MDReader[]}
- */
- static allReaders = [
- ...this.standardReaders,
- new MDSubtextReader(2),
- new MDTableReader(40),
- new MDDefinitionListReader(50),
- new MDFootnoteReader(60, 5, 40), // prioritize before links and images
- new MDAbbreviationReader(70),
-
- new MDUnderlineReader(101, 5, [ 9, 11 ]), // prioritize before emphasis and strong (both use _)
- // new MDSubscriptReader(101, 20, [ 11, 51 ]), // prioritize before strikethrough (both use ~)
- new MDStrikethroughReader(101, 21, [ 12, 50 ]),
- new MDHighlightReader(101, 23, [ 13, 51 ]),
- new MDSuperscriptReader(101, 24, [ 14, 54 ]),
- new MDReferencedImageReader(91, 31, 16),
- new MDReferencedLinkReader(90, 36, 21),
- new MDModifierReader(101, 90, 45),
- ];
-
- /**
- * Shared instance of a parser with standard syntax.
- */
- static standardParser = new Markdown(this.standardReaders);
-
- /**
- * Shared instance of a parser with all supported syntax.
- */
- static completeParser = new Markdown(this.allReaders);
-
- #readers;
-
- #readersByBlockPriority;
- #readersByTokenPriority;
- #readersBySubstitutePriority;
-
- /**
- * Creates a Markdown parser with the given syntax readers.
- *
- * @param {MDReader[]} readers
- */
- constructor(readers=Markdown.allReaders) {
- this.#readers = readers;
- const duplicateAndSort = function(priorityFn) {
- var result = [];
- for (const reader of readers) {
- const p = priorityFn(reader);
- const priorities = (p instanceof Array) ? p : [ p ];
- for (const priority of priorities) {
- result.push([priority, reader]);
- }
- }
- result.sort((a, b) => a[0] - b[0]);
- return result;
- }
- this.#readersByBlockPriority = duplicateAndSort((reader) => reader.blockPriority);
- this.#readersByTokenPriority = duplicateAndSort((reader) => reader.tokenizePriority);
- this.#readersBySubstitutePriority = duplicateAndSort((reader) => reader.substitutePriority);
- }
-
- /**
- * Converts a markdown string to an HTML string.
- *
- * @param {string} markdown
- * @returns {string} HTML
- */
- toHTML(markdown) {
- const lines = markdown.split(/(?:\n|\r|\r\n)/);
- const state = new MDState(lines,
- this.#readersByBlockPriority,
- this.#readersByTokenPriority,
- this.#readersBySubstitutePriority);
- for (const reader of this.#readers) {
- reader.preProcess(state);
- }
- const nodes = state.readBlocks();
- for (const reader of this.#readers) {
- reader.postProcess(state, nodes);
- }
- return MDNode.toHTML(nodes, state);
- }
- }
|