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          * alias {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.src) {
 102                 linkString = thisLink._makeSrcLink(this.src);
 103             }
 104             else if (this.file) {
 105                 linkString = thisLink._makeFileLink(this.file);
 106             }
 107
 108             return linkString;
 109         },
 110
 111
 112
 113
 114
 115
 116
 117         /** Create a link to a snother symbol. */
 118         _makeSymbolLink : function(alias) {
 119
 120             // look for '/' in alias..
 121             if (/\//.test(alias)) {
 122                 var bits = alias.split('/');
 123                 var ret = "";
 124                 for(var i=0; i < bits.length; i++) {
 125                     if (i > 0) {
 126                         ret +="/";
 127                     }
 128                     ret += this._makeSymbolLink(bits[i]);
 129                 }
 130                 return ret;
 131
 132             }
 133
 134
 135
 136             var linkBase = Link.base+  imports.JSDOC.BuildDocs.BuildDocs.symbolsDir;
 137             var linkTo = Link.symbolSet.getSymbol(alias);
 138             var linkPath;
 139             var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
 140
 141             // is it an internal link?
 142             if (alias.charAt(0) == "#") {
 143                 linkPath = alias;
 144                 fullLinkPath = alias;
 145
 146             // if there is no symbol by that name just return the name unaltered
 147             } else if (!linkTo) {
 148
 149                 if (typeof(Link.builtins[alias]) != 'undefined') {
 150                     return "<a href=\""+ Link.builtins[alias]+"\""+target+">"+alias+"</a>";
 151                  }
 152
 153                 return this.text || alias;
 154
 155
 156             // it's a symbol in another file
 157             } else {
 158
 159                 if (!linkTo.is("CONSTRUCTOR") && !linkTo.isNamespace) { // it's a method or property
 160                     linkPath = escape(linkTo.memberOf) || "_global_";
 161                     linkPath += imports.JSDOC.Options.Options.ext + "#" + Link.symbolNameToLinkName(linkTo);
 162                 }
 163                 else {
 164                     linkPath = escape(linkTo.alias);
 165                     linkPath += imports.JSDOC.Options.Options.ext + (this.classLink? "":"#" + Link.hashPrefix + "constructor");
 166                 }
 167                 //linkPath = linkBase + linkPath;
 168                 fullLinkPath = linkBase + linkPath;
 169             }
 170
 171             var linkText = this.text || alias;
 172
 173             var link = {linkPath: linkPath, linkText: linkText, fullLinkPath: fullLinkPath};
 174
 175             //if (typeof JSDOC.PluginManager != "undefined") {
 176             //    JSDOC.PluginManager.run("onSymbolLink", link);
 177             //}
 178
 179             return "<a href=\""+link.fullLinkPath+"\""+target+" roo:cls=\""+link.linkPath+"\">"+link.linkText+"</a>";
 180         },
 181
 182
 183         /** Create a link to a source file. */
 184         _makeSrcLink : function(srcFilePath) {
 185             var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
 186
 187             // transform filepath into a filename
 188             var srcFile = srcFilePath.replace(/\.\.?[\\\/]/g, "").replace(/[:\\\/]/g, "."); // was _
 189             var lsrcFile = srcFilePath.replace(/\.\.?[\\\/]/g, "").replace(/[:\\\/]/g, ".");
 190             var outFilePath = Link.base + '/symbols/' +  srcFile.replace(/.js$/, '') +
 191                 imports.JSDOC.Options.Options.publishExt;
 192
 193             if (!this.text) this.text = srcFilePath; //FilePath.fileName(srcFilePath);
 194             return "<a href=\""+outFilePath+"\""+target+" roo:cls=\"src/"+lsrcFile+"\">"+this.text+"</a>";
 195         },
 196
 197         /** Create a link to a source file. */
 198         _makeFileLink : function(filePath) {
 199             var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
 200
 201             var outFilePath =  Link.base + filePath;
 202
 203             if (!this.text) this.text = filePath;
 204             return "<a href=\""+outFilePath+"\""+target+">"+this.text+"</a>";
 205         }
 206 });
 207
 208
 209
 210
 211 /** prefixed for hashes */
 212 Link.hashPrefix = "";
 213
 214 /** Appended to the front of relative link paths. */
 215 Link.base = "";
 216
 217 Link.symbolNameToLinkName = function(symbol) {
 218         var linker = "";
 219         if (symbol.isStatic) linker = ".";
 220         else if (symbol.isInner) linker = "-";
 221
 222         return Link.hashPrefix+linker+symbol.name;
 223 }
 224
 225
 226 Link.builtins = {
 227     'Object' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object',
 228     'Object...' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object',
 229     'Function' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Function',
 230     'String' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:String',
 231     'Number' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Number',
 232     'Boolean' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean',
 233     'HTMLElement' : 'http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037'
 234 }
 235
 236