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             if (this.filename.match(/File\.js/)) return print(str);
 107             return;
 108         },
 109
 110         collapseTop : true,
 111
 112         buildSymbols : function()
 113         {
 114             if (!this.statements) {
 115                 this.statements = this.collapse(this.tokens);
 116                 //print(JSON.stringify(this.s, null,4));
 117             }
 118
 119             //this.globalScope(this.statements);
 120             this.debugCall("build Symbols");
 121             //print (this.statements);
 122             //print (JSON.stringify(this.statements, null,2));
 123
 124             this.walkStatements(this.global, this.statements)
 125
 126
 127
 128         },
 129
 130
 131         ignore : false,
 132
 133
 134
 135
 136         walkStatements: function(scope, statements)
 137         {
 138             this.debugCall("walkStatements :" + scope ) ;
 139             var _this = this;
 140             var res = false;
 141             var isGlobal = scope == this.global;
 142
 143             statements.some(function(st ) {
 144                 // handle change of scope..
 145                 if (isGlobal &&
 146                         st[0].jsdoc &&
 147                         st[0].jsdoc.getTag('scope').length
 148                    ) {
 149                     //print(st[0].jsdoc.getTag('scope'));
 150                     scope = st[0].jsdoc.getTag('scope');
 151                     // might be an array..
 152                     if (typeof(scope) != 'String') {
 153                         scope = scope[0].desc;
 154
 155                     }
 156                     this.global = scope;
 157                 }
 158
 159
 160                 res = _this.walkStatement(scope, st);
 161                 if (res === true) {
 162                     return true;
 163                 }
 164                 return false;
 165             });
 166         },
 167
 168         walkStatement: function(scope, stmt)
 169         {
 170             this.tokens = stmt;
 171             this.rewind();
 172             this.debugCall("walkStatement :" + JSON.stringify(scope)+ '@' + this.tokens[0].line );
 173
 174             var name;
 175             var sn;
 176
 177             var isGlobal = scope == this.global;
 178
 179
 180
 181             //if (this.filename.match(/pack\.js/) && isGlobal) {
 182             //    print(JSON.stringify(stmt , null,4));
 183             //}
 184             // @ignore stops the parser..
 185             if (isGlobal &&
 186                     stmt[0].jsdoc &&
 187                     stmt[0].jsdoc.getTag('ignore').length
 188                ) {
 189                 this.debugCall("walkStatement : ignore found - " + scope + '@' + this.tokens[0].line );
 190                 print("GOT ignore?");
 191                 return true;
 192             }
 193
 194
 195             while (null != (token = this.next())) {
 196
 197                 //'function'
 198                 //walkFunction(scope, name , args,  stmts  )
 199                 //
 200                 if (token.name == "FUNCTION") {
 201                     // function a() { .... } << scope is a  $this$={a}
 202                     if (this.lookTok(1).is('NAME')) {
 203                         name = isGlobal ? this.lookTok(1).data : '';
 204
 205                         this.walkFunctionDef(scope, name, this.lookTok(2).args, this.lookTok(3).items, token);
 206                         continue;
 207                     }
 208                      //a = function() { } << scope might be a  $this$={a}
 209                     if (this.lookTok(-1).data == '=' &&
 210                         this.lookTok(-2).is('NAME')
 211                     ) {
 212                         name = this.lookTok(-2).data;
 213                         this.walkFunctionDef(scope, name, this.lookTok(1).args, this.lookTok(2).items, this.lookTok(-2));
 214                         continue;
 215                     }
 216
 217
 218                     print("+++ FUNCTION unusual context" + token.file + ':' + token.line);
 219                     continue;
 220
 221                 }
 222
 223                 // control flow ...
 224
 225
 226
 227                 // 'call' scopes
 228                 // XX.yy(a,b, { .... }) << scope might be a or b..  $this$={a}
 229                 // aa = XX.yy(a,b, { .... }) << scope might aa   $this$={a}
 230
 231                 if (token.is('NAME') && this.lookTok(1).data =='(') {
 232                     var assign = false;
 233                     var jsdoc = token.jsdoc;
 234                     if ((this.lookTok(-1).data == '=') && this.lookTok(-2).is('NAME')) {
 235                         assign = this.lookTok(-2).data
 236                         jsdoc = jsdoc || this.lookTok(-2).jsdoc;
 237                     }
 238                     this.walkCall(scope, assign, token.data, this.lookTok(1).items, jsdoc);
 239                     continue;
 240                 }
 241
 242                 //  'object'
 243                 //   a = { .... } << scope is a  $this$={a}
 244                 if (token.data == '{' && this.lookTok(-1).data == '=' && this.lookTok(-2).is('NAME')) {
 245
 246                     // could be var x = ..
 247                     var jd = this.lookTok(-2).jsdoc ? this.lookTok(-2) : this.lookTok(-3);
 248
 249                     var isVar = this.lookTok(-3).name == 'VAR';
 250
 251                     // only register names of objects if
 252                     var name = this.lookTok(-2).data;
 253
 254                     if (isGlobal) {
 255
 256
 257
 258
 259                     } else {
 260                         // not global.
 261                         if (isVar) {
 262                             name = false;
 263                         }
 264                         if (name && !name.match(/^this\./)) {
 265                             name = false;
 266                         }
 267                         if (name && name.match(/^this\./) ) {
 268                             // see if scope ends in prototype..
 269                             print("SCOPE:" + JSON.stringify(scope));
 270                             if (
 271                                 (scope.split('.').pop() == 'prototype') &&
 272                                 (name.split('.').length == 2)
 273                             ){
 274                                 name = name.split('.').pop();
 275                             } else {
 276                                 name = false;
 277                             }
 278
 279                         }
 280
 281                     }
 282
 283
 284
 285                     name = !isGlobal && name && !name.match(/^this\./) ? false : name;
 286                     if (!isGlobal && name && name.match(/^this\./) ) {
 287                         // see if scope ends in prototype..
 288                         print("SCOPE:" + JSON.stringify(scope));
 289                         if (
 290                             (scope.split('.').pop() == 'prototype') &&
 291                             (name.split('.').length == 2)
 292                         ){
 293                             name = name.split('.').pop();
 294                         } else {
 295                             name = false;
 296                         }
 297
 298                     }  else {
 299                         name = false;
 300                     }
 301                     //print(JSON.stringify(token,null,4));
 302                     this.walkObject(scope, name, token.props, jd);
 303                     continue;
 304                 }
 305
 306                 // this.xxxx = (with jsdoc...)
 307
 308
 309
 310
 311                 // standard flow....
 312                 if (token.data == '{') {
 313                     sn = new ScopeNamer(this);
 314                     //print("GOT { - walkings statuements;}");
 315                     if (!token.items) {
 316                         continue; // object..!?!?!? = ignore ???
 317                         print(JSON.stringify(token,null,4));
 318                     }
 319                     sn.walkStatements(scope, token.items);
 320                     continue;
 321                 }
 322             }
 323         },
 324
 325         walkFunctionDef : function (inscope, name, args, stmts, jsdocTok)
 326         {
 327             this.debugCall("wallkFuncDef: " + inscope + '#' + name + '@' + this.look(0).line );
 328             var scope = name.length ? (inscope + '.' + name) : inscope;
 329             if (name.length) {
 330                 var symbol = new Symbol( scope , args || [] , "FUNCTION" ,  jsdocTok.jsdoc);
 331                 symbol._token = jsdocTok;
 332                 this.addSymbol(symbol, jsdocTok.jsdoc);
 333             }
 334             var sn = new ScopeNamer(this);
 335             sn.walkStatements(scope, stmts);
 336
 337         },
 338
 339
 340
 341         walkCall : function (inscope, assign, callname, items, jsdocTok)
 342         {
 343             this.debugCall("walkCall : " + inscope  +':' + assign + '@' + this.look(0).line + ' ' + callname );
 344             var scope = inscope + ( assign ? ('.' + assign) : '' );
 345             //scope = scope.replace(/\^_global\$\./, '');
 346
 347
 348
 349
 350             // add the handers for differnt methods in here....
 351             switch (callname) {
 352
 353                 // somecall(BASE, { .. object ..})
 354                 // or... x = somecall(BASE, { ... object..})
 355                 case 'XObject.extend':
 356                 case 'Roo.apply':
 357                     //print(JSON.stringify(items,null,4));
 358                     // SHOULD WE ADD SCOPE HERE???
 359                     var topscope = scope.split('.').pop();
 360
 361                     scope = (topscope == items[0][0].data) ?
 362                         items[0][0].data :
 363                         scope + '.' + items[0][0].data;
 364                     // 2nd arg is a object def
 365                     if (items[1][0].data != '{') {
 366                         return;
 367                     }
 368
 369                     if (assign != false   && !scope.match(/\.prototype$/)) {
 370                         var symbol = new Symbol( scope , false , "OBJECT" ,  jsdocTok);
 371                         symbol._token = jsdocTok;
 372                         this.addSymbol(symbol, jsdocTok.jsdoc);
 373
 374                     }
 375
 376
 377                     var sn = new ScopeNamer(this);
 378
 379                     //print(JSON.stringify(items,null,4));
 380                     sn.walkObject(scope , false, items[1][0].props, jsdocTok );
 381
 382                     return;
 383
 384
 385
 386
 387                 case 'XObject.define':
 388                     // func, extends, props.
 389
 390                     var symbol = new Symbol( scope , items[0][1].args || [] , "CONSTRUCTOR" ,  jsdocTok);
 391                     symbol._token = jsdocTok;
 392                     // extends = arg[1]
 393
 394                     this.addSymbol(symbol, jsdocTok.jsdoc);
 395                     var sn = new ScopeNamer(this);
 396                     //print(JSON.stringify(items, null,4));
 397                     // ctr statements.
 398                     sn.walkStatements(scope + '.prototype', items[0][2].items);
 399
 400
 401                     sn.walkObject(scope + '.prototype', false, items[2][0].props );
 402                     return;
 403
 404
 405
 406             }
 407
 408
 409
 410         },
 411
 412         walkObject : function(inscope, name, items, jsdocTok)
 413         {
 414             var scope = inscope + (( name === false) ? '' : ('.' + name));
 415
 416             if (name !== false) {
 417
 418                 var symbol = new Symbol( scope , false , "OBJECT" ,  jsdocTok.jsdoc);
 419                 symbol._token = jsdocTok;
 420                 this.addSymbol(symbol, jsdocTok.jsdoc);
 421
 422             }
 423             // items can be false in this scenaro: a = {};
 424             if (!items) {
 425                 return;
 426             }
 427             print(typeof(items));
 428             this.debugCall("wallkObject : " + scope + '#' + name + '@' + items[Object.keys(items)[0]].key.line);
 429             for( var k in items) {
 430                 var key = items[k].key;
 431                 var val = items[k].val;
 432
 433
 434                 // x : function(....)
 435                 if (val[0].name == 'FUNCTION' ) {
 436
 437
 438                     this.walkFunctionDef (scope, k, val[1].args, val[2].items, key)
 439
 440
 441                     continue;
 442                 }
 443
 444                 // x: ( .... ) conditional  properties? maybe detect function?
 445
 446
 447                 // x : something else - not a function..
 448
 449
 450                 var symbol = new Symbol( scope +'.'+ k , val[1].args || [] , "PROPERTY" ,  key.jsdoc);
 451                 symbol._token = key;
 452
 453                 this.addSymbol(symbol, key.jsdoc);
 454                 continue;
 455
 456
 457             }
 458
 459
 460         },
 461
 462
 463
 464
 465
 466
 467         addSymbol: function(symbol, comment)
 468         {
 469               //print("ADD symbol: " + JSON.stringify( symbol, null, 4));
 470               //print("PARSER addSYMBOL : " + symbol.alias);
 471
 472             // if a symbol alias is documented more than once the last one with the user docs wins
 473
 474             // dumpe some invalid symbols..
 475             var ptype_ar = symbol.alias.split(/#/);
 476             if (ptype_ar.length > 2) {
 477                 // multiple #
 478                 return;
 479             }
 480             if (ptype_ar.length > 1 && ptype_ar[1].split(/\./).length > 1) {
 481                 // multiple . after #
 482                 return;
 483             }
 484
 485             ScopeNamer.prototype.debugCall("addSymbol : " + symbol.alias );
 486
 487             if (ScopeNamer.symbols.hasSymbol(symbol.alias)) {
 488
 489                 if (!comment) { // we do not have a comment, and it's registered.
 490                     return;
 491                 }
 492                 var oldSymbol = ScopeNamer.symbols.getSymbol(symbol.alias);
 493
 494                 if (oldSymbol.comment && oldSymbol.comment.isUserComment && !oldSymbol.comment.hasTags) {
 495                     if (symbol.comment.isUserComment) { // old and new are both documented
 496                         this.LOG.warn("The symbol '"+symbol.alias+"' is documented more than once.");
 497                     }
 498                     else { // old is documented but new isn't
 499                         return;
 500                     }
 501                 }
 502             }
 503
 504             // we don't document anonymous things
 505             //if (this.conf.ignoreAnonymous && symbol.name.match(/\$anonymous\b/)) return;
 506
 507             // uderscored things may be treated as if they were marked private, this cascades
 508             //if (this.conf.treatUnderscoredAsPrivate && symbol.name.match(/[.#-]_[^.#-]+$/)) {
 509             //    symbol.isPrivate = true;
 510             //}
 511
 512             // -p flag is required to document private things
 513             if ((symbol.isInner || symbol.isPrivate) && !this.docPrivate) return;
 514
 515             // ignored things are not documented, this doesn't cascade
 516             if (symbol.isIgnored) return;
 517
 518
 519             //print("ADD symbol: " + symbol.isa + ' => ' + symbol.alias );
 520             //print("ADD symbol: " + JSON.stringify( symbol, null, 4));
 521
 522             // add it to the file's list... (for dumping later..)
 523             if (this.srcFile) {
 524                 ScopeNamer.filesSymbols[Symbol.srcFile].addSymbol(symbol);
 525             }
 526
 527             ScopeNamer.symbols.addSymbol(symbol);
 528         },
 529         addBuiltin : function(name) {
 530
 531             var builtin = new Symbol(name, [], "CONSTRUCTOR", new imports.DocComment.DocComment(""));
 532             builtin.isNamespace = false;
 533             builtin.srcFile = "";
 534             builtin.isPrivate = false;
 535             this.addSymbol(builtin);
 536             return builtin;
 537         }
 538
 539
 540
 541     }
 542 );
 543
 544 ScopeNamer.symbols =  new  imports.SymbolSet.SymbolSet();
 545
 546
 547
 548
 549
 550 ScopeNamer.addSymbol = ScopeNamer.prototype.addSymbol;
 551 ScopeNamer.addBuiltin = ScopeNamer.prototype.addBuiltin;