(function() {
var template = require('underscore/template'),
fs = require('fs'),
helper = require('jsdoc/util/templateHelper');
template.settings.evaluate = /<\?js([\s\S]+?)\?>/g;
template.settings.interpolate = /<\?js=([\s\S]+?)\?>/g;
/**
@global
@param {TAFFY} data See .
@param {object} opts
*/
publish = function(data, opts) {
var out = '',
containerTemplate = template.render(fs.readFileSync(__dirname + '/templates/default/tmpl/container.tmpl'));
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.htmlsafe = htmlsafe;
return renderFunction.call(partialData, partialData);
}
render.cache = {};
function find(spec) {
return data.get( data.find(spec) );
}
function htmlsafe(str) {
return str.replace(/'+htmlsafe(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.access && f.access !== 'public') {
attribs.push(f.access);
}
if (f.scope && f.scope !== 'instance') {
if (f.kind == 'function' || f.kind == 'property') attribs.push(f.scope);
}
if (f.readonly === true) {
if (f.kind == 'property') attribs.push('readonly');
}
f.attribs = ''+htmlsafe(attribs.length? '<'+attribs.join(', ')+'> ' : '')+'';
}
data.remove({undocumented: true});
var packageInfo = (data.get( data.find({kind: 'package'}) ) || []) [0];
//function renderLinks(text) {
// return helper.resolveLinks(text);
//}
data.forEach(function(doclet) {
doclet.signature = '';
doclet.attribs = '';
if (doclet.kind === 'function' || doclet.kind === 'class') {
addSignatureParams(doclet);
addSignatureReturns(doclet);
addAttribs(doclet);
}
if (doclet.kind === 'property') {
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
};
});
}
else 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 = data.get( data.find({kind: ['property', 'function'], memberof: {isUndefined: true}}) ),
modules = data.get( data.find({kind: 'module'}) ),
namespaces = data.get( data.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);
}
var containers= ['class', 'module', 'namespace'];
data.forEach(function(doclet) {
var url = helper.createLink(doclet);
helper.registerLink(doclet.longname, url);
});
// do this after the urls have all been generated
data.forEach(function(doclet) {
//if (doclet.classdesc) doclet.classdesc = renderLinks(doclet.classdesc);
//if (doclet.description) doclet.description = renderLinks(doclet.description);
doclet.ancestors = generateAncestry(doclet);
});
var nav = '',
seen = {};
var moduleNames = data.get( data.find({kind: 'module'}) );
if (moduleNames.length) {
nav = nav + 'Modules
';
moduleNames.forEach(function(m) {
if ( !seen.hasOwnProperty(m.longname) ) nav += '- '+linkto(m.longname, m.name)+'
';
seen[m.longname] = true;
});
nav = nav + '
';
}
var namespaceNames = data.get( data.find({kind: 'namespace'}) );
if (namespaceNames.length) {
nav = nav + 'Namespaces
';
namespaceNames.forEach(function(n) {
if ( !seen.hasOwnProperty(n.longname) ) nav += '- '+linkto(n.longname, n.name)+'
';
seen[n.longname] = true;
});
nav = nav + '
';
}
var classNames = data.get( data.find({kind: 'class'}) );
if (classNames.length) {
nav = nav + 'Classes
';
classNames.forEach(function(c) {
var moduleSameName = data.get( data.find({kind: 'module', longname: c.longname}) );
if (moduleSameName.length) {
c.name = c.name.replace('module:', 'require(')+')';
moduleSameName[0].module = c;
}
if (!seen.hasOwnProperty(c.longname) ) nav += '- '+linkto(c.longname, c.name)+'
';
seen[c.longname] = true;
});
nav = nav + '
';
}
//console.log('classNames', classNames);
var globalNames = data.get( data.find({kind: ['property', 'function'], 'memberof': {'isUndefined': true}}) );
if (globalNames.length) {
nav = nav + 'Global
';
globalNames.forEach(function(g) {
if ( !seen.hasOwnProperty(g.longname) ) nav += '- '+linkto(g.longname, g.name)+'
';
seen[g.longname] = true;
});
nav = nav + '
';
}
for (var longname in helper.longnameToUrl) {
var classes = data.get( data.find({kind: 'class', longname: longname}) );
if (classes.length) generate('Class: '+classes[0].name, classes, helper.longnameToUrl[longname]);
var modules = data.get( data.find({kind: 'module', longname: longname}) );
if (modules.length) generate('Module: '+modules[0].name, modules, helper.longnameToUrl[longname]);
var namespaces = data.get( data.find({kind: 'namespace', longname: longname}) );
if (namespaces.length) generate('Namespace: '+namespaces[0].name, namespaces, 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,
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 hashToLink(doclet, hash) {
if ( !/^(#.+)/.test(hash) ) { return hash; }
var url = helper.createLink(doclet);
url = url.replace(/(#.+|$)/, hash);
return ''+hash+'';
}
})();