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

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