Localisation updates from https://translatewiki.net.
[mediawiki.git] / resources / lib / mustache / mustache.js
blob62fac4d632620f0f407d7dbf76c3d36d14468b45
1 (function (global, factory) {
2   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
3   typeof define === 'function' && define.amd ? define(factory) :
4   (global = global || self, global.Mustache = factory());
5 }(this, (function () { 'use strict';
7   /*!
8    * mustache.js - Logic-less {{mustache}} templates with JavaScript
9    * http://github.com/janl/mustache.js
10    */
12   var objectToString = Object.prototype.toString;
13   var isArray = Array.isArray || function isArrayPolyfill (object) {
14     return objectToString.call(object) === '[object Array]';
15   };
17   function isFunction (object) {
18     return typeof object === 'function';
19   }
21   /**
22    * More correct typeof string handling array
23    * which normally returns typeof 'object'
24    */
25   function typeStr (obj) {
26     return isArray(obj) ? 'array' : typeof obj;
27   }
29   function escapeRegExp (string) {
30     return string.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g, '\\$&');
31   }
33   /**
34    * Null safe way of checking whether or not an object,
35    * including its prototype, has a given property
36    */
37   function hasProperty (obj, propName) {
38     return obj != null && typeof obj === 'object' && (propName in obj);
39   }
41   /**
42    * Safe way of detecting whether or not the given thing is a primitive and
43    * whether it has the given property
44    */
45   function primitiveHasOwnProperty (primitive, propName) {
46     return (
47       primitive != null
48       && typeof primitive !== 'object'
49       && primitive.hasOwnProperty
50       && primitive.hasOwnProperty(propName)
51     );
52   }
54   // Workaround for https://issues.apache.org/jira/browse/COUCHDB-577
55   // See https://github.com/janl/mustache.js/issues/189
56   var regExpTest = RegExp.prototype.test;
57   function testRegExp (re, string) {
58     return regExpTest.call(re, string);
59   }
61   var nonSpaceRe = /\S/;
62   function isWhitespace (string) {
63     return !testRegExp(nonSpaceRe, string);
64   }
66   var entityMap = {
67     '&': '&',
68     '<': '&lt;',
69     '>': '&gt;',
70     '"': '&quot;',
71     "'": '&#39;',
72     '/': '&#x2F;',
73     '`': '&#x60;',
74     '=': '&#x3D;'
75   };
77   function escapeHtml (string) {
78     return String(string).replace(/[&<>"'`=\/]/g, function fromEntityMap (s) {
79       return entityMap[s];
80     });
81   }
83   var whiteRe = /\s*/;
84   var spaceRe = /\s+/;
85   var equalsRe = /\s*=/;
86   var curlyRe = /\s*\}/;
87   var tagRe = /#|\^|\/|>|\{|&|=|!/;
89   /**
90    * Breaks up the given `template` string into a tree of tokens. If the `tags`
91    * argument is given here it must be an array with two string values: the
92    * opening and closing tags used in the template (e.g. [ "<%", "%>" ]). Of
93    * course, the default is to use mustaches (i.e. mustache.tags).
94    *
95    * A token is an array with at least 4 elements. The first element is the
96    * mustache symbol that was used inside the tag, e.g. "#" or "&". If the tag
97    * did not contain a symbol (i.e. {{myValue}}) this element is "name". For
98    * all text that appears outside a symbol this element is "text".
99    *
100    * The second element of a token is its "value". For mustache tags this is
101    * whatever else was inside the tag besides the opening symbol. For text tokens
102    * this is the text itself.
103    *
104    * The third and fourth elements of the token are the start and end indices,
105    * respectively, of the token in the original template.
106    *
107    * Tokens that are the root node of a subtree contain two more elements: 1) an
108    * array of tokens in the subtree and 2) the index in the original template at
109    * which the closing tag for that section begins.
110    *
111    * Tokens for partials also contain two more elements: 1) a string value of
112    * indendation prior to that tag and 2) the index of that tag on that line -
113    * eg a value of 2 indicates the partial is the third tag on this line.
114    */
115   function parseTemplate (template, tags) {
116     if (!template)
117       return [];
118     var lineHasNonSpace = false;
119     var sections = [];     // Stack to hold section tokens
120     var tokens = [];       // Buffer to hold the tokens
121     var spaces = [];       // Indices of whitespace tokens on the current line
122     var hasTag = false;    // Is there a {{tag}} on the current line?
123     var nonSpace = false;  // Is there a non-space char on the current line?
124     var indentation = '';  // Tracks indentation for tags that use it
125     var tagIndex = 0;      // Stores a count of number of tags encountered on a line
127     // Strips all whitespace tokens array for the current line
128     // if there was a {{#tag}} on it and otherwise only space.
129     function stripSpace () {
130       if (hasTag && !nonSpace) {
131         while (spaces.length)
132           delete tokens[spaces.pop()];
133       } else {
134         spaces = [];
135       }
137       hasTag = false;
138       nonSpace = false;
139     }
141     var openingTagRe, closingTagRe, closingCurlyRe;
142     function compileTags (tagsToCompile) {
143       if (typeof tagsToCompile === 'string')
144         tagsToCompile = tagsToCompile.split(spaceRe, 2);
146       if (!isArray(tagsToCompile) || tagsToCompile.length !== 2)
147         throw new Error('Invalid tags: ' + tagsToCompile);
149       openingTagRe = new RegExp(escapeRegExp(tagsToCompile[0]) + '\\s*');
150       closingTagRe = new RegExp('\\s*' + escapeRegExp(tagsToCompile[1]));
151       closingCurlyRe = new RegExp('\\s*' + escapeRegExp('}' + tagsToCompile[1]));
152     }
154     compileTags(tags || mustache.tags);
156     var scanner = new Scanner(template);
158     var start, type, value, chr, token, openSection;
159     while (!scanner.eos()) {
160       start = scanner.pos;
162       // Match any text between tags.
163       value = scanner.scanUntil(openingTagRe);
165       if (value) {
166         for (var i = 0, valueLength = value.length; i < valueLength; ++i) {
167           chr = value.charAt(i);
169           if (isWhitespace(chr)) {
170             spaces.push(tokens.length);
171             indentation += chr;
172           } else {
173             nonSpace = true;
174             lineHasNonSpace = true;
175             indentation += ' ';
176           }
178           tokens.push([ 'text', chr, start, start + 1 ]);
179           start += 1;
181           // Check for whitespace on the current line.
182           if (chr === '\n') {
183             stripSpace();
184             indentation = '';
185             tagIndex = 0;
186             lineHasNonSpace = false;
187           }
188         }
189       }
191       // Match the opening tag.
192       if (!scanner.scan(openingTagRe))
193         break;
195       hasTag = true;
197       // Get the tag type.
198       type = scanner.scan(tagRe) || 'name';
199       scanner.scan(whiteRe);
201       // Get the tag value.
202       if (type === '=') {
203         value = scanner.scanUntil(equalsRe);
204         scanner.scan(equalsRe);
205         scanner.scanUntil(closingTagRe);
206       } else if (type === '{') {
207         value = scanner.scanUntil(closingCurlyRe);
208         scanner.scan(curlyRe);
209         scanner.scanUntil(closingTagRe);
210         type = '&';
211       } else {
212         value = scanner.scanUntil(closingTagRe);
213       }
215       // Match the closing tag.
216       if (!scanner.scan(closingTagRe))
217         throw new Error('Unclosed tag at ' + scanner.pos);
219       if (type == '>') {
220         token = [ type, value, start, scanner.pos, indentation, tagIndex, lineHasNonSpace ];
221       } else {
222         token = [ type, value, start, scanner.pos ];
223       }
224       tagIndex++;
225       tokens.push(token);
227       if (type === '#' || type === '^') {
228         sections.push(token);
229       } else if (type === '/') {
230         // Check section nesting.
231         openSection = sections.pop();
233         if (!openSection)
234           throw new Error('Unopened section "' + value + '" at ' + start);
236         if (openSection[1] !== value)
237           throw new Error('Unclosed section "' + openSection[1] + '" at ' + start);
238       } else if (type === 'name' || type === '{' || type === '&') {
239         nonSpace = true;
240       } else if (type === '=') {
241         // Set the tags for the next time around.
242         compileTags(value);
243       }
244     }
246     stripSpace();
248     // Make sure there are no open sections when we're done.
249     openSection = sections.pop();
251     if (openSection)
252       throw new Error('Unclosed section "' + openSection[1] + '" at ' + scanner.pos);
254     return nestTokens(squashTokens(tokens));
255   }
257   /**
258    * Combines the values of consecutive text tokens in the given `tokens` array
259    * to a single token.
260    */
261   function squashTokens (tokens) {
262     var squashedTokens = [];
264     var token, lastToken;
265     for (var i = 0, numTokens = tokens.length; i < numTokens; ++i) {
266       token = tokens[i];
268       if (token) {
269         if (token[0] === 'text' && lastToken && lastToken[0] === 'text') {
270           lastToken[1] += token[1];
271           lastToken[3] = token[3];
272         } else {
273           squashedTokens.push(token);
274           lastToken = token;
275         }
276       }
277     }
279     return squashedTokens;
280   }
282   /**
283    * Forms the given array of `tokens` into a nested tree structure where
284    * tokens that represent a section have two additional items: 1) an array of
285    * all tokens that appear in that section and 2) the index in the original
286    * template that represents the end of that section.
287    */
288   function nestTokens (tokens) {
289     var nestedTokens = [];
290     var collector = nestedTokens;
291     var sections = [];
293     var token, section;
294     for (var i = 0, numTokens = tokens.length; i < numTokens; ++i) {
295       token = tokens[i];
297       switch (token[0]) {
298         case '#':
299         case '^':
300           collector.push(token);
301           sections.push(token);
302           collector = token[4] = [];
303           break;
304         case '/':
305           section = sections.pop();
306           section[5] = token[2];
307           collector = sections.length > 0 ? sections[sections.length - 1][4] : nestedTokens;
308           break;
309         default:
310           collector.push(token);
311       }
312     }
314     return nestedTokens;
315   }
317   /**
318    * A simple string scanner that is used by the template parser to find
319    * tokens in template strings.
320    */
321   function Scanner (string) {
322     this.string = string;
323     this.tail = string;
324     this.pos = 0;
325   }
327   /**
328    * Returns `true` if the tail is empty (end of string).
329    */
330   Scanner.prototype.eos = function eos () {
331     return this.tail === '';
332   };
334   /**
335    * Tries to match the given regular expression at the current position.
336    * Returns the matched text if it can match, the empty string otherwise.
337    */
338   Scanner.prototype.scan = function scan (re) {
339     var match = this.tail.match(re);
341     if (!match || match.index !== 0)
342       return '';
344     var string = match[0];
346     this.tail = this.tail.substring(string.length);
347     this.pos += string.length;
349     return string;
350   };
352   /**
353    * Skips all text until the given regular expression can be matched. Returns
354    * the skipped string, which is the entire tail if no match can be made.
355    */
356   Scanner.prototype.scanUntil = function scanUntil (re) {
357     var index = this.tail.search(re), match;
359     switch (index) {
360       case -1:
361         match = this.tail;
362         this.tail = '';
363         break;
364       case 0:
365         match = '';
366         break;
367       default:
368         match = this.tail.substring(0, index);
369         this.tail = this.tail.substring(index);
370     }
372     this.pos += match.length;
374     return match;
375   };
377   /**
378    * Represents a rendering context by wrapping a view object and
379    * maintaining a reference to the parent context.
380    */
381   function Context (view, parentContext) {
382     this.view = view;
383     this.cache = { '.': this.view };
384     this.parent = parentContext;
385   }
387   /**
388    * Creates a new context using the given view with this context
389    * as the parent.
390    */
391   Context.prototype.push = function push (view) {
392     return new Context(view, this);
393   };
395   /**
396    * Returns the value of the given name in this context, traversing
397    * up the context hierarchy if the value is absent in this context's view.
398    */
399   Context.prototype.lookup = function lookup (name) {
400     var cache = this.cache;
402     var value;
403     if (cache.hasOwnProperty(name)) {
404       value = cache[name];
405     } else {
406       var context = this, intermediateValue, names, index, lookupHit = false;
408       while (context) {
409         if (name.indexOf('.') > 0) {
410           intermediateValue = context.view;
411           names = name.split('.');
412           index = 0;
414           /**
415            * Using the dot notion path in `name`, we descend through the
416            * nested objects.
417            *
418            * To be certain that the lookup has been successful, we have to
419            * check if the last object in the path actually has the property
420            * we are looking for. We store the result in `lookupHit`.
421            *
422            * This is specially necessary for when the value has been set to
423            * `undefined` and we want to avoid looking up parent contexts.
424            *
425            * In the case where dot notation is used, we consider the lookup
426            * to be successful even if the last "object" in the path is
427            * not actually an object but a primitive (e.g., a string, or an
428            * integer), because it is sometimes useful to access a property
429            * of an autoboxed primitive, such as the length of a string.
430            **/
431           while (intermediateValue != null && index < names.length) {
432             if (index === names.length - 1)
433               lookupHit = (
434                 hasProperty(intermediateValue, names[index])
435                 || primitiveHasOwnProperty(intermediateValue, names[index])
436               );
438             intermediateValue = intermediateValue[names[index++]];
439           }
440         } else {
441           intermediateValue = context.view[name];
443           /**
444            * Only checking against `hasProperty`, which always returns `false` if
445            * `context.view` is not an object. Deliberately omitting the check
446            * against `primitiveHasOwnProperty` if dot notation is not used.
447            *
448            * Consider this example:
449            * ```
450            * Mustache.render("The length of a football field is {{#length}}{{length}}{{/length}}.", {length: "100 yards"})
451            * ```
452            *
453            * If we were to check also against `primitiveHasOwnProperty`, as we do
454            * in the dot notation case, then render call would return:
455            *
456            * "The length of a football field is 9."
457            *
458            * rather than the expected:
459            *
460            * "The length of a football field is 100 yards."
461            **/
462           lookupHit = hasProperty(context.view, name);
463         }
465         if (lookupHit) {
466           value = intermediateValue;
467           break;
468         }
470         context = context.parent;
471       }
473       cache[name] = value;
474     }
476     if (isFunction(value))
477       value = value.call(this.view);
479     return value;
480   };
482   /**
483    * A Writer knows how to take a stream of tokens and render them to a
484    * string, given a context. It also maintains a cache of templates to
485    * avoid the need to parse the same template twice.
486    */
487   function Writer () {
488     this.templateCache = {
489       _cache: {},
490       set: function set (key, value) {
491         this._cache[key] = value;
492       },
493       get: function get (key) {
494         return this._cache[key];
495       },
496       clear: function clear () {
497         this._cache = {};
498       }
499     };
500   }
502   /**
503    * Clears all cached templates in this writer.
504    */
505   Writer.prototype.clearCache = function clearCache () {
506     if (typeof this.templateCache !== 'undefined') {
507       this.templateCache.clear();
508     }
509   };
511   /**
512    * Parses and caches the given `template` according to the given `tags` or
513    * `mustache.tags` if `tags` is omitted,  and returns the array of tokens
514    * that is generated from the parse.
515    */
516   Writer.prototype.parse = function parse (template, tags) {
517     var cache = this.templateCache;
518     var cacheKey = template + ':' + (tags || mustache.tags).join(':');
519     var isCacheEnabled = typeof cache !== 'undefined';
520     var tokens = isCacheEnabled ? cache.get(cacheKey) : undefined;
522     if (tokens == undefined) {
523       tokens = parseTemplate(template, tags);
524       isCacheEnabled && cache.set(cacheKey, tokens);
525     }
526     return tokens;
527   };
529   /**
530    * High-level method that is used to render the given `template` with
531    * the given `view`.
532    *
533    * The optional `partials` argument may be an object that contains the
534    * names and templates of partials that are used in the template. It may
535    * also be a function that is used to load partial templates on the fly
536    * that takes a single argument: the name of the partial.
537    *
538    * If the optional `config` argument is given here, then it should be an
539    * object with a `tags` attribute or an `escape` attribute or both.
540    * If an array is passed, then it will be interpreted the same way as
541    * a `tags` attribute on a `config` object.
542    *
543    * The `tags` attribute of a `config` object must be an array with two
544    * string values: the opening and closing tags used in the template (e.g.
545    * [ "<%", "%>" ]). The default is to mustache.tags.
546    *
547    * The `escape` attribute of a `config` object must be a function which
548    * accepts a string as input and outputs a safely escaped string.
549    * If an `escape` function is not provided, then an HTML-safe string
550    * escaping function is used as the default.
551    */
552   Writer.prototype.render = function render (template, view, partials, config) {
553     var tags = this.getConfigTags(config);
554     var tokens = this.parse(template, tags);
555     var context = (view instanceof Context) ? view : new Context(view, undefined);
556     return this.renderTokens(tokens, context, partials, template, config);
557   };
559   /**
560    * Low-level method that renders the given array of `tokens` using
561    * the given `context` and `partials`.
562    *
563    * Note: The `originalTemplate` is only ever used to extract the portion
564    * of the original template that was contained in a higher-order section.
565    * If the template doesn't use higher-order sections, this argument may
566    * be omitted.
567    */
568   Writer.prototype.renderTokens = function renderTokens (tokens, context, partials, originalTemplate, config) {
569     var buffer = '';
571     var token, symbol, value;
572     for (var i = 0, numTokens = tokens.length; i < numTokens; ++i) {
573       value = undefined;
574       token = tokens[i];
575       symbol = token[0];
577       if (symbol === '#') value = this.renderSection(token, context, partials, originalTemplate, config);
578       else if (symbol === '^') value = this.renderInverted(token, context, partials, originalTemplate, config);
579       else if (symbol === '>') value = this.renderPartial(token, context, partials, config);
580       else if (symbol === '&') value = this.unescapedValue(token, context);
581       else if (symbol === 'name') value = this.escapedValue(token, context, config);
582       else if (symbol === 'text') value = this.rawValue(token);
584       if (value !== undefined)
585         buffer += value;
586     }
588     return buffer;
589   };
591   Writer.prototype.renderSection = function renderSection (token, context, partials, originalTemplate, config) {
592     var self = this;
593     var buffer = '';
594     var value = context.lookup(token[1]);
596     // This function is used to render an arbitrary template
597     // in the current context by higher-order sections.
598     function subRender (template) {
599       return self.render(template, context, partials, config);
600     }
602     if (!value) return;
604     if (isArray(value)) {
605       for (var j = 0, valueLength = value.length; j < valueLength; ++j) {
606         buffer += this.renderTokens(token[4], context.push(value[j]), partials, originalTemplate, config);
607       }
608     } else if (typeof value === 'object' || typeof value === 'string' || typeof value === 'number') {
609       buffer += this.renderTokens(token[4], context.push(value), partials, originalTemplate, config);
610     } else if (isFunction(value)) {
611       if (typeof originalTemplate !== 'string')
612         throw new Error('Cannot use higher-order sections without the original template');
614       // Extract the portion of the original template that the section contains.
615       value = value.call(context.view, originalTemplate.slice(token[3], token[5]), subRender);
617       if (value != null)
618         buffer += value;
619     } else {
620       buffer += this.renderTokens(token[4], context, partials, originalTemplate, config);
621     }
622     return buffer;
623   };
625   Writer.prototype.renderInverted = function renderInverted (token, context, partials, originalTemplate, config) {
626     var value = context.lookup(token[1]);
628     // Use JavaScript's definition of falsy. Include empty arrays.
629     // See https://github.com/janl/mustache.js/issues/186
630     if (!value || (isArray(value) && value.length === 0))
631       return this.renderTokens(token[4], context, partials, originalTemplate, config);
632   };
634   Writer.prototype.indentPartial = function indentPartial (partial, indentation, lineHasNonSpace) {
635     var filteredIndentation = indentation.replace(/[^ \t]/g, '');
636     var partialByNl = partial.split('\n');
637     for (var i = 0; i < partialByNl.length; i++) {
638       if (partialByNl[i].length && (i > 0 || !lineHasNonSpace)) {
639         partialByNl[i] = filteredIndentation + partialByNl[i];
640       }
641     }
642     return partialByNl.join('\n');
643   };
645   Writer.prototype.renderPartial = function renderPartial (token, context, partials, config) {
646     if (!partials) return;
647     var tags = this.getConfigTags(config);
649     var value = isFunction(partials) ? partials(token[1]) : partials[token[1]];
650     if (value != null) {
651       var lineHasNonSpace = token[6];
652       var tagIndex = token[5];
653       var indentation = token[4];
654       var indentedValue = value;
655       if (tagIndex == 0 && indentation) {
656         indentedValue = this.indentPartial(value, indentation, lineHasNonSpace);
657       }
658       var tokens = this.parse(indentedValue, tags);
659       return this.renderTokens(tokens, context, partials, indentedValue, config);
660     }
661   };
663   Writer.prototype.unescapedValue = function unescapedValue (token, context) {
664     var value = context.lookup(token[1]);
665     if (value != null)
666       return value;
667   };
669   Writer.prototype.escapedValue = function escapedValue (token, context, config) {
670     var escape = this.getConfigEscape(config) || mustache.escape;
671     var value = context.lookup(token[1]);
672     if (value != null)
673       return (typeof value === 'number' && escape === mustache.escape) ? String(value) : escape(value);
674   };
676   Writer.prototype.rawValue = function rawValue (token) {
677     return token[1];
678   };
680   Writer.prototype.getConfigTags = function getConfigTags (config) {
681     if (isArray(config)) {
682       return config;
683     }
684     else if (config && typeof config === 'object') {
685       return config.tags;
686     }
687     else {
688       return undefined;
689     }
690   };
692   Writer.prototype.getConfigEscape = function getConfigEscape (config) {
693     if (config && typeof config === 'object' && !isArray(config)) {
694       return config.escape;
695     }
696     else {
697       return undefined;
698     }
699   };
701   var mustache = {
702     name: 'mustache.js',
703     version: '4.2.0',
704     tags: [ '{{', '}}' ],
705     clearCache: undefined,
706     escape: undefined,
707     parse: undefined,
708     render: undefined,
709     Scanner: undefined,
710     Context: undefined,
711     Writer: undefined,
712     /**
713      * Allows a user to override the default caching strategy, by providing an
714      * object with set, get and clear methods. This can also be used to disable
715      * the cache by setting it to the literal `undefined`.
716      */
717     set templateCache (cache) {
718       defaultWriter.templateCache = cache;
719     },
720     /**
721      * Gets the default or overridden caching object from the default writer.
722      */
723     get templateCache () {
724       return defaultWriter.templateCache;
725     }
726   };
728   // All high-level mustache.* functions use this writer.
729   var defaultWriter = new Writer();
731   /**
732    * Clears all cached templates in the default writer.
733    */
734   mustache.clearCache = function clearCache () {
735     return defaultWriter.clearCache();
736   };
738   /**
739    * Parses and caches the given template in the default writer and returns the
740    * array of tokens it contains. Doing this ahead of time avoids the need to
741    * parse templates on the fly as they are rendered.
742    */
743   mustache.parse = function parse (template, tags) {
744     return defaultWriter.parse(template, tags);
745   };
747   /**
748    * Renders the `template` with the given `view`, `partials`, and `config`
749    * using the default writer.
750    */
751   mustache.render = function render (template, view, partials, config) {
752     if (typeof template !== 'string') {
753       throw new TypeError('Invalid template! Template should be a "string" ' +
754                           'but "' + typeStr(template) + '" was given as the first ' +
755                           'argument for mustache#render(template, view, partials)');
756     }
758     return defaultWriter.render(template, view, partials, config);
759   };
761   // Export the escaping function so that the user may override it.
762   // See https://github.com/janl/mustache.js/issues/244
763   mustache.escape = escapeHtml;
765   // Export these mainly for testing, but also for advanced usage.
766   mustache.Scanner = Scanner;
767   mustache.Context = Context;
768   mustache.Writer = Writer;
770   return mustache;
772 })));