git.roojs.org Git - gnome.introspection-doc-generator/blob - JsTemplate/Link.js

   1 //<script type="text/javascript">
   2
   3 XObject  = imports.XObject.XObject;
   4
   5 /**
   6  * Generic Template Link handler..
   7  *
   8  *
   9  *
  10  */
  11
  12 /** Handle the creation of HTML links to documented symbols.
  13         @constructor
  14 */
  15 Link = XObject.define(
  16     /*
  17     * constructor
  18     */
  19     function (opts) {
  20         XObject.extend(this,opts);
  21
  22     },
  23     Object,
  24     {
  25
  26          /**
  27          * url {String} url for link..
  28          */
  29         url: "",
  30         /**
  31          * text {String} text to show on link.
  32          */
  33
  34         text : "",
  35
  36         /**
  37          * alias {String} not sure?
  38          */
  39         alias : "",
  40         /**
  41          * src {String} not sure?
  42          */
  43         src : "",
  44         file : "",
  45
  46         innerName : "",
  47         classLink : false,
  48         targetName : "",
  49
  50
  51
  52         target : function(targetName) {
  53             if (typeof(targetName) != 'undefined') this.targetName = targetName;
  54             return this;
  55         },
  56         inner : function(inner) {
  57             if (typeof(inner) != 'undefined') this.innerName = inner;
  58             return this;
  59         },
  60         withText : function(text) {
  61             if (typeof(text) != 'undefined') this.text = text;
  62             return this;
  63         },
  64         toSrc : function(filename) {
  65             if (typeof(filename) != 'undefined') this.src = filename;
  66
  67             return this;
  68         },
  69         toSymbol : function(alias) {
  70             if (typeof(alias) != 'undefined') {
  71                 this.alias = new String(alias);
  72             }
  73             return this;
  74         },
  75         toClass : function(alias) {
  76             this.classLink = true;
  77             return this.toSymbol(alias);
  78         },
  79         toFile : function(file) {
  80             if (typeof(file) != 'undefined') this.file = file;
  81             return this;
  82         },
  83
  84         toString : function() {
  85             var linkString;
  86             var thisLink = this;
  87
  88             if (this.alias) {
  89                 linkString = this.alias.replace(/(^|[^a-z$0-9_#.:-])([|a-z$0-9_#.:-]+)($|[^a-z$0-9_#.:-])/i,
  90                     function(match, prematch, symbolName, postmatch) {
  91                         var symbolNames = symbolName.split("|");
  92                         var links = [];
  93                         for (var i = 0, l = symbolNames.length; i < l; i++) {
  94                             thisLink.alias = symbolNames[i];
  95                             links.push(thisLink._makeSymbolLink(symbolNames[i]));
  96                         }
  97                         return prematch+links.join("|")+postmatch;
  98                     }
  99                 );
 100             }
 101             else if (this.url) {
 102                 linkString = thisLink._makeLink(this.url);
 103             }
 104             else if (this.src) {
 105                 linkString = thisLink._makeSrcLink(this.src);
 106             }
 107             else if (this.file) {
 108                 linkString = thisLink._makeFileLink(this.file);
 109             }
 110
 111             return linkString;
 112         },
 113
 114
 115
 116
 117
 118
 119
 120         /** Create a link to a snother symbol. */
 121         _makeSymbolLink : function(alias) {
 122
 123             // look for '/' in alias..
 124             if (/\//.test(alias)) {
 125                 var bits = alias.split('/');
 126                 var ret = "";
 127                 for(var i=0; i < bits.length; i++) {
 128                     if (i > 0) {
 129                         ret +="/";
 130                     }
 131                     ret += this._makeSymbolLink(bits[i]);
 132                 }
 133                 return ret;
 134
 135             }
 136
 137
 138
 139             var linkBase = Link.base+  imports.JSDOC.BuildDocs.BuildDocs.symbolsDir;
 140             var linkTo = Link.symbolSet.getSymbol(alias);
 141             var linkPath;
 142             var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
 143
 144             // is it an internal link?
 145             if (alias.charAt(0) == "#") {
 146                 linkPath = alias;
 147                 fullLinkPath = alias;
 148
 149             // if there is no symbol by that name just return the name unaltered
 150             } else if (!linkTo) {
 151
 152                 if (typeof(Link.builtins[alias]) != 'undefined') {
 153                     return "<a href=\""+ Link.builtins[alias]+"\""+target+">"+alias+"</a>";
 154                  }
 155
 156                 return this.text || alias;
 157
 158
 159             // it's a symbol in another file
 160             } else {
 161
 162                 if (!linkTo.is("CONSTRUCTOR") && !linkTo.isNamespace) { // it's a method or property
 163                     linkPath = escape(linkTo.memberOf) || "_global_";
 164                     linkPath += imports.JSDOC.Options.Options.ext + "#" + Link.symbolNameToLinkName(linkTo);
 165                 }
 166                 else {
 167                     linkPath = escape(linkTo.alias);
 168                     linkPath += imports.JSDOC.Options.Options.ext + (this.classLink? "":"#" + Link.hashPrefix + "constructor");
 169                 }
 170                 //linkPath = linkBase + linkPath;
 171                 fullLinkPath = linkBase + linkPath;
 172             }
 173
 174             var linkText = this.text || alias;
 175
 176             var link = {linkPath: linkPath, linkText: linkText, fullLinkPath: fullLinkPath};
 177
 178             //if (typeof JSDOC.PluginManager != "undefined") {
 179             //    JSDOC.PluginManager.run("onSymbolLink", link);
 180             //}
 181
 182             return "<a href=\""+link.fullLinkPath+"\""+target+" roo:cls=\""+link.linkPath+"\">"+link.linkText+"</a>";
 183         },
 184
 185
 186         /** Create a link to a source file. */
 187         _makeSrcLink : function(srcFilePath) {
 188             var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
 189
 190             // transform filepath into a filename
 191             var srcFile = srcFilePath.replace(/\.\.?[\\\/]/g, "").replace(/[:\\\/]/g, "."); // was _
 192             var lsrcFile = srcFilePath.replace(/\.\.?[\\\/]/g, "").replace(/[:\\\/]/g, ".");
 193             var outFilePath = Link.base + '/symbols/' +  srcFile.replace(/.js$/, '') +
 194                 imports.JSDOC.Options.Options.publishExt;
 195
 196             if (!this.text) this.text = srcFilePath; //FilePath.fileName(srcFilePath);
 197             return "<a href=\""+outFilePath+"\""+target+" roo:cls=\"src/"+lsrcFile+"\">"+this.text+"</a>";
 198         },
 199
 200         /** Create a link to a source file. */
 201         _makeFileLink : function(filePath) {
 202             var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
 203
 204             var outFilePath =  Link.base + filePath;
 205
 206             if (!this.text) this.text = filePath;
 207             return "<a href=\""+outFilePath+"\""+target+">"+this.text+"</a>";
 208         }
 209 });
 210
 211
 212
 213
 214 /** prefixed for hashes */
 215 Link.hashPrefix = "";
 216
 217 /** Appended to the front of relative link paths. */
 218 Link.base = "";
 219
 220 Link.symbolNameToLinkName = function(symbol) {
 221         var linker = "";
 222         if (symbol.isStatic) linker = ".";
 223         else if (symbol.isInner) linker = "-";
 224
 225         return Link.hashPrefix+linker+symbol.name;
 226 }
 227
 228
 229 Link.builtins = {
 230     'Object' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object',
 231     'Object...' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object',
 232     'Function' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Function',
 233     'String' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:String',
 234     'Number' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Number',
 235     'Boolean' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean',
 236     'HTMLElement' : 'http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037'
 237 }
 238
 239