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

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