1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 | 1 1 1 1 1 1 1 1 1 1 1 1 29 1 1 1 1 1 1 1 1 12 12 1 9 1 10 10 1 10 10 10 7 10 1 26 26 26 1 1 26 28 2 2 26 26 26 1 26 26 26 26 1 15 15 6 9 9 15 1 19 1 18 18 18 18 18 20 2 2 18 18 18 18 1 10 1 9 9 9 10 1 1 20 2 20 1 7 7 7 1 7 1 103 1 63 1 88 77 11 1 73 73 73 73 73 73 73 73 9 9 64 7 7 57 57 66 66 20 46 1 43 1 30 30 30 30 6 24 3 21 3 18 18 18 3 30 1 30 30 30 30 30 27 30 7 7 7 30 1 14 14 13 3 3 10 3 3 3 10 1 11 1 1 10 10 7 7 7 7 7 3 7 3 3 7 3 3 1 29 1 30 30 30 30 30 6 3 3 3 3 30 1 30 30 30 30 30 30 30 30 30 30 30 1 29 29 1 3 3 3 2 1 3 1 35 1 1 1 1 1 1 6 1 1 37 37 2 35 1 35 5 35 8 7 35 6 2 35 7 35 35 35 1 4 4 3 4 3 4 4 1 4 4 3 7 7 2 5 4 1 5 5 4 4 3 3 5 3 5 5 1 6 6 6 6 18 18 18 18 12 6 1 6 6 6 12 12 12 6 5 6 1 7 1 1 1 2 2 4 4 3 2 1 3 1 9 9 9 9 8 3 8 3 8 6 8 4 9 1 15 15 15 15 15 15 15 13 13 4 15 5 10 1 1 1 1 9 9 9 9 15 15 1 1 26 | /** * @module jsdoc/util/templateHelper */ 'use strict'; var catharsis = require('catharsis'); var dictionary = require('jsdoc/tag/dictionary'); var env = require('jsdoc/env'); var name = require('jsdoc/name'); var util = require('util'); var hasOwnProp = Object.prototype.hasOwnProperty; var MODULE_NAMESPACE = 'module:'; var files = {}; var ids = {}; // each container gets its own html file var containers = ['class', 'module', 'external', 'namespace', 'mixin', 'interface']; var tutorials; /** Sets tutorials map. @param {jsdoc.tutorial.Tutorial} root - Root tutorial node. */ exports.setTutorials = function(root) { tutorials = root; }; exports.globalName = name.SCOPE.NAMES.GLOBAL; exports.fileExtension = '.html'; exports.scopeToPunc = name.scopeToPunc; var linkMap = { // two-way lookup longnameToUrl: {}, urlToLongname: {}, // one-way lookup (IDs are only unique per file) longnameToId: {} }; // two-way lookup var tutorialLinkMap = { nameToUrl: {}, urlToName: {} }; var longnameToUrl = exports.longnameToUrl = linkMap.longnameToUrl; var longnameToId = exports.longnameToId = linkMap.longnameToId; var registerLink = exports.registerLink = function(longname, fileUrl) { linkMap.longnameToUrl[longname] = fileUrl; linkMap.urlToLongname[fileUrl] = longname; }; var registerId = exports.registerId = function(longname, fragment) { linkMap.longnameToId[longname] = fragment; }; function getNamespace(kind) { Iif (dictionary.isNamespace(kind)) { return kind + ':'; } return ''; } function formatNameForLink(doclet, options) { var newName = getNamespace(doclet.kind) + (doclet.name || '') + (doclet.variation || ''); var scopePunc = exports.scopeToPunc[doclet.scope] || ''; // Only prepend the scope punctuation if it's not the same character that marks the start of a // fragment ID. Using `#` in HTML5 fragment IDs is legal, but URLs like `foo.html##bar` are // just confusing. if (scopePunc !== '#') { newName = scopePunc + newName; } return newName; } function makeUniqueFilename(filename, str) { var key = filename.toLowerCase(); var nonUnique = true; // don't allow filenames to begin with an underscore if (!filename.length || filename[0] === '_') { filename = '-' + filename; key = filename.toLowerCase(); } // append enough underscores to make the filename unique while (nonUnique) { if ( hasOwnProp.call(files, key) ) { filename += '_'; key = filename.toLowerCase(); } else { nonUnique = false; } } files[key] = str; return filename; } /** * Convert a string to a unique filename, including an extension. * * Filenames are cached to ensure that they are used only once. For example, if the same string is * passed in twice, two different filenames will be returned. * * Also, filenames are not considered unique if they are capitalized differently but are otherwise * identical. * @param {string} str The string to convert. * @return {string} The filename to use for the string. */ var getUniqueFilename = exports.getUniqueFilename = function(str) { var namespaces = dictionary.getNamespaces().join('|'); var basename = (str || '') // use - instead of : in namespace prefixes .replace(new RegExp('^(' + namespaces + '):'), '$1-') // replace characters that can cause problems on some filesystems .replace(/[\\\/?*:|'"<>]/g, '_') // use - instead of ~ to denote 'inner' .replace(/~/g, '-') // use _ instead of # to denote 'instance' .replace(/\#/g, '_') // use _ instead of / (for example, in module names) .replace(/\//g, '_') // remove the variation, if any .replace(/\([\s\S]*\)$/, '') // make sure we don't create hidden files, or files whose names start with a dash .replace(/^[\.\-]/, ''); // in case we've now stripped the entire basename (uncommon, but possible): basename = basename.length ? basename : '_'; return makeUniqueFilename(basename, str) + exports.fileExtension; }; /** * Get a longname's filename if one has been registered; otherwise, generate a unique filename, then * register the filename. * @private */ function getFilename(longname) { var fileUrl; if ( hasOwnProp.call(longnameToUrl, longname) ) { fileUrl = longnameToUrl[longname]; } else { fileUrl = getUniqueFilename(longname); registerLink(longname, fileUrl); } return fileUrl; } /** * Check whether a symbol is the only symbol exported by a module (as in * `module.exports = function() {};`). * * @private * @param {module:jsdoc/doclet.Doclet} doclet - The doclet for the symbol. * @return {boolean} `true` if the symbol is the only symbol exported by a module; otherwise, * `false`. */ function isModuleExports(doclet) { return doclet.longname && doclet.longname === doclet.name && doclet.longname.indexOf(MODULE_NAMESPACE) === 0 && doclet.kind !== 'module'; } function makeUniqueId(filename, id) { var key; var nonUnique = true; key = id.toLowerCase(); // HTML5 IDs cannot contain whitespace characters id = id.replace(/\s/g, ''); // append enough underscores to make the identifier unique while (nonUnique) { if ( hasOwnProp.call(ids, filename) && hasOwnProp.call(ids[filename], key) ) { id += '_'; key = id.toLowerCase(); } else { nonUnique = false; } } ids[filename] = ids[filename] || {}; ids[filename][key] = id; return id; } /** * Get a doclet's ID if one has been registered; otherwise, generate a unique ID, then register * the ID. * @private */ function getId(longname, id) { if ( hasOwnProp.call(longnameToId, longname) ) { id = longnameToId[longname]; } else Iif (!id) { // no ID required return ''; } else { id = makeUniqueId(longname, id); registerId(longname, id); } return id; } /** * Convert a doclet to an identifier that is unique for a specified filename. * * Identifiers are not considered unique if they are capitalized differently but are otherwise * identical. * * @method * @param {string} filename - The file in which the identifier will be used. * @param {string} doclet - The doclet to convert. * @return {string} A unique identifier based on the file and doclet. */ var getUniqueId = exports.getUniqueId = makeUniqueId; var htmlsafe = exports.htmlsafe = function(str) { if (typeof str !== 'string') { str = String(str); } return str.replace(/&/g, '&') .replace(/</g, '<'); }; function parseType(longname) { var err; try { return catharsis.parse(longname, {jsdoc: true}); } catch (e) { err = new Error('unable to parse ' + longname + ': ' + e.message); require('jsdoc/util/logger').error(err); return longname; } } function stringifyType(parsedType, cssClass, stringifyLinkMap) { return require('catharsis').stringify(parsedType, { cssClass: cssClass, htmlSafe: true, links: stringifyLinkMap }); } function hasUrlPrefix(text) { return (/^(http|ftp)s?:\/\//).test(text); } function isComplexTypeExpression(expr) { // record types, type unions, and type applications all count as "complex" return /^{.+}$/.test(expr) || /^.+\|.+$/.test(expr) || /^.+<.+>$/.test(expr); } function fragmentHash(fragmentId) { if (!fragmentId) { return ''; } return '#' + fragmentId; } /** * Build an HTML link to the symbol with the specified longname. If the longname is not * associated with a URL, this method simply returns the link text, if provided, or the longname. * * The `longname` parameter can also contain a URL rather than a symbol's longname. * * This method supports type applications that can contain one or more types, such as * `Array.<MyClass>` or `Array.<(MyClass|YourClass)>`. In these examples, the method attempts to * replace `Array`, `MyClass`, and `YourClass` with links to the appropriate types. The link text * is ignored for type applications. * * @param {string} longname - The longname (or URL) that is the target of the link. * @param {string=} linkText - The text to display for the link, or `longname` if no text is * provided. * @param {Object} options - Options for building the link. * @param {string=} options.cssClass - The CSS class (or classes) to include in the link's `<a>` * tag. * @param {string=} options.fragmentId - The fragment identifier (for example, `name` in * `foo.html#name`) to append to the link target. * @param {string=} options.linkMap - The link map in which to look up the longname. * @param {boolean=} options.monospace - Indicates whether to display the link text in a monospace * font. * @return {string} The HTML link, or the link text if the link is not available. */ function buildLink(longname, linkText, options) { var classString = options.cssClass ? util.format(' class="%s"', options.cssClass) : ''; var fileUrl; var fragmentString = fragmentHash(options.fragmentId); var stripped; var text; var parsedType; // handle cases like: // @see <http://example.org> // @see http://example.org stripped = longname ? longname.replace(/^<|>$/g, '') : ''; if ( hasUrlPrefix(stripped) ) { fileUrl = stripped; text = linkText || stripped; } // handle complex type expressions that may require multiple links // (but skip anything that looks like an inline tag or HTML tag) else if (longname && isComplexTypeExpression(longname) && /\{\@.+\}/.test(longname) === false && /^<[\s\S]+>/.test(longname) === false) { parsedType = parseType(longname); return stringifyType(parsedType, options.cssClass, options.linkMap); } else { fileUrl = hasOwnProp.call(options.linkMap, longname) ? options.linkMap[longname] : ''; text = linkText || longname; } text = options.monospace ? '<code>' + text + '</code>' : text; if (!fileUrl) { return text; } else { return util.format('<a href="%s"%s>%s</a>', encodeURI(fileUrl + fragmentString), classString, text); } } /** * Retrieve an HTML link to the symbol with the specified longname. If the longname is not * associated with a URL, this method simply returns the link text, if provided, or the longname. * * The `longname` parameter can also contain a URL rather than a symbol's longname. * * This method supports type applications that can contain one or more types, such as * `Array.<MyClass>` or `Array.<(MyClass|YourClass)>`. In these examples, the method attempts to * replace `Array`, `MyClass`, and `YourClass` with links to the appropriate types. The link text * is ignored for type applications. * * @param {string} longname - The longname (or URL) that is the target of the link. * @param {string=} linkText - The text to display for the link, or `longname` if no text is * provided. * @param {string=} cssClass - The CSS class (or classes) to include in the link's `<a>` tag. * @param {string=} fragmentId - The fragment identifier (for example, `name` in `foo.html#name`) to * append to the link target. * @return {string} The HTML link, or a plain-text string if the link is not available. */ var linkto = exports.linkto = function(longname, linkText, cssClass, fragmentId) { return buildLink(longname, linkText, { cssClass: cssClass, fragmentId: fragmentId, linkMap: longnameToUrl }); }; function useMonospace(tag, text) { var cleverLinks; var monospaceLinks; var result; if ( hasUrlPrefix(text) ) { result = false; } else if (tag === 'linkplain') { result = false; } else if (tag === 'linkcode') { result = true; } else { cleverLinks = env.conf.templates.cleverLinks; monospaceLinks = env.conf.templates.monospaceLinks; if (monospaceLinks || cleverLinks) { result = true; } } return result || false; } function splitLinkText(text) { var linkText; var target; var splitIndex; // if a pipe is not present, we split on the first space splitIndex = text.indexOf('|'); if (splitIndex === -1) { splitIndex = text.search(/\s/); } if (splitIndex !== -1) { linkText = text.substr(splitIndex + 1); // Normalize subsequent newlines to a single space. linkText = linkText.replace(/\n+/, ' '); target = text.substr(0, splitIndex); } return { linkText: linkText, target: target || text }; } var tutorialToUrl = exports.tutorialToUrl = function(tutorial) { var fileUrl; var node = tutorials.getByName(tutorial); // no such tutorial if (!node) { require('jsdoc/util/logger').error( new Error('No such tutorial: ' + tutorial) ); return null; } // define the URL if necessary if (!hasOwnProp.call(tutorialLinkMap.nameToUrl, node.name)) { fileUrl = 'tutorial-' + getUniqueFilename(node.name); tutorialLinkMap.nameToUrl[node.name] = fileUrl; tutorialLinkMap.urlToName[fileUrl] = node.name; } return tutorialLinkMap.nameToUrl[node.name]; }; /** * Retrieve a link to a tutorial, or the name of the tutorial if the tutorial is missing. If the * `missingOpts` parameter is supplied, the names of missing tutorials will be prefixed by the * specified text and wrapped in the specified HTML tag and CSS class. * * @todo Deprecate missingOpts once we have a better error-reporting mechanism. * @param {string} tutorial The name of the tutorial. * @param {string} content The link text to use. * @param {object} [missingOpts] Options for displaying the name of a missing tutorial. * @param {string} missingOpts.classname The CSS class to wrap around the tutorial name. * @param {string} missingOpts.prefix The prefix to add to the tutorial name. * @param {string} missingOpts.tag The tag to wrap around the tutorial name. * @return {string} An HTML link to the tutorial, or the name of the tutorial with the specified * options. */ var toTutorial = exports.toTutorial = function(tutorial, content, missingOpts) { if (!tutorial) { require('jsdoc/util/logger').error( new Error('Missing required parameter: tutorial') ); return null; } var node = tutorials.getByName(tutorial); // no such tutorial if (!node) { missingOpts = missingOpts || {}; var tag = missingOpts.tag; var classname = missingOpts.classname; var link = tutorial; if (missingOpts.prefix) { link = missingOpts.prefix + link; } if (tag) { link = '<' + tag + (classname ? (' class="' + classname + '">') : '>') + link; link += '</' + tag + '>'; } return link; } content = content || node.title; return '<a href="' + tutorialToUrl(tutorial) + '">' + content + '</a>'; }; /** Find symbol {@link ...} and {@tutorial ...} strings in text and turn into html links */ exports.resolveLinks = function(str) { var replaceInlineTags = require('jsdoc/tag/inline').replaceInlineTags; function extractLeadingText(string, completeTag) { var tagIndex = string.indexOf(completeTag); var leadingText = null; var leadingTextRegExp = /\[(.+?)\]/g; var leadingTextInfo = leadingTextRegExp.exec(string); // did we find leading text, and if so, does it immediately precede the tag? while (leadingTextInfo && leadingTextInfo.length) { if (leadingTextInfo.index + leadingTextInfo[0].length === tagIndex) { string = string.replace(leadingTextInfo[0], ''); leadingText = leadingTextInfo[1]; break; } leadingTextInfo = leadingTextRegExp.exec(string); } return { leadingText: leadingText, string: string }; } function processLink(string, tagInfo) { var leading = extractLeadingText(string, tagInfo.completeTag); var linkText = leading.leadingText; var monospace; var split; var target; string = leading.string; split = splitLinkText(tagInfo.text); target = split.target; linkText = linkText || split.linkText; monospace = useMonospace(tagInfo.tag, tagInfo.text); return string.replace( tagInfo.completeTag, buildLink(target, linkText, { linkMap: longnameToUrl, monospace: monospace }) ); } function processTutorial(string, tagInfo) { var leading = extractLeadingText(string, tagInfo.completeTag); string = leading.string; return string.replace( tagInfo.completeTag, toTutorial(tagInfo.text, leading.leadingText) ); } var replacers = { link: processLink, linkcode: processLink, linkplain: processLink, tutorial: processTutorial }; return replaceInlineTags(str, replacers).newString; }; /** Convert tag text like "Jane Doe <jdoe@example.org>" into a mailto link */ exports.resolveAuthorLinks = function(str) { var author; var matches = str.match(/^\s?([\s\S]+)\b\s+<(\S+@\S+)>\s?$/); if (matches && matches.length === 3) { author = '<a href="mailto:' + matches[2] + '">' + htmlsafe(matches[1]) + '</a>'; } else { author = htmlsafe(str); } return author; }; /** * Find items in a TaffyDB database that match the specified key-value pairs. * @param {TAFFY} data The TaffyDB database to search. * @param {object|function} spec Key-value pairs to match against (for example, * `{ longname: 'foo' }`), or a function that returns `true` if a value matches or `false` if it * does not match. * @return {array<object>} The matching items. */ var find = exports.find = function(data, spec) { return data(spec).get(); }; /** * Retrieve all of the following types of members from a set of doclets: * * + Classes * + Externals * + Globals * + Mixins * + Modules * + Namespaces * + Events * @param {TAFFY} data The TaffyDB database to search. * @return {object} An object with `classes`, `externals`, `globals`, `mixins`, `modules`, * `events`, and `namespaces` properties. Each property contains an array of objects. */ exports.getMembers = function(data) { var members = { classes: find( data, {kind: 'class'} ), externals: find( data, {kind: 'external'} ), events: find( data, {kind: 'event'} ), globals: find(data, { kind: ['member', 'function', 'constant', 'typedef'], memberof: { isUndefined: true } }), mixins: find( data, {kind: 'mixin'} ), modules: find( data, {kind: 'module'} ), namespaces: find( data, {kind: 'namespace'} ), interfaces: find( data, {kind: 'interface'} ) }; // strip quotes from externals, since we allow quoted names that would normally indicate a // namespace hierarchy (as in `@external "jquery.fn"`) // TODO: we should probably be doing this for other types of symbols, here or elsewhere; see // jsdoc3/jsdoc#396 members.externals = members.externals.map(function(doclet) { doclet.name = doclet.name.replace(/(^"|"$)/g, ''); return doclet; }); // functions that are also modules (as in `module.exports = function() {};`) are not globals members.globals = members.globals.filter(function(doclet) { return !isModuleExports(doclet); }); return members; }; /** * Retrieve the member attributes for a doclet (for example, `virtual`, `static`, and * `readonly`). * @param {object} d The doclet whose attributes will be retrieved. * @return {array<string>} The member attributes for the doclet. */ exports.getAttribs = function(d) { var attribs = []; if (!d) { return attribs; } if (d.virtual) { attribs.push('abstract'); } if (d.access && d.access !== 'public') { attribs.push(d.access); } if (d.scope && d.scope !== 'instance' && d.scope !== name.SCOPE.NAMES.GLOBAL) { if (d.kind === 'function' || d.kind === 'member' || d.kind === 'constant') { attribs.push(d.scope); } } if (d.readonly === true) { if (d.kind === 'member') { attribs.push('readonly'); } } if (d.kind === 'constant') { attribs.push('constant'); } Iif (d.nullable === true) { attribs.push('nullable'); } else Iif (d.nullable === false) { attribs.push('non-null'); } return attribs; }; /** * Retrieve links to allowed types for the member. * * @param {Object} d - The doclet whose types will be retrieved. * @param {string} [cssClass] - The CSS class to include in the `class` attribute for each link. * @return {Array.<string>} HTML links to allowed types for the member. */ exports.getSignatureTypes = function(d, cssClass) { var types = []; if (d.type && d.type.names) { types = d.type.names; } if (types && types.length) { types = types.map(function(t) { return linkto(t, htmlsafe(t), cssClass); }); } return types; }; /** * Retrieve names of the parameters that the member accepts. If a value is provided for `optClass`, * the names of optional parameters will be wrapped in a `<span>` tag with that class. * @param {object} d The doclet whose parameter names will be retrieved. * @param {string} [optClass] The class to assign to the `<span>` tag that is wrapped around the * names of optional parameters. If a value is not provided, optional parameter names will not be * wrapped with a `<span>` tag. Must be a legal value for a CSS class name. * @return {array<string>} An array of parameter names, with or without `<span>` tags wrapping the * names of optional parameters. */ exports.getSignatureParams = function(d, optClass) { var pnames = []; if (d.params) { d.params.forEach(function(p) { Eif (p.name && p.name.indexOf('.') === -1) { if (p.optional && optClass) { pnames.push('<span class="' + optClass + '">' + p.name + '</span>'); } else { pnames.push(p.name); } } }); } return pnames; }; /** * Retrieve links to types that the member can return. * * @param {Object} d - The doclet whose types will be retrieved. * @param {string} [cssClass] - The CSS class to include in the `class` attribute for each link. * @return {Array.<string>} HTML links to types that the member can return. */ exports.getSignatureReturns = function(d, cssClass) { var returnTypes = []; if (d.returns) { d.returns.forEach(function(r) { if (r && r.type && r.type.names) { Eif (!returnTypes.length) { returnTypes = r.type.names; } } }); } if (returnTypes && returnTypes.length) { returnTypes = returnTypes.map(function(r) { return linkto(r, htmlsafe(r), cssClass); }); } return returnTypes; }; /** * Retrieve an ordered list of doclets for a symbol's ancestors. * * @param {TAFFY} data - The TaffyDB database to search. * @param {Object} doclet - The doclet whose ancestors will be retrieved. * @return {Array.<module:jsdoc/doclet.Doclet>} A array of ancestor doclets, sorted from most to * least distant. */ exports.getAncestors = function(data, doclet) { var ancestors = []; var doc = doclet; var previousDoc; while (doc) { previousDoc = doc; doc = find(data, {longname: doc.memberof})[0]; // prevent infinite loop that can be caused by duplicated module definitions Iif (previousDoc === doc) { break; } if (doc) { ancestors.unshift(doc); } } return ancestors; }; /** * Retrieve links to a member's ancestors. * * @param {TAFFY} data - The TaffyDB database to search. * @param {Object} doclet - The doclet whose ancestors will be retrieved. * @param {string} [cssClass] - The CSS class to include in the `class` attribute for each link. * @return {Array.<string>} HTML links to a member's ancestors. */ exports.getAncestorLinks = function(data, doclet, cssClass) { var ancestors = exports.getAncestors(data, doclet); var links = []; ancestors.forEach(function(ancestor) { var linkText = (exports.scopeToPunc[ancestor.scope] || '') + ancestor.name; var link = linkto(ancestor.longname, linkText, cssClass); links.push(link); }); if (links.length) { links[links.length - 1] += (exports.scopeToPunc[doclet.scope] || ''); } return links; }; /** * Iterates through all the doclets in `data`, ensuring that if a method * @listens to an event, then that event has a 'listeners' array with the * longname of the listener in it. * * @param {TAFFY} data - The TaffyDB database to search. */ exports.addEventListeners = function(data) { // TODO: do this on the *pruned* data // find all doclets that @listen to something. var listeners = find(data, function () { return this.listens && this.listens.length; }); Iif (!listeners.length) { return; } var doc, l, _events = {}; // just a cache to prevent me doing so many lookups listeners.forEach(function (listener) { l = listener.listens; l.forEach(function (eventLongname) { doc = _events[eventLongname] || find(data, {longname: eventLongname, kind: 'event'})[0]; if (doc) { if (!doc.listeners) { doc.listeners = [listener.longname]; } else { doc.listeners.push(listener.longname); } _events[eventLongname] = _events[eventLongname] || doc; } }); }); }; /** * Remove members that will not be included in the output, including: * * + Undocumented members. * + Members tagged `@ignore`. * + Members of anonymous classes. * + Members tagged `@private`, unless the `private` option is enabled. * + Members tagged with anything other than specified by the `access` options. * @param {TAFFY} data The TaffyDB database to prune. * @return {TAFFY} The pruned database. */ exports.prune = function(data) { data({undocumented: true}).remove(); data({ignore: true}).remove(); data({memberof: '<anonymous>'}).remove(); if (!env.opts.access || (env.opts.access && env.opts.access.indexOf('all') === -1)) { if (env.opts.access && env.opts.access.indexOf('public') === -1) { data({access: 'public'}).remove(); } if (env.opts.access && env.opts.access.indexOf('protected') === -1) { data({access: 'protected'}).remove(); } if (!env.opts.private && (!env.opts.access || (env.opts.access && env.opts.access.indexOf('private') === -1))) { data({access: 'private'}).remove(); } if (env.opts.access && env.opts.access.indexOf('undefined') === -1) { data({access: {isUndefined: true}}).remove(); } } return data; }; /** * Create a URL that points to the generated documentation for the doclet. * * If a doclet corresponds to an output file (for example, if the doclet represents a class), the * URL will consist of a filename. * * If a doclet corresponds to a smaller portion of an output file (for example, if the doclet * represents a method), the URL will consist of a filename and a fragment ID. * * @param {module:jsdoc/doclet.Doclet} doclet - The doclet that will be used to create the URL. * @return {string} The URL to the generated documentation for the doclet. */ exports.createLink = function(doclet) { var fakeContainer; var filename; var fileUrl; var fragment = ''; var longname = doclet.longname; var match; // handle doclets in which doclet.longname implies that the doclet gets its own HTML file, but // doclet.kind says otherwise. this happens due to mistagged JSDoc (for example, a module that // somehow has doclet.kind set to `member`). // TODO: generate a warning (ideally during parsing!) if (containers.indexOf(doclet.kind) === -1) { match = /(\S+):/.exec(longname); if (match && containers.indexOf(match[1]) !== -1) { fakeContainer = match[1]; } } // the doclet gets its own HTML file if ( containers.indexOf(doclet.kind) !== -1 || isModuleExports(doclet) ) { filename = getFilename(longname); } // mistagged version of a doclet that gets its own HTML file else if ( containers.indexOf(doclet.kind) === -1 && fakeContainer ) { filename = getFilename(doclet.memberof || longname); Eif (doclet.name !== doclet.longname) { fragment = formatNameForLink(doclet); fragment = getId(longname, fragment); } } // the doclet is within another HTML file else { filename = getFilename(doclet.memberof || exports.globalName); Eif ( (doclet.name !== doclet.longname) || (doclet.scope === name.SCOPE.NAMES.GLOBAL) ) { fragment = formatNameForLink(doclet); fragment = getId(longname, fragment); } } fileUrl = encodeURI( filename + fragmentHash(fragment) ); return fileUrl; }; // TODO: docs exports.longnamesToTree = name.longnamesToTree; /** * Replace the existing tag dictionary with a new tag dictionary. * * Used for testing only. Do not call this method directly. Instead, call * {@link module:jsdoc/doclet._replaceDictionary}, which also updates this module's tag dictionary. * * @private * @param {module:jsdoc/tag/dictionary.Dictionary} dict - The new tag dictionary. */ exports._replaceDictionary = function _replaceDictionary(dict) { dictionary = dict; }; |