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                 if (!symbol.is) {
 104                     print("PROBLEM : " + p);
 105                     print(JSON.stringify(symbol, null, 4));
 106                    }
 107
 108                 if (symbol.is("FILE") || symbol.is("GLOBAL")) continue;
 109
 110                 var borrows = symbol.inherits;
 111                 for (var i = 0; i < borrows.length; i++) {
 112                     var borrowed = this.getSymbol(borrows[i].alias);
 113                     if (!borrowed) {
 114                         imports.BuildDocs.Options.LOG.warn("Can't borrow undocumented "+borrows[i].alias+".");
 115                         continue;
 116                     }
 117
 118                     var borrowAsName = borrows[i].as;
 119                     var borrowAsAlias = borrowAsName;
 120                     if (!borrowAsName) {
 121                         imports.BuildDocs.Options.LOG.warn("Malformed @borrow, 'as' is required.");
 122                         continue;
 123                     }
 124
 125                     if (borrowAsName.length > symbol.alias.length && borrowAsName.indexOf(symbol.alias) == 0) {
 126                         borrowAsName = borrowAsName.replace(borrowed.alias, "")
 127                     }
 128                     else {
 129                         var joiner = "";
 130                         if (borrowAsName.charAt(0) != "#") joiner = ".";
 131                         borrowAsAlias = borrowed.alias + joiner + borrowAsName;
 132                     }
 133
 134                     borrowAsName = borrowAsName.replace(/^[#.]/, "");
 135
 136                     if (this.hasSymbol(borrowAsAlias)) continue;
 137
 138                     var clone = borrowed.clone();
 139                     clone.name = borrowAsName;
 140                     clone.alias = borrowAsAlias;
 141                     this.addSymbol(clone);
 142                 }
 143             }
 144         },
 145
 146         resolveMemberOf : function() {
 147             for (var p in this._index) {
 148                 var symbol = this.getSymbol(p);
 149
 150                 if (symbol.is("FILE") || symbol.is("GLOBAL")) continue;
 151
 152                 // the memberOf value was provided in the @memberOf tag
 153                 else if (symbol.memberOf) {
 154                     var parts = symbol.alias.match(new RegExp("^("+symbol.memberOf+"[.#-])(.+)$"));
 155
 156                     // like foo.bar is a memberOf foo
 157                     if (parts) {
 158                         symbol.memberOf = parts[1];
 159                         symbol.name = parts[2];
 160                     }
 161                     // like bar is a memberOf foo
 162                     else {
 163                         var joiner = symbol.memberOf.charAt(symbol.memberOf.length-1);
 164                         if (!/[.#-]/.test(joiner)) symbol.memberOf += ".";
 165
 166                         this.renameSymbol(p, symbol.memberOf + symbol.name);
 167                     }
 168                 }
 169                 // the memberOf must be calculated
 170                 else {
 171                     var parts = symbol.alias.match(/^(.*[.#-])([^.#-]+)$/);
 172                     if (parts) {
 173                         symbol.memberOf = parts[1];
 174                         symbol.name = parts[2];
 175                     }
 176                 }
 177
 178                 // set isStatic, isInner
 179                 if (symbol.memberOf) {
 180                     switch (symbol.memberOf.charAt(symbol.memberOf.length-1)) {
 181                         case '#' :
 182                             symbol.isStatic = false;
 183                             symbol.isInner = false;
 184                             break;
 185
 186                         case '.' :
 187                             symbol.isStatic = true;
 188                             symbol.isInner = false;
 189                             break;
 190
 191                         case '-' :
 192                             symbol.isStatic = false;
 193                             symbol.isInner = true;
 194                             break;
 195
 196                     }
 197                 }
 198
 199                 // unowned methods and fields belong to the global object
 200                 if (!symbol.is("CONSTRUCTOR") && !symbol.isNamespace && symbol.memberOf == "") {
 201                     symbol.memberOf = "_global_";
 202                 }
 203
 204                 // clean up
 205                 if (symbol.memberOf.match(/[.#-]$/)) {
 206                     symbol.memberOf = symbol.memberOf.substr(0, symbol.memberOf.length-1);
 207                 }
 208                 //print("looking for memberOf: " + symbol.memberOf + " FOR " + symbol.alias);
 209                 // add to parent's methods or properties list
 210                 if (symbol.memberOf) {
 211                     var container = this.getSymbol(symbol.memberOf);
 212                     if (!container) {
 213                         if (SymbolSet.isBuiltin(symbol.memberOf)) {
 214                             container = imports.Parser.Parser.addBuiltin(symbol.memberOf);
 215                         }
 216                         else {
 217                            // print("symbol NOT a BUILT IN - createing a container");
 218                             // Eg. Ext.y.z (missing y)
 219                             // we need to add in the missing symbol...
 220                             container = new imports.Symbol.Symbol(symbol.memberOf, [], "OBJECT", new DocComment(""));
 221                             container.isNamespace = true;
 222                             this.addSymbol( container );
 223                            // print(container.toSource());
 224                             //container = this.getSymbol(symbol.memberOf);
 225                             // fake container ... so dont ad symbols to it..
 226                             continue;
 227                             container = false;
 228                             //LOG.warn("Can't document "+symbol.name +" as a member of undocumented symbol "+symbol.memberOf+".");
 229                             //LOG.warn("We only have the following symbols: \n" +
 230                             //    this.keys.toSource());
 231                         }
 232                     }
 233
 234                     if (container && !container.isNamespace) container.addMember(symbol);
 235                 }
 236             }
 237         },
 238
 239         resolveAugments : function() {
 240             // does this sort out multiple extends???
 241             for (var p in this._index) {
 242                 var symbol = this.getSymbol(p);
 243                 this.buildAugmentsList(symbol); /// build heirachy of inheritance...
 244                 if (symbol.alias == "_global_" || symbol.is("FILE")) continue;
 245
 246                 var augments = symbol.augments;
 247                 for(var ii = 0, il = augments.length; ii < il; ii++) {
 248                     var contributer = this.getSymbol(augments[ii]);
 249
 250
 251
 252                     if (contributer) {
 253                         contributer.childClasses.push(symbol.alias);
 254                         symbol.inheritsFrom.push(contributer.alias);
 255                         //if (!isUnique(symbol.inheritsFrom)) {
 256                         //    imports.BuildDocs.Options.LOG.warn("Can't resolve augments: Circular reference: "+symbol.alias+" inherits from "+contributer.alias+" more than once.");
 257                         //}
 258                         //else {
 259                             var cmethods = contributer.methods;
 260                             var cproperties = contributer.properties;
 261                             var cfgs = contributer.cfgs;
 262                             for (var ci = 0, cl = cmethods.length; ci < cl; ci++) {
 263                                 symbol.inherit(cmethods[ci]);
 264                             }
 265                             for (var ci = 0, cl = cproperties.length; ci < cl; ci++) {
 266                                 symbol.inherit(cproperties[ci]);
 267                             }
 268                             for (var ci in cfgs) {
 269                                 symbol.addConfig(cfgs[ci]);
 270                             }
 271
 272
 273                         //}
 274                     }
 275                     else {
 276
 277                         imports.BuildDocs.Options.LOG.warn("Can't augment contributer: '"+augments[ii]+"', not found. FOR: " + symbol.alias);
 278
 279                         //LOG.warn("We only have the following symbols: \n" +
 280                           //      this.keys().toSource().split(",").join(",    \n"));
 281                        }
 282
 283                 }
 284             }
 285         },
 286
 287         buildAugmentsList : function(symbol)
 288         {
 289             // basic idea is to add all the child extends to the parent.. without looping forever..
 290
 291             if (!symbol.augments.length) {
 292                 return;
 293             }
 294
 295             var _t = this;
 296             print("buildAugmentsList:" + symbol.alias);
 297             var addAugments = function (alist, forceit) { // returns number added..
 298                 if (!alist.length) {
 299                     return 0;
 300                 }
 301                 print("buildAugmentsList:addAugments" + alist.length);
 302                 var rval = 0;
 303                 for(var ii = 0; ii < alist.length; ii++) {
 304                     print("getAlias:" + alist[ii]);
 305                     if (alist[ii] == symbol.alias) {
 306                         continue;
 307                     }
 308                     var contributer = _t.getSymbol(alist[ii]);
 309                     if (!contributer) {
 310                         continue;
 311                     }
 312
 313                     if (!forceit && symbol.augments.indexOf(alist[ii]) > -1) {
 314                         continue;
 315                     }
 316                     if (symbol.augments.indexOf(alist[ii]) < 0) {
 317                         symbol.augments.push(alist[ii]);
 318                     }
 319
 320
 321                     addAugments(contributer.augments,false);
 322
 323                     rval++;
 324                 }
 325                 print("buildAugmentsList: ADDED:" + rval);
 326                 return rval;
 327             }
 328             addAugments(symbol.augments, true);
 329             //while(addAugments(symbol.augments) >  0) { }
 330
 331         }
 332
 333 })
 334
 335 SymbolSet.isBuiltin = function(name) {
 336     return (SymbolSet.isBuiltin.coreObjects.indexOf(name) > -1);
 337 }
 338 SymbolSet.isBuiltin .coreObjects = [
 339     '_global_', 'Array', 'Boolean', 'Date', 'Function',
 340     'Math', 'Number', 'Object', 'RegExp', 'String'
 341 ];