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

   1 //<script type="text/javascript">
   2
   3 console = imports['console.js'].console;
   4
   5 imports['Object.js'].load(Object);
   6
   7 Template = imports['JSDOC/Template.js'];
   8
   9 /** Handle the creation of HTML links to documented symbols.
  10         @constructor
  11     *
  12     * // JSDOC.Template.Link.base = "";
  13     * JSDOC.Template.Link.symbolsDir
  14     *
  15 */
  16
  17
  18 Link = function() {
  19         this.alias = "";
  20         this.src = "";
  21         this.file = "";
  22         this.text = "";
  23         this.innerName = "";
  24         this.classLink = false;
  25         this.targetName = "";
  26
  27     Link.symbolsDir = Link.symbolsDir || '';
  28     Link.base = Link.base || '';
  29     Link.ext= Link.ext || '';
  30     Link.srcDir= Link.srcDir || '';
  31
  32
  33 }
  34
  35
  36
  37 Object.extend(Link.prototype, {
  38
  39     alias : "",
  40         src : "",
  41         file : "",
  42         text : "",
  43         innerName : "",
  44         classLink : false,
  45         targetName : "",
  46
  47
  48
  49     toString : function() {
  50                 var linkString;
  51                 var thisLink = this;
  52
  53         if (this.none) {
  54             return 'none';
  55         }
  56                 if (this.alias) {
  57
  58             if (typeof(this.builtins[this.alias]) != 'undefined') {
  59                 this.text = this.alias;
  60                 return thisLink._makeExternLink(this.builtins[this.alias]);
  61             }
  62
  63
  64             return thisLink._makeSymbolLink(this.alias);
  65
  66             /*
  67
  68                         linkString = this.alias.replace(/(^|[^a-z$0-9_#.:-])([|a-z$0-9_#.:-]+)($|[^a-z$0-9_#.:-])/i,
  69                                 function(match, prematch, symbolName, postmatch) {
  70                                         var symbolNames = symbolName.split("|");
  71                                         var links = [];
  72                                         for (var i = 0, l = symbolNames.length; i < l; i++) {
  73                                                 thisLink.alias = symbolNames[i];
  74                                                 links.push(thisLink._makeSymbolLink(symbolNames[i]));
  75                                         }
  76                                         return prematch+links.join("|")+postmatch;
  77                                 }
  78                         );
  79             */
  80                 }
  81                 else if (this.extern) {
  82                         linkString = thisLink._makeExternLink(this.extern);
  83                 }
  84                 else if (this.src) {
  85                         linkString = thisLink._makeSrcLink(this.src);
  86                 }
  87                 else if (this.file) {
  88                         linkString = thisLink._makeFileLink(this.file);
  89                 }
  90
  91                 return linkString;
  92         },
  93
  94     builtins : {
  95         'Object' : 'https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Object',
  96         //'Object...' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object',
  97         'Array' : 'https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array',
  98         'Function' : 'https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Function',
  99         'String' : 'https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/String',
 100         'Number' : 'https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Number',
 101         'Boolean' : 'https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Boolean',
 102         'HTMLElement' : 'http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037'
 103     },
 104
 105
 106     toGnome: function(alias)
 107     {
 108         this.file = "#";
 109         var pr = alias.split('.');
 110         var aa = alias;
 111         var site = 'library.gnome.org';
 112         var extra = '';
 113         switch(pr[0]) {
 114             case 'GIRepository':
 115                this.extern = 'http://live.gnome.org/GObjectIntrospection';
 116                aa = pr[0];
 117                break;
 118             case 'Gio':
 119             case 'GLib':
 120             case 'GObject':
 121                 aa = pr.length > 1 ? 'G' + pr[1] : pr[0];
 122                 break;
 123             case 'GdkPixbuf':
 124                 aa = pr.length > 1 ? 'Gdk' + pr[1] : pr[0];
 125                 break;
 126             case 'GtkSource':
 127                 aa = pr.length > 1 ? pr[0] + pr[1] : 'GtkSourceView';
 128                 break;
 129
 130             case 'Gst':
 131                 aa = pr.length > 1 ? pr[0] + pr[1] : 'GStreamer';
 132                 break;
 133
 134             case 'Pango':
 135                 extra = ' GTK-Doc';
 136                 break;
 137             case 'GstController':
 138             case 'GstApp':
 139             case 'GstAudio':
 140             case 'GstBase':
 141             case 'GstCheck':
 142             case 'GstFft':
 143             case 'GstInterfaces':
 144             case 'GstNet':
 145             case 'GstNetbuffer':
 146             case 'GstPbutils':
 147             case 'GstRiff':
 148             case 'GstRtp':
 149             case 'GstRtsp':
 150             case 'GstSdp':
 151             case 'GstTag':
 152             case 'GstVideo':
 153
 154                 aa = pr.length > 1 ? 'Gst' + pr[1] : pr[0];
 155                 break;
 156
 157             case 'Epiphany':
 158                 aa = pr.length > 1 ?  pr[1] : pr[0];
 159                 break;
 160             case 'WebKit':
 161                 site = 'webkitgtk.org';
 162
 163             default:
 164
 165                 aa = alias.replace('.', '');
 166
 167                 break;
 168
 169         }
 170         if (!this.extern) {
 171             this.extern = 'http://www.google.com/search?hl=en&amp;' +
 172                     'q=site%3A' + site  + '+' + aa + extra +
 173                     '&amp;btnI=I%27m+Feeling+Lucky&amp;meta=&amp;aq=f&amp;oq=';
 174         }
 175
 176         this.text =  aa;
 177         return this;
 178     },
 179
 180         target : function(targetName) {
 181                 if (typeof(targetName) != 'undefined') this.targetName = targetName;
 182                 return this;
 183         },
 184         inner : function(inner) {
 185                 if (typeof(inner) != 'undefined') this.innerName = inner;
 186                 return this;
 187         },
 188         withText:  function(text) {
 189                 if (typeof(text) != 'undefined') this.text = text;
 190                 return this;
 191         },
 192         toSrc :function(filename) {
 193                 if (typeof(filename) != 'undefined') this.src = filename;
 194                 return this;
 195         },
 196
 197     toSymbolLong : function(alias)
 198     {
 199         this.show_full = true;
 200         return this.toSymbol(alias)
 201     },
 202         toSymbol : function(alias) {
 203
 204
 205         switch(alias) {
 206             case 'boolean' : this.alias = 'Boolean'; return this;
 207             case 'int' : this.alias = 'Number'; return this;
 208             case 'uint' : this.alias = 'Number'; return this;
 209
 210             case 'long' : this.alias = 'Number'; return this;
 211             case 'ulong' : this.alias = 'Number'; return this;
 212
 213
 214             case 'uint8' : this.alias = 'Number'; return this;
 215             case 'int8' : this.alias = 'Number'; return this;
 216
 217             case 'uint16' : this.alias = 'Number'; return this;
 218             case 'uint16' : this.alias = 'Number'; return this;
 219
 220             case 'int32' : this.alias = 'Number'; return this;
 221             case 'uint32' : this.alias = 'Number'; return this;
 222
 223             case 'uint64' : this.alias = 'Number'; return this;
 224             case 'int64' : this.alias = 'Number'; return this;
 225
 226
 227             case 'GType' : this.alias = 'Number'; return this;
 228             case 'size' : this.alias = 'Number'; return this;
 229             case 'ssize' : this.alias = 'Number'; return this;
 230
 231             case 'float' : this.alias = 'Number'; return this;
 232             case 'double' : this.alias = 'Number'; return this;
 233             case 'time_t' : this.alias = 'Number'; return this;
 234             // fixme - should find out more details..
 235             case 'array' : this.alias = 'Array'; return this;
 236             case 'gslist' : this.alias = 'Array'; return this;
 237             case 'glist' : this.alias = 'Array'; return this; // homefully.
 238             case 'ghash' : this.alias = 'Object'; return this; // homefully.
 239
 240
 241             case 'error' : this.alias = 'Object'; return this; // homefully.
 242             case 'filename' : this.alias = 'String'; return this; // hopefully..
 243             case 'utf8' : this.alias = 'String'; return this;
 244
 245             case 'void' : this.none = true; return this;
 246
 247
 248         }
 249
 250
 251                 if (typeof(alias) != 'undefined') {
 252             this.alias = new String(alias);
 253         }
 254                 return this;
 255         },
 256         toClass : function(alias) {
 257                 this.classLink = true;
 258                 return this.toSymbol(alias);
 259         },
 260         toFile : function(file) {
 261                 if (typeof(file) != 'undefined') this.file = file;
 262                 return this;
 263         },
 264
 265
 266
 267
 268     /** prefixed for hashes */
 269
 270
 271     /** Appended to the front of relative link paths. */
 272
 273
 274     symbolNameToLinkName : function(symbol) {
 275         var linker = "";
 276         if (symbol.isStatic) linker = ".";
 277         else if (symbol.isInner) linker = "-";
 278
 279         return linker+symbol.name;
 280     },
 281
 282
 283
 284
 285     /** Create a link to a snother symbol. */
 286     _makeSymbolLink :  function(alias)
 287     {
 288         var target = '';
 289         var txt = this.show_full ? alias : alias.split('.').pop();
 290          return "<a href=\"./"+alias+".html\""+target+">"+txt+"</a>";
 291
 292         /*
 293         // look for '/' in alias..
 294         if (/\//.test(alias)) {
 295             var bits = alias.split('/');
 296             var ret = "";
 297             for(var i=0; i < bits.length; i++) {
 298                 if (i > 0) {
 299                     ret +="/";
 300                 }
 301                 ret += this._makeSymbolLink(bits[i]);
 302             }
 303             return ret;
 304
 305         }
 306
 307
 308         */
 309
 310         var linkBase = Link.base + Link.symbolsDir;
 311         //var linkTo = Link.symbolSet.getSymbol(alias);
 312         linkTo = "FIXME";
 313         var linkPath;
 314         var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
 315
 316         // is it an internal link?
 317         if (alias.charAt(0) == "#") {
 318             linkPath = alias;
 319             fullLinkPath = alias;
 320
 321         // if there is no symbol by that name just return the name unaltered
 322         } else if (!linkTo) {
 323
 324             if (typeof(this.builtins[alias]) != 'undefined') {
 325                 return "<a href=\""+ this.builtins[alias]+"\""+target+">"+alias+"</a>";
 326              }
 327
 328             return this.text || alias;
 329
 330
 331         // it's a symbol in another file
 332         } else {
 333
 334             if (!linkTo.isConstructor && !linkTo.isNamespace) { // it's a method or property
 335                 linkPath = escape(linkTo.memberOf) || "_global_";
 336                 linkPath += Link.ext + "#" + this.symbolNameToLinkName(linkTo);
 337             }
 338             else {
 339                 linkPath = escape(linkTo.alias);
 340                 linkPath += Link.ext + (this.classLink? "":"#" +  "constructor");
 341             }
 342             //linkPath = linkBase + linkPath;
 343             fullLinkPath = linkBase + linkPath;
 344         }
 345
 346         var linkText = this.text || alias;
 347
 348         var link = {linkPath: linkPath, linkText: linkText, fullLinkPath: fullLinkPath};
 349
 350         //if (typeof PluginManager != "undefined") {
 351         //    JSDOC.PluginManager.run("onSymbolLink", link);
 352         //}
 353
 354         return "<a href=\""+link.fullLinkPath+"\""+target+">"+link.linkText+"</a>";
 355     },
 356
 357
 358     /** Create a link to a source file. */
 359      _makeSrcLink : function(srcFilePath) {
 360         var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
 361
 362         // transform filepath into a filename
 363         var srcFile = srcFilePath.replace(/\.\.?[\\\/]/g, "").replace(/[:\\\/]/g, "."); // was _
 364         var lsrcFile = srcFilePath.replace(/\.\.?[\\\/]/g, "").replace(/[:\\\/]/g, ".");
 365         var outFilePath = Link.base + Link.srcDir + srcFile.replace(/.js$/, '') + Link.ext;
 366
 367         if (!this.text) this.text = FilePath.fileName(srcFilePath);
 368         return "<a href=\""+outFilePath+"\""+target+">"+this.text+"</a>";
 369     },
 370
 371     /** Create a link to a source file. */
 372      _makeFileLink : function(filePath) {
 373         var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
 374
 375         var outFilePath =  Link.base + filePath;
 376
 377         if (!this.text) this.text = filePath;
 378         return "<a href=\""+outFilePath+"\""+target+">"+this.text+"</a>";
 379     },
 380
 381     /** Create a link to a source file. */
 382      _makeExternLink : function(filePath) {
 383         var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
 384
 385         if (!this.text) this.text = filePath;
 386         return "<a href=\""+filePath+"\""+target+">"+this.text+"</a>";
 387     }
 388
 389 });