git.roojs.org Git - app.jsdoc/blob - JSDOC/ScopeNamer.js

   1 XObject = imports.XObject.XObject;
   2
   3
   4 console     = imports.console.console;
   5
   6 Symbol = imports.Symbol.Symbol;
   7
   8 /**
   9  * @class ScopeNamer
  10  * @extends Collapse
  11  * @scope JSDOC
  12  * The point of this class is to iterate through the Collapsed tree
  13  * and add the property 'scopedName' to the tokens.
  14  *
  15  *
  16  *
  17
  18   After spending some time looking at this, a few conclusions...
  19
  20   - this will have to be the base class of specific implementations.
  21   - each implementation will have to decide how to declare a new scope
  22
  23   scopes are normally changed when these things occur:
  24
  25
  26   globalScope(stmts) => statementsScope($global$, stmts)
  27
  28
  29   'object'
  30   objectScope(sname, props  )
  31   a = { .... } << scope is a  $this$={a}
  32
  33      // property scopes???
  34     foo: function() {} $this$={object scope}
  35     foo : ( xxx ? function()  { } ? function() { ...} << conditional properties types
  36     foo : (function() { return x })() << a property or function??? << depends on notes
  37     foo : [ ] << a property.. do not drill down?
  38     foo : xxxxx << a property..
  39
  40
  41   'function'
  42   functionScope(sname,  stmts  )
  43   function a() { .... } << scope is a  $this$={a}
  44   a = function() { } << scope might be a  $this$={a}
  45
  46   // registers 'this.*'
  47
  48
  49
  50   'call' scopes
  51   XX.yy(a,b, { .... }) << scope might be a or b..  $this$={a}
  52   aa = XX.yy(a,b, { .... }) << scope might aa   $this$={a}
  53
  54   callscope(name, pref, args)
  55
  56   can do losts ofthings
  57
  58    ?? classify me...
  59       foo = new (function() { }
  60      (function() { }
  61     RETURN function(...) {
  62
  63
  64
  65
  66
  67
  68
  69  *
  70  *
  71  * usage  :
  72  * sn = new ScopeName({
  73     tokens : ... result from tokenizer,
  74
  75  })
  76    sn.buildSymbols();
  77  *
  78  * @param {Array} tokens array of tokens (from collapse)
  79  * @param {String} srcFile the original file
  80  * @param {Array} args Local variables which do not need to be added to scope.
  81  */
  82
  83 ScopeNamer = XObject.define(
  84     function (cfg)
  85     {
  86
  87         ScopeNamer.superclass.constructor.call(this, cfg);
  88         this.args = this.args ? this.args.slice(0)  : [];
  89         Symbol.srcFile = this.filename;
  90         this.createJSDOC = true;
  91         this.global = '_global_';
  92        // console.dump(ar);
  93
  94     },
  95     imports.JSDOC.Collapse.Collapse,
  96     {
  97
  98         global : false,
  99         /**
 100          * Call debugging
 101          * add/remove ';' after return to configure at present..
 102          * @param {String} str String to output
 103          */
 104         debugCall : function(str)  {
 105
 106
 107             //if (this.filename.match(/Scope\.js/)) return print(str);
 108             return;
 109         },
 110
 111         collapseTop : true,
 112
 113         buildSymbols : function()
 114         {
 115             if (!this.statements) {
 116                 this.statements = this.collapse(this.tokens);
 117                 //print(JSON.stringify(this.s, null,4));
 118             }
 119
 120             //this.globalScope(this.statements);
 121             this.debugCall("build Symbols");
 122             //print (this.statements);
 123             //print (JSON.stringify(this.statements, null,2));
 124
 125             this.walkStatements(this.global, this.statements)
 126
 127
 128
 129         },
 130
 131
 132         ignore : false,
 133
 134
 135
 136
 137         walkStatements: function(scope, statements)
 138         {
 139             this.debugCall("walkStatements :" + scope ) ;
 140             var _this = this;
 141             var res = false;
 142             var isGlobal = scope == this.global;
 143
 144             statements.some(function(st ) {
 145                 // handle change of scope..
 146                 if (isGlobal &&
 147                         st[0].jsdoc &&
 148                         st[0].jsdoc.getTag('scope').length
 149                    ) {
 150                     //print(st[0].jsdoc.getTag('scope'));
 151                     scope = st[0].jsdoc.getTag('scope');
 152                     // might be an array..
 153                     if (typeof(scope) != 'String') {
 154                         scope = scope[0].desc;
 155
 156                     }
 157                     _this.global = scope;
 158                 }
 159
 160
 161                 res = _this.walkStatement(scope, st);
 162                 if (res === true) {
 163                     return true;
 164                 }
 165                 return false;
 166             });
 167         },
 168
 169         walkStatement: function(scope, stmt)
 170         {
 171             this.tokens = stmt;
 172             this.rewind();
 173             this.debugCall("walkStatement :" + this.global +'/' +scope + '@' + this.tokens[0].line );
 174
 175             var name;
 176             var sn;
 177
 178             var isGlobal = scope == this.global;
 179
 180
 181
 182             //if (this.filename.match(/pack\.js/) && isGlobal) {
 183             //    print(JSON.stringify(stmt , null,4));
 184             //}
 185             // @ignore stops the parser..
 186             if (isGlobal &&
 187                     stmt[0].jsdoc &&
 188                     stmt[0].jsdoc.getTag('ignore').length
 189                ) {
 190                 this.debugCall("walkStatement : ignore found - " + scope + '@' + this.tokens[0].line );
 191                 print("GOT ignore?");
 192                 return true;
 193             }
 194
 195
 196             while (null != (token = this.next())) {
 197
 198                 //'function'
 199                 //walkFunction(scope, name , args,  stmts  )
 200                 //
 201                 if (token.name == "FUNCTION") {
 202                     // function a() { .... } << scope is a  $this$={a}
 203                     if (this.lookTok(1).is('NAME')) {
 204                         name = isGlobal ? this.lookTok(1).data : '';
 205
 206                         this.walkFunctionDef(scope, name, this.lookTok(2).args, this.lookTok(3).items, token);
 207                         continue;
 208                     }
 209                      //a = function() { } << scope might be a  $this$={a}
 210                     if (this.lookTok(-1).data == '=' &&
 211                         this.lookTok(-2).is('NAME')
 212                     ) {
 213                         name = this.lookTok(-2).data;
 214                         this.walkFunctionDef(scope, name, this.lookTok(1).args, this.lookTok(2).items, this.lookTok(-2));
 215                         continue;
 216                     }
 217
 218
 219                     print("+++ FUNCTION unusual context" + token.file + ':' + token.line);
 220                     continue;
 221
 222                 }
 223
 224                 // control flow ...
 225
 226
 227
 228                 // 'call' scopes
 229                 // XX.yy(a,b, { .... }) << scope might be a or b..  $this$={a}
 230                 // aa = XX.yy(a,b, { .... }) << scope might aa   $this$={a}
 231
 232                 if (token.is('NAME') && this.lookTok(1).data =='(') {
 233                     var assign = false;
 234                     var jsdoc = token.jsdoc;
 235                     if ((this.lookTok(-1).data == '=') && this.lookTok(-2).is('NAME')) {
 236                         assign = this.lookTok(-2).data
 237                         jsdoc = jsdoc || this.lookTok(-2).jsdoc;
 238                     }
 239                     this.walkCall(scope, assign, token.data, this.lookTok(1).items, jsdoc);
 240                     continue;
 241                 }
 242
 243                 //  'object'
 244                 //   a = { .... } << scope is a  $this$={a}
 245                 if (token.data == '{' && this.lookTok(-1).data == '=' && this.lookTok(-2).is('NAME')) {
 246
 247                     // could be var x = ..
 248                     var jd = this.lookTok(-2).jsdoc ? this.lookTok(-2) : this.lookTok(-3);
 249
 250                     var isVar = this.lookTok(-3).name == 'VAR';
 251
 252                     // only register names of objects if
 253                     var name = this.lookTok(-2).data;
 254
 255                     if (isGlobal) {
 256                         print ("GLOBAL: ")
 257
 258
 259
 260                     } else {
 261                         // not global.
 262                         if (isVar) {
 263                             name = false;
 264                         }
 265                         if (name && !name.match(/^this\./)) {
 266                             name = false;
 267                         }
 268                         if (name && name.match(/^this\./) ) {
 269                             // see if scope ends in prototype..
 270                             print("SCOPE:" + JSON.stringify(scope));
 271                             if (
 272                                 (scope.split('.').pop() == 'prototype') &&
 273                                 (name.split('.').length == 2)
 274                             ){
 275                                 name = name.split('.').pop();
 276                             } else {
 277                                 name = false;
 278                             }
 279
 280                         }
 281
 282                     }
 283
 284
 285                     //print(JSON.stringify(token,null,4));
 286                     this.walkObject(scope, name, token.props, jd);
 287                     continue;
 288                 }
 289
 290                 // this.xxxx = (with jsdoc...)
 291
 292
 293
 294
 295                 // standard flow....
 296                 if (token.data == '{') {
 297                     sn = new ScopeNamer(this);
 298                     //print("GOT { - walkings statuements;}");
 299                     if (!token.items) {
 300                         continue; // object..!?!?!? = ignore ???
 301                         print(JSON.stringify(token,null,4));
 302                     }
 303                     sn.walkStatements(scope, token.items);
 304                     continue;
 305                 }
 306             }
 307         },
 308
 309         walkFunctionDef : function (inscope, name, args, stmts, jsdocTok)
 310         {
 311             this.debugCall("wallkFuncDef: " + inscope + '#' + name + '@' + this.look(0).line );
 312             var scope = name.length ? (inscope + '.' + name) : inscope;
 313             if (name.length) {
 314                 var symbol = new Symbol( scope , args || [] , "FUNCTION" ,  jsdocTok.jsdoc);
 315                 symbol._token = jsdocTok;
 316                 this.addSymbol(symbol, jsdocTok.jsdoc);
 317             }
 318             var sn = new ScopeNamer(this);
 319             sn.walkStatements(scope, stmts);
 320
 321         },
 322
 323
 324
 325         walkCall : function (inscope, assign, callname, items, jsdocTok)
 326         {
 327             this.debugCall("walkCall : " + inscope  +':' + assign + '@' + this.look(0).line + ' ' + callname );
 328             var scope = inscope + ( assign ? ('.' + assign) : '' );
 329             //scope = scope.replace(/\^_global\$\./, '');
 330
 331
 332
 333
 334             // add the handers for differnt methods in here....
 335             switch (callname) {
 336
 337                 // somecall(BASE, { .. object ..})
 338                 // or... x = somecall(BASE, { ... object..})
 339                 case 'XObject.extend':
 340                 case 'Roo.apply':
 341                     //print(JSON.stringify(items,null,4));
 342                     // SHOULD WE ADD SCOPE HERE???
 343                     var topscope = scope.split('.').pop();
 344
 345                     scope = (topscope == items[0][0].data) ?
 346                         items[0][0].data :
 347                         scope + '.' + items[0][0].data;
 348                     // 2nd arg is a object def
 349                     if (items[1][0].data != '{') {
 350                         return;
 351                     }
 352
 353                     if (assign != false   && !scope.match(/\.prototype$/)) {
 354                         var symbol = new Symbol( scope , false , "OBJECT" ,  jsdocTok);
 355                         symbol._token = jsdocTok;
 356                         this.addSymbol(symbol, jsdocTok.jsdoc);
 357
 358                     }
 359
 360
 361                     var sn = new ScopeNamer(this);
 362
 363                     //print(JSON.stringify(items,null,4));
 364                     sn.walkObject(scope , false, items[1][0].props, jsdocTok );
 365
 366                     return;
 367
 368
 369
 370
 371                 case 'XObject.define':
 372                     // func, extends, props.
 373
 374                     var symbol = new Symbol( scope , items[0][1].args || [] , "CONSTRUCTOR" ,  jsdocTok);
 375                     symbol._token = jsdocTok;
 376                     // extends = arg[1]
 377
 378                     this.addSymbol(symbol, jsdocTok.jsdoc);
 379                     var sn = new ScopeNamer(this);
 380                     //print(JSON.stringify(items, null,4));
 381                     // ctr statements.
 382                     sn.walkStatements(scope + '.prototype', items[0][2].items);
 383
 384
 385                     sn.walkObject(scope + '.prototype', false, items[2][0].props );
 386                     return;
 387
 388
 389
 390             }
 391
 392
 393
 394         },
 395
 396         walkObject : function(inscope, name, items, jsdocTok)
 397         {
 398             var scope = inscope + (( name === false) ? '' : ('.' + name));
 399
 400             if (name !== false) {
 401
 402                 var symbol = new Symbol( scope , false , "OBJECT" ,  jsdocTok.jsdoc);
 403                 symbol._token = jsdocTok;
 404                 this.addSymbol(symbol, jsdocTok.jsdoc);
 405
 406             }
 407             // items can be false in this scenaro: a = {};
 408             if (!items) {
 409                 return;
 410             }
 411             print(typeof(items));
 412             this.debugCall("wallkObject : " + scope + '#' + name + '@' + items[Object.keys(items)[0]].key.line);
 413             for( var k in items) {
 414                 var key = items[k].key;
 415                 var val = items[k].val;
 416
 417
 418                 // x : function(....)
 419                 if (val[0].name == 'FUNCTION' ) {
 420
 421
 422                     this.walkFunctionDef (scope, k, val[1].args, val[2].items, key)
 423
 424
 425                     continue;
 426                 }
 427
 428                 // x: ( .... ) conditional  properties? maybe detect function?
 429
 430
 431                 // x : something else - not a function..
 432
 433
 434                 var symbol = new Symbol( scope +'.'+ k , val[1].args || [] , "PROPERTY" ,  key.jsdoc);
 435                 symbol._token = key;
 436
 437                 this.addSymbol(symbol, key.jsdoc);
 438                 continue;
 439
 440
 441             }
 442
 443
 444         },
 445
 446
 447
 448
 449
 450
 451         addSymbol: function(symbol, comment)
 452         {
 453               //print("ADD symbol: " + JSON.stringify( symbol, null, 4));
 454               //print("PARSER addSYMBOL : " + symbol.alias);
 455
 456             // if a symbol alias is documented more than once the last one with the user docs wins
 457
 458             // dumpe some invalid symbols..
 459             var ptype_ar = symbol.alias.split(/#/);
 460             if (ptype_ar.length > 2) {
 461                 // multiple #
 462                 return;
 463             }
 464             if (ptype_ar.length > 1 && ptype_ar[1].split(/\./).length > 1) {
 465                 // multiple . after #
 466                 return;
 467             }
 468
 469             ScopeNamer.prototype.debugCall("addSymbol : " + symbol.alias );
 470
 471             if (ScopeNamer.symbols.hasSymbol(symbol.alias)) {
 472
 473                 if (!comment) { // we do not have a comment, and it's registered.
 474                     return;
 475                 }
 476                 var oldSymbol = ScopeNamer.symbols.getSymbol(symbol.alias);
 477
 478                 if (oldSymbol.comment && oldSymbol.comment.isUserComment && !oldSymbol.comment.hasTags) {
 479                     if (symbol.comment.isUserComment) { // old and new are both documented
 480                         this.LOG.warn("The symbol '"+symbol.alias+"' is documented more than once.");
 481                     }
 482                     else { // old is documented but new isn't
 483                         return;
 484                     }
 485                 }
 486             }
 487
 488             // we don't document anonymous things
 489             //if (this.conf.ignoreAnonymous && symbol.name.match(/\$anonymous\b/)) return;
 490
 491             // uderscored things may be treated as if they were marked private, this cascades
 492             //if (this.conf.treatUnderscoredAsPrivate && symbol.name.match(/[.#-]_[^.#-]+$/)) {
 493             //    symbol.isPrivate = true;
 494             //}
 495
 496             // -p flag is required to document private things
 497             if ((symbol.isInner || symbol.isPrivate) && !this.docPrivate) return;
 498
 499             // ignored things are not documented, this doesn't cascade
 500             if (symbol.isIgnored) return;
 501
 502
 503             //print("ADD symbol: " + symbol.isa + ' => ' + symbol.alias );
 504             //print("ADD symbol: " + JSON.stringify( symbol, null, 4));
 505
 506             // add it to the file's list... (for dumping later..)
 507             if (this.srcFile) {
 508                 ScopeNamer.filesSymbols[Symbol.srcFile].addSymbol(symbol);
 509             }
 510
 511             ScopeNamer.symbols.addSymbol(symbol);
 512         },
 513         addBuiltin : function(name) {
 514
 515             var builtin = new Symbol(name, [], "CONSTRUCTOR", new imports.DocComment.DocComment(""));
 516             builtin.isNamespace = false;
 517             builtin.srcFile = "";
 518             builtin.isPrivate = false;
 519             this.addSymbol(builtin);
 520             return builtin;
 521         }
 522
 523
 524
 525     }
 526 );
 527
 528 ScopeNamer.symbols =  new  imports.SymbolSet.SymbolSet();
 529
 530
 531
 532
 533
 534 ScopeNamer.addSymbol = ScopeNamer.prototype.addSymbol;
 535 ScopeNamer.addBuiltin = ScopeNamer.prototype.addBuiltin;