(function() { var _ = require('underscore/underscore'), template = require('underscore/template'), fs = require('fs'), helper = require('jsdoc/util/templateHelper'), scopeToPunc = { 'static': '.', 'inner': '~', 'instance': '#' }; template.settings.evaluate = /<\?js([\s\S]+?)\?>/g; template.settings.interpolate = /<\?js=([\s\S]+?)\?>/g; /** @global @param {TAFFY} data See . @param {object} opts @param {Tutorial} tutorials */ publish = function(data, opts, tutorials) { var out = '', containerTemplate = template.render(fs.readFileSync(__dirname + '/templates/default/tmpl/container.tmpl')), tutorialTemplate = template.render(fs.readFileSync(__dirname + '/templates/default/tmpl/tutorial.tmpl')); // set up tutorials for helper helper.setTutorials(tutorials); function render(tmpl, partialData) { var renderFunction = arguments.callee.cache[tmpl]; if (!renderFunction) { renderFunction = arguments.callee.cache[tmpl] = template.render(fs.readFileSync(__dirname + '/templates/default/tmpl/'+tmpl)); } partialData.render = arguments.callee; partialData.find = find; partialData.linkto = linkto; partialData.tutoriallink = tutoriallink; partialData.htmlsafe = htmlsafe; return renderFunction.call(partialData, partialData); } render.cache = {}; function find(spec) { return data.get( data.find(spec) ); } function htmlsafe(str) { return str.replace(/'+p.name+''); } else { pnames.push(p.name); } } }); } f.signature = (f.signature || '') + '('+pnames.join(', ')+')'; } function generateAncestry(thisdoc) { var ancestors = [], doc = thisdoc; while (doc = doc.memberof) { doc = find({longname: doc}); if (doc) { doc = doc[0]; } if (!doc) break; ancestors.unshift( linkto(doc.longname, (scopeToPunc[doc.scope] || '') + doc.name) ); } if (ancestors.length) { ancestors[ancestors.length-1] += (scopeToPunc[thisdoc.scope] || ''); } return ancestors; } function addSignatureReturns(f) { var returnTypes = []; if (f.returns) { f.returns.forEach(function(r) { if (r.type && r.type.names) { if (! returnTypes.length) { returnTypes = r.type.names; } } }); } if (returnTypes && returnTypes.length) { returnTypes = _.map(returnTypes, function(r) { return linkto(r); }); } f.signature = ''+(f.signature || '') + '' + ''+(returnTypes.length? ' → {'+returnTypes.join('|')+'}' : '')+''; } function addSignatureType(f) { var types = []; if (f.type && f.type.names) { types = f.type.names; } f.signature = (f.signature || '') + ''+htmlsafe(types.length? ' :'+types.join('|') : '')+''; } function addAttribs(f) { var attribs = []; if (f.virtual) { attribs.push('virtual'); } if (f.access && f.access !== 'public') { attribs.push(f.access); } if (f.scope && f.scope !== 'instance' && f.scope !== 'global') { if (f.kind == 'function' || f.kind == 'member' || f.kind == 'constant') attribs.push(f.scope); } if (f.readonly === true) { if (f.kind == 'member') attribs.push('readonly'); } if (f.kind === 'constant') { attribs.push('constant'); f.kind = 'member'; } f.attribs = ''+htmlsafe(attribs.length? '<'+attribs.join(', ')+'> ' : '')+''; } data.remove({undocumented: true}); data.remove({ignore: true}); if (!opts.private) { data.remove({access: 'private'}); } data.remove({memberof: ''}); var packageInfo = (find({kind: 'package'}) || []) [0]; //function renderLinks(text) { // return helper.resolveLinks(text); //} data.forEach(function(doclet) { doclet.signature = ''; doclet.attribs = ''; if (doclet.kind === 'member') { addSignatureType(doclet); addAttribs(doclet) } if (doclet.kind === 'constant') { addSignatureType(doclet); addAttribs(doclet) } if (doclet.examples) { doclet.examples = doclet.examples.map(function(example) { var caption, code; if (example.match(/^\s*([\s\S]+?)<\/caption>(\s*[\n\r])([\s\S]+)$/i)) { caption = RegExp.$1; code = RegExp.$3; } return { caption: caption || '', code: code || example }; }); } if (doclet.see) { doclet.see.forEach(function(seeItem, i) { doclet.see[i] = hashToLink(doclet, seeItem); }); } }); data.orderBy(['longname', 'version', 'since']); // kinds of containers var globals = find( {kind: ['member', 'function', 'constant', 'typedef'], memberof: {isUndefined: true}} ), modules = find({kind: 'module'}), externals = find({kind: 'external'}), mixins = find({kind: 'mixin'}), namespaces = find({kind: 'namespace'}); var outdir = opts.destination; if (packageInfo) { outdir += '/' + packageInfo.name + '/' + packageInfo.version + '/'; } fs.mkPath(outdir); // copy static files to outdir var fromDir = __dirname + '/templates/default/static', staticFiles = fs.ls(fromDir, 3); staticFiles.forEach(function(fileName) { var toDir = fs.toDir(fileName.replace(fromDir, outdir)); fs.mkPath(toDir); fs.copyFile(fileName, toDir); }); function linkto(longname, linktext) { var url = helper.longnameToUrl[longname]; return url? ''+(linktext || longname)+'' : (linktext || longname); } function tutoriallink(tutorial) { return helper.toTutorial(tutorial); } var containers = ['class', 'module', 'external', 'namespace', 'mixin']; data.forEach(function(doclet) { var url = helper.createLink(doclet); helper.registerLink(doclet.longname, url); }); data.forEach(function(doclet) { var url = helper.longnameToUrl[doclet.longname]; if (url.indexOf('#') > -1) { doclet.id = helper.longnameToUrl[doclet.longname].split(/#/).pop(); } else { doclet.id = doclet.name; } if (doclet.kind === 'function' || doclet.kind === 'class') { addSignatureParams(doclet); addSignatureReturns(doclet); addAttribs(doclet); } }) // do this after the urls have all been generated data.forEach(function(doclet) { doclet.ancestors = generateAncestry(doclet); }); var nav = '', seen = {}; var moduleNames = find({kind: 'module'}); if (moduleNames.length) { nav += '

Modules

'; } var externalNames = find({kind: 'external'}); if (externalNames.length) { nav += '

Externals

'; } var classNames = find({kind: 'class'}); if (classNames.length) { nav += '

Classes

'; } var namespaceNames = find({kind: 'namespace'}); if (namespaceNames.length) { nav += '

Namespaces

'; } // var constantNames = find({kind: 'constants'}); // if (constantNames.length) { // nav += '

Constants

'; // } var mixinNames = find({kind: 'mixin'}); if (mixinNames.length) { nav += '

Mixins

'; } if (tutorials.children.length) { nav += '

Tutorials

'; } var globalNames = find({kind: ['member', 'function', 'constant', 'typedef'], 'memberof': {'isUndefined': true}}); if (globalNames.length) { nav += '

Global

'; } for (var longname in helper.longnameToUrl) { var classes = find({kind: 'class', longname: longname}); if (classes.length) generate('Class: '+classes[0].name, classes, helper.longnameToUrl[longname]); var modules = find({kind: 'module', longname: longname}); if (modules.length) generate('Module: '+modules[0].name, modules, helper.longnameToUrl[longname]); var namespaces = find({kind: 'namespace', longname: longname}); if (namespaces.length) generate('Namespace: '+namespaces[0].name, namespaces, helper.longnameToUrl[longname]); // var constants = find({kind: 'constant', longname: longname}); // if (constants.length) generate('Constant: '+constants[0].name, constants, helper.longnameToUrl[longname]); var mixins = find({kind: 'mixin', longname: longname}); if (mixins.length) generate('Mixin: '+mixins[0].name, mixins, helper.longnameToUrl[longname]); var externals = find({kind: 'external', longname: longname}); if (externals.length) generate('External: '+externals[0].name, externals, helper.longnameToUrl[longname]); } if (globals.length) generate('Global', [{kind: 'globalobj'}], 'global.html'); function generate(title, docs, filename) { var data = { title: title, docs: docs, nav: nav, // helpers render: render, find: find, linkto: linkto, tutoriallink: tutoriallink, htmlsafe: htmlsafe }; var path = outdir + '/' + filename, html = containerTemplate.call(data, data); html = helper.resolveLinks(html); // turn {@link foo} into foo fs.writeFileSync(path, html) } function generateTutorial(title, tutorial, filename) { var data = { title: title, header: tutorial.title, content: tutorial.parse(), children: tutorial.children, nav: nav, // helpers render: render, find: find, linkto: linkto, tutoriallink: tutoriallink, htmlsafe: htmlsafe }; var path = outdir + '/' + filename, html = tutorialTemplate.call(data, data); // yes, you can use {@link} in tutorials too! html = helper.resolveLinks(html); // turn {@link foo} into foo fs.writeFileSync(path, html) } // tutorials can have only one parent so there is no risk for loops function saveChildren(node) { node.children.forEach(function(child) { generateTutorial('Tutorial: '+child.title, child, helper.tutorialToUrl(child.name)); }); } saveChildren(tutorials); } function hashToLink(doclet, hash) { if ( !/^(#.+)/.test(hash) ) { return hash; } var url = helper.createLink(doclet); url = url.replace(/(#.+|$)/, hash); return ''+hash+''; } })();