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

   1 //<script type="text/javascript">
   2
   3
   4 XObject         = imports.XObject.XObject;
   5 DocComment      = imports.DocComment.DocComment;
   6 // circular references..
   7 ///Options         = imports.BuildDocs.Options;
   8 //Parser          = imports.Parser.Parser;
   9 //Symbol          = imports.Symbol.Symbol;
  10
  11
  12
  13 SymbolSet = XObject.define(
  14     function() {
  15         this.init();
  16     },
  17     Object,
  18     {
  19
  20         _index : false,
  21
  22
  23         init : function() {
  24             this._index = {};
  25         },
  26
  27         keys : function()
  28         {
  29             var found = [];
  30             for (var p in this._index) {
  31                 found.push(p);
  32             }
  33             return found;
  34         },
  35
  36
  37         hasSymbol : function(alias) {
  38             return typeof(this._index[alias]) != 'undefined';
  39             //return this.keys().indexOf(alias) > -1;
  40         },
  41
  42         addSymbol : function(symbol) {
  43             //print("ADDING SYMBOL:"+symbol.alias.toString());
  44
  45
  46             if (this.hasSymbol(symbol.alias)) {
  47                 imports.BuildDocs.Options.LOG.warn("Overwriting symbol documentation for: "+symbol.alias + ".");
  48             }
  49             this._index[symbol.alias] = symbol;
  50         },
  51
  52         getSymbol : function(alias) {
  53
  54             if (this.hasSymbol(alias)) return this._index[alias];
  55             return false;
  56         },
  57
  58         toArray : function() {
  59             var found = [];
  60             for (var p in this._index) {
  61                 found.push(this._index[p]);
  62             }
  63             return found;
  64         },
  65         /**
  66          * for serializing
  67          */
  68         toJSON : function() {
  69             return {
  70                 '*object' : 'SymbolSet',
  71                 _index : this._index
  72             };
  73
  74         },
  75
  76
  77         deleteSymbol : function(alias) {
  78             if (!this.hasSymbol(alias)) return;
  79             delete this._index[alias];
  80         },
  81
  82         renameSymbol : function(oldName, newName) {
  83             // todo: should check if oldname or newname already exist
  84             if (typeof(this._index[oldName]) == "undefined") {
  85                 throw "Cant rename " + oldName + " to " + newName + " As it doesnt exist";
  86                }
  87             this._index[newName] = this._index[oldName];
  88             this.deleteSymbol(oldName);
  89             this._index[newName].alias = newName;
  90             return newName;
  91         },
  92
  93         relate : function() {
  94             this.resolveBorrows();
  95             this.resolveMemberOf();
  96             this.resolveAugments();
  97         },
  98
  99         resolveBorrows : function() {
 100             for (p in this._index) {
 101                 var symbol = this._index[p];
 102
 103
 104
 105                 if (symbol.is("FILE") || symbol.is("GLOBAL")) continue;
 106
 107                 var borrows = symbol.inherits;
 108                 for (var i = 0; i < borrows.length; i++) {
 109                     var borrowed = this.getSymbol(borrows[i].alias);
 110                     if (!borrowed) {
 111                         imports.BuildDocs.Options.LOG.warn("Can't borrow undocumented "+borrows[i].alias+".");
 112                         continue;
 113                     }
 114
 115                     var borrowAsName = borrows[i].as;
 116                     var borrowAsAlias = borrowAsName;
 117                     if (!borrowAsName) {
 118                         imports.BuildDocs.Options.LOG.warn("Malformed @borrow, 'as' is required.");
 119                         continue;
 120                     }
 121
 122                     if (borrowAsName.length > symbol.alias.length && borrowAsName.indexOf(symbol.alias) == 0) {
 123                         borrowAsName = borrowAsName.replace(borrowed.alias, "")
 124                     }
 125                     else {
 126                         var joiner = "";
 127                         if (borrowAsName.charAt(0) != "#") joiner = ".";
 128                         borrowAsAlias = borrowed.alias + joiner + borrowAsName;
 129                     }
 130
 131                     borrowAsName = borrowAsName.replace(/^[#.]/, "");
 132
 133                     if (this.hasSymbol(borrowAsAlias)) continue;
 134
 135                     var clone = borrowed.clone();
 136                     clone.name = borrowAsName;
 137                     clone.alias = borrowAsAlias;
 138                     this.addSymbol(clone);
 139                 }
 140             }
 141         },
 142
 143         resolveMemberOf : function() {
 144             for (var p in this._index) {
 145                 var symbol = this.getSymbol(p);
 146
 147                 if (symbol.is("FILE") || symbol.is("GLOBAL")) continue;
 148
 149                 // the memberOf value was provided in the @memberOf tag
 150                 else if (symbol.memberOf) {
 151                     var parts = symbol.alias.match(new RegExp("^("+symbol.memberOf+"[.#-])(.+)$"));
 152
 153                     // like foo.bar is a memberOf foo
 154                     if (parts) {
 155                         symbol.memberOf = parts[1];
 156                         symbol.name = parts[2];
 157                     }
 158                     // like bar is a memberOf foo
 159                     else {
 160                         var joiner = symbol.memberOf.charAt(symbol.memberOf.length-1);
 161                         if (!/[.#-]/.test(joiner)) symbol.memberOf += ".";
 162
 163                         this.renameSymbol(p, symbol.memberOf + symbol.name);
 164                     }
 165                 }
 166                 // the memberOf must be calculated
 167                 else {
 168                     var parts = symbol.alias.match(/^(.*[.#-])([^.#-]+)$/);
 169                     if (parts) {
 170                         symbol.memberOf = parts[1];
 171                         symbol.name = parts[2];
 172                     }
 173                 }
 174
 175                 // set isStatic, isInner
 176                 if (symbol.memberOf) {
 177                     switch (symbol.memberOf.charAt(symbol.memberOf.length-1)) {
 178                         case '#' :
 179                             symbol.isStatic = false;
 180                             symbol.isInner = false;
 181                             break;
 182
 183                         case '.' :
 184                             symbol.isStatic = true;
 185                             symbol.isInner = false;
 186                             break;
 187
 188                         case '-' :
 189                             symbol.isStatic = false;
 190                             symbol.isInner = true;
 191                             break;
 192
 193                     }
 194                 }
 195
 196                 // unowned methods and fields belong to the global object
 197                 if (!symbol.is("CONSTRUCTOR") && !symbol.isNamespace && symbol.memberOf == "") {
 198                     symbol.memberOf = "_global_";
 199                 }
 200
 201                 // clean up
 202                 if (symbol.memberOf.match(/[.#-]$/)) {
 203                     symbol.memberOf = symbol.memberOf.substr(0, symbol.memberOf.length-1);
 204                 }
 205                 //print("looking for memberOf: " + symbol.memberOf + " FOR " + symbol.alias);
 206                 // add to parent's methods or properties list
 207                 if (symbol.memberOf) {
 208                     var container = this.getSymbol(symbol.memberOf);
 209                     if (!container) {
 210                         if (SymbolSet.isBuiltin(symbol.memberOf)) {
 211                             container = imports.Parser.Parser.addBuiltin(symbol.memberOf);
 212                         }
 213                         else {
 214                            // print("symbol NOT a BUILT IN - createing a container");
 215                             // Eg. Ext.y.z (missing y)
 216                             // we need to add in the missing symbol...
 217                             container = new imports.Symbol.Symbol(symbol.memberOf, [], "OBJECT", new DocComment(""));
 218                             container.isNamespace = true;
 219                             this.addSymbol( container );
 220                            // print(container.toSource());
 221                             //container = this.getSymbol(symbol.memberOf);
 222                             // fake container ... so dont ad symbols to it..
 223                             continue;
 224                             container = false;
 225                             //LOG.warn("Can't document "+symbol.name +" as a member of undocumented symbol "+symbol.memberOf+".");
 226                             //LOG.warn("We only have the following symbols: \n" +
 227                             //    this.keys.toSource());
 228                         }
 229                     }
 230
 231                     if (container && !container.isNamespace) container.addMember(symbol);
 232                 }
 233             }
 234         },
 235
 236         resolveAugments : function() {
 237             // does this sort out multiple extends???
 238             for (var p in this._index) {
 239                 var symbol = this.getSymbol(p);
 240                 this.buildAugmentsList(symbol); /// build heirachy of inheritance...
 241                 if (symbol.alias == "_global_" || symbol.is("FILE")) continue;
 242
 243                 var augments = symbol.augments;
 244                 for(var ii = 0, il = augments.length; ii < il; ii++) {
 245                     var contributer = this.getSymbol(augments[ii]);
 246
 247
 248
 249                     if (contributer) {
 250                         contributer.childClasses.push(symbol.alias);
 251                         symbol.inheritsFrom.push(contributer.alias);
 252                         //if (!isUnique(symbol.inheritsFrom)) {
 253                         //    imports.BuildDocs.Options.LOG.warn("Can't resolve augments: Circular reference: "+symbol.alias+" inherits from "+contributer.alias+" more than once.");
 254                         //}
 255                         //else {
 256                             var cmethods = contributer.methods;
 257                             var cproperties = contributer.properties;
 258                             var cfgs = contributer.cfgs;
 259                             for (var ci = 0, cl = cmethods.length; ci < cl; ci++) {
 260                                 symbol.inherit(cmethods[ci]);
 261                             }
 262                             for (var ci = 0, cl = cproperties.length; ci < cl; ci++) {
 263                                 symbol.inherit(cproperties[ci]);
 264                             }
 265                             for (var ci in cfgs) {
 266                                 symbol.addConfig(cfgs[ci]);
 267                             }
 268
 269
 270                         //}
 271                     }
 272                     else {
 273
 274                         imports.BuildDocs.Options.LOG.warn("Can't augment contributer: '"+augments[ii]+"', not found. FOR: " + symbol.alias);
 275
 276                         //LOG.warn("We only have the following symbols: \n" +
 277                           //      this.keys().toSource().split(",").join(",    \n"));
 278                        }
 279
 280                 }
 281             }
 282         },
 283
 284         buildAugmentsList : function(symbol)
 285         {
 286             // basic idea is to add all the child extends to the parent.. without looping forever..
 287
 288             if (!symbol.augments.length) {
 289                 return;
 290             }
 291
 292             var _t = this;
 293             print("buildAugmentsList:" + symbol.alias);
 294             var addAugments = function (alist, forceit) { // returns number added..
 295                 if (!alist.length) {
 296                     return 0;
 297                 }
 298                 print("buildAugmentsList:addAugments" + alist.length);
 299                 var rval = 0;
 300                 for(var ii = 0; ii < alist.length; ii++) {
 301                     print("getAlias:" + alist[ii]);
 302                     if (alist[ii] == symbol.alias) {
 303                         continue;
 304                     }
 305                     var contributer = _t.getSymbol(alist[ii]);
 306                     if (!contributer) {
 307                         continue;
 308                     }
 309
 310                     if (!forceit && symbol.augments.indexOf(alist[ii]) > -1) {
 311                         continue;
 312                     }
 313                     if (symbol.augments.indexOf(alist[ii]) < 0) {
 314                         symbol.augments.push(alist[ii]);
 315                     }
 316
 317
 318                     addAugments(contributer.augments,false);
 319
 320                     rval++;
 321                 }
 322                 print("buildAugmentsList: ADDED:" + rval);
 323                 return rval;
 324             }
 325             addAugments(symbol.augments, true);
 326             //while(addAugments(symbol.augments) >  0) { }
 327
 328         }
 329
 330 })
 331
 332 SymbolSet.isBuiltin = function(name) {
 333     return (SymbolSet.isBuiltin.coreObjects.indexOf(name) > -1);
 334 }
 335 SymbolSet.isBuiltin .coreObjects = [
 336     '_global_', 'Array', 'Boolean', 'Date', 'Function',
 337     'Math', 'Number', 'Object', 'RegExp', 'String'
 338 ];