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