📄 jsidoc.js
字号:
/*
* JavaScript Integration Framework
* License LGPL(您可以在任何地方免费使用,但请不要吝啬您对框架本身的改进)
* http://www.xidea.org/project/jsi/
* @author jindw
* @version $Id: jsidoc.js,v 1.9 2008/02/28 14:39:09 jindw Exp $
*/
function onload(){
//
// "您需要把您的外部文件放在一个Web服务器上察看;",
// "如果您使用的是Firefox，您需要将当前站点添加本地文件访问权限"
this.onload = Function.prototype;
var contentWindow = document.getElementById("content").contentWindow;
if(checkInterval){
clearInterval(checkInterval);
}
checkInterval = setInterval(function(){
var url = decodeURIComponent(checkLocation.hash.substr(1));
var contentLocation = contentWindow.location;
if(url && url != contentLocation.href){
contentLocation.replace(url);
}
},100);
//可能是本地全线问题导致，无法加载脚本数据
if(JSIDoc.waitExternalScript){
var message = ["加载本机文档数据失败:","请直接输入文档源代码!!"].join('\n');
//var text = window.showModalDialog("javascript:document.write('<html><body><form><textarea id=text style=\"width:100%;height:120px;\"></textarea><br><button onclick=\"alert(window.returnValue = this.form.text.value);window.close();\">确定</button></form></body></html>')",window, "dialogHeight:225px;dialogwidth:250px;resizable:no")
var text = prompt(message);
if(text){
window.eval(text);
}
}
var packageGroupMap = JSIDoc.packageGroupMap ;
if(packageGroupMap.length == 0){
packageGroupMap.push("托管脚本示例");
packageGroupMap["托管脚本示例"]= ["example","example.internal","org.xidea.jsidoc"]
}
JSIDoc.addPackageMap(packageGroupMap);
setTimeout(function(){
document.getElementById("menu").setAttribute("src","html/controller.html?@menu");
},1)
}
/**
* @public
*/
var JSIDoc = {
/**
* @return packageGroupMap 或者 false(发现有外部脚本文件)
*/
prepare:function(){
window.onload = onload;
var search = window.location.search;
var packageGroupMap = this.packageGroupMap = [];
if(search && search.length>2){
var exp = /([^\?=&]*)=([^=&]*)/g;
var match;
while(match = exp.exec(search)){
var name = decodeURIComponent(match[1]);
var value = decodeURIComponent(match[2]);
if("externalScript" == name){
if(window.clipboardData && value.indexOf("file://") == 0){
var text = window.clipboardData.getData("Text");
document.write("<script>"+text+"<\/script>")
}else{
this.waitExternalScript = true;
document.write("<script src='"+value+"'><\/script>")
}
return value;//???
}else if(name == "group"){
value = JSON.decode(value);
for(name in value){
packageGroupMap.push(name)
packageGroupMap[name] = value[name];
}
}else if(name = name.replace(/^group\.(.*)|.*/,'$1')){//old
packageGroupMap.push(name)
packageGroupMap[name] = value.split(',');
}
}
}
},
/**
* @public
* @param packageGroupMap 包含那些包组
* @param findDependence 是否查找依赖，来收集其他包
*/
addPackageMap : function(packageGroupMap,findDependence){
this.waitExternalScript = false;
this.rootInfo = PackageInfo.requireRoot();
this.packageInfoGroupMap = this.packageInfoGroupMap || [];
this.packageInfoMap = this.packageInfoMap || {};
for(var i = 0;i<packageGroupMap.length;i++){
var key = packageGroupMap[i]
var packages = packageGroupMap[key];
var packages = findPackages(packages,findDependence);
var packageInfos = this.packageInfoGroupMap[key] = [];
this.packageInfoGroupMap.push(key);
for(var j = 0;j<packages.length;j++){
var packageInfo = PackageInfo.require(packages[j])
packageInfos.push(packageInfo);
this.packageInfoMap[packageInfo.name] = packageInfo;
}
}
},
/**
* 折叠packageMenu的函数
*/
collapsePackage:function(name){
var menuDocument = document.getElementById(MENU_FRAME_ID).contentWindow.document;
MenuUI.loadPackage(menuDocument,name);
},
/**
* 渲染文档，输出页面
* @param document 目标文档,menu 或content frame 的文档
*/
render:function(document){
var path = document.location.href;
path = path.replace(/^([^#\?]+[#\?])([^#]+)(#.*)?$/g,"$2");
if(path == "@menu"){
document.write(this.genMenu());
}else{
var url = '#'+encodeURIComponent(document.location.href);
checkLocation.hash = url;
if(path == "@export"){
document.write(this.genExport(document));
}else{
var pos = path.lastIndexOf('/');
if(pos>=0){
var packageName = path.substr(0,pos).replace(/\//g,'.');
var fileName = path.substr(pos+1);
document.write(this.genSource(packageName,fileName));
}else{
var data = path.split(':')
if(data[1]){
document.write(this.genObject(data[0],data[1]));
}else{
this.genPackage(data[0],document);
}
}
}
}
},
/**
* @public
*/
genMenu : function(){
var template = getTemplate("menu.xhtml");
//out.open();
var text = template.render(
{
JSIDoc:JSIDoc,
rootInfo:JSIDoc.rootInfo,
packageInfoGroupMap:JSIDoc.packageInfoGroupMap
});
//alert(text)
return text;
//out.close();
},
/**
* @public
*/
genExport : function(document){
var template = getTemplate("export.xhtml");
var packageNames = [];
for(var name in this.packageInfoMap){
packageNames.push(name);
}
//out.open();
var text = template.render({packageNodes:ExportUI.prepare(document,packageNames)});
//alert(text)
return text;
//out.close();
},
/**
* @public
*/
genPackage : function(packageName,document){
var template = getTemplate("package.xhtml");
var packageInfo = PackageInfo.require(packageName);
function run(){
var infos = packageInfo.getObjectInfos();
var constructors = [];
var functions = [];
var objects = [];
for(var i=0;i<infos.length;i++){
var info = infos[i];
switch(info.type){
case "constructor":
constructors.push(info);
break;
case "function":
functions.push(info);
break;
default:
objects.push(info);
}
}
//out.open();
var data = template.render(
{
constructors:constructors,
functions:functions,
objects:objects,
files:packageInfo.fileInfos,
packageInfo:packageInfo
});
document.open();
document.write(data);
document.close();
//out.close();
}
//TODO: 有待改进
var tasks = packageInfo.getInitializers();
tasks.push(run);
for(var i=0;i<tasks.length;i++){
tasks[i]();
}
//runTasks(tasks);
//return "<html><body><h1>装在中......</h1></body></html>"
},
/**
* @public
*/
genObject : function(packageName,objectName){
var packageInfo = PackageInfo.require(packageName);
var objectInfo = packageInfo.getObjectInfoMap()[objectName];
switch(objectInfo.type){
case "constructor":
var template = getTemplate("constructor.xhtml");
break;
case "function":
var template = getTemplate("function.xhtml");
break;
case "object":
var template = getTemplate("object.xhtml");
break;
default:
var template = getTemplate("native.xhtml");
}
//out.open();
return template.render({
objectInfo:objectInfo
});
},
/**
* @public
*/
genSource : function(packageName,file){
var sourceEntry = SourceEntry.require(file,packageName);
var source = sourceEntry.source.toString();
var ds = sourceEntry.docEntries;
var anchors = [];
//build a list
//var anchorPrefix = getAnchorPrefix(out);
if(ds!=null&&ds[0]!=null){
for(var i = 0;i<ds.length;i++){
var id = ds[i].getId();
if(id && id.length>0){
anchors.push({name:id,position:ds[i].end});
}
}
}
sourceEntry.anchors = anchors;
var lines = sourceEntry.parse();
var template = getTemplate("source.xhtml");
template.beforeOutput = function(){
//JSIDoc.context.evalString = function(){};
}
//out.open();
return template.render(
{
JSIDoc:JSIDoc,
lines:lines
});
},
cacheScript:function(packageMap,groupName){
this.waitExternalScript = false;
groupName = groupName||"未命名分组";
var groupPackages = this.packageGroupMap[groupName];
if(!groupPackages){
groupPackages = this.packageGroupMap[groupName] = [];
}
for(var packageName in packageMap){
groupPackages.push(packageName);
preload(packageName,packageMap[packageName]);
}
},
/**
* 获取文档源代码
* @param packageName
* @param fileName
*/
getSource:function(filePath){
var cache = cachedScripts[filePath];
if(cache && cache.constructor == String){
return cache;
}else{
var result = loadTextByURL($JSI.scriptBase +"?path="+ filePath);
if(result !=null){
preload(filePath.replace(/\/[^\/]+$/,'').replace(/\//g,'.'),
filePath.replace(/.*\//,''),result)
return result;
}else if(cache){
return cache.toString();
}
}
},
/**
*
*/
exportToJSI:function(newJSI){
for(var path in cachedScripts){
var items = path.split('/');
var file = items.pop();
var packageName = items.join('.');
newJSI.preload(packageName,file == "__package__.js"?'':file,cachedScripts[path]);
}
}
}
var documentMap = {};
var scriptBase = this.scriptBase
var documentBase = (scriptBase + 'html/').substr($JSI.scriptBase.length);
var jsiCacher = $JSI.preload;
var cachedScripts = {};
var MENU_FRAME_ID = "menu";
var CONTENT_FRAME_ID = "content";
//var loadingHTML = '<img style="margin:40%" src="../styles/loading2.gif"/>';
var win = window;
var checkLocation = win.location;
var checkInterval;
var templateMap = {
"constructor.xhtml" : new Template(scriptBase+"html/constructor.xhtml"),
"export.xhtml" : new Template(scriptBase+"html/export.xhtml"),
"function.xhtml" : new Template(scriptBase+"html/function.xhtml"),
"menu.xhtml" : new Template(scriptBase+"html/menu.xhtml"),
"native.xhtml" : new Template(scriptBase+"html/native.xhtml"),
"object.xhtml" : new Template(scriptBase+"html/object.xhtml"),
"package.xhtml" : new Template(scriptBase+"html/package.xhtml"),
"part.xhtml" : new Template(scriptBase+"html/part.xhtml"),
"source.xhtml" : new Template(scriptBase+"html/source.xhtml")
};
while(win!=win.top){
try{
win.parent.document.forms.length;
}catch(e){
break;
}
win = win.parent;
}
function preload(pkg,file2dataMap,value){
jsiCacher.apply($JSI,arguments);
var base = pkg.replace(/\.|(.)$/g,'$1/');
if(value == null){//null避免空串影响
for(var n in file2dataMap){
cachedScripts[base + (n || "__package__.js")] = file2dataMap[n];
}
}else{
cachedScripts[base + (file2dataMap || "__package__.js")] = value;
}
};
$JSI.preload = preload;
/**
* @internal
*/
function getTemplate(path){
return templateMap[path];
}
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -