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                         print ("GLOBAL: ")
 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                     //print(JSON.stringify(token,null,4));
 285                     this.walkObject(scope, name, token.props, jd);
 286                     continue;
 287                 }
 288
 289                 // this.xxxx = (with jsdoc...)
 290
 291
 292
 293
 294                 // standard flow....
 295                 if (token.data == '{') {
 296                     sn = new ScopeNamer(this);
 297                     //print("GOT { - walkings statuements;}");
 298                     if (!token.items) {
 299                         continue; // object..!?!?!? = ignore ???
 300                         print(JSON.stringify(token,null,4));
 301                     }
 302                     sn.walkStatements(scope, token.items);
 303                     continue;
 304                 }
 305             }
 306         },
 307
 308         walkFunctionDef : function (inscope, name, args, stmts, jsdocTok)
 309         {
 310             this.debugCall("wallkFuncDef: " + inscope + '#' + name + '@' + this.look(0).line );
 311             var scope = name.length ? (inscope + '.' + name) : inscope;
 312             if (name.length) {
 313                 var symbol = new Symbol( scope , args || [] , "FUNCTION" ,  jsdocTok.jsdoc);
 314                 symbol._token = jsdocTok;
 315                 this.addSymbol(symbol, jsdocTok.jsdoc);
 316             }
 317             var sn = new ScopeNamer(this);
 318             sn.walkStatements(scope, stmts);
 319
 320         },
 321
 322
 323
 324         walkCall : function (inscope, assign, callname, items, jsdocTok)
 325         {
 326             this.debugCall("walkCall : " + inscope  +':' + assign + '@' + this.look(0).line + ' ' + callname );
 327             var scope = inscope + ( assign ? ('.' + assign) : '' );
 328             //scope = scope.replace(/\^_global\$\./, '');
 329
 330
 331
 332
 333             // add the handers for differnt methods in here....
 334             switch (callname) {
 335
 336                 // somecall(BASE, { .. object ..})
 337                 // or... x = somecall(BASE, { ... object..})
 338                 case 'XObject.extend':
 339                 case 'Roo.apply':
 340                     //print(JSON.stringify(items,null,4));
 341                     // SHOULD WE ADD SCOPE HERE???
 342                     var topscope = scope.split('.').pop();
 343
 344                     scope = (topscope == items[0][0].data) ?
 345                         items[0][0].data :
 346                         scope + '.' + items[0][0].data;
 347                     // 2nd arg is a object def
 348                     if (items[1][0].data != '{') {
 349                         return;
 350                     }
 351
 352                     if (assign != false   && !scope.match(/\.prototype$/)) {
 353                         var symbol = new Symbol( scope , false , "OBJECT" ,  jsdocTok);
 354                         symbol._token = jsdocTok;
 355                         this.addSymbol(symbol, jsdocTok.jsdoc);
 356
 357                     }
 358
 359
 360                     var sn = new ScopeNamer(this);
 361
 362                     //print(JSON.stringify(items,null,4));
 363                     sn.walkObject(scope , false, items[1][0].props, jsdocTok );
 364
 365                     return;
 366
 367
 368
 369
 370                 case 'XObject.define':
 371                     // func, extends, props.
 372
 373                     var symbol = new Symbol( scope , items[0][1].args || [] , "CONSTRUCTOR" ,  jsdocTok);
 374                     symbol._token = jsdocTok;
 375                     // extends = arg[1]
 376
 377                     this.addSymbol(symbol, jsdocTok.jsdoc);
 378                     var sn = new ScopeNamer(this);
 379                     //print(JSON.stringify(items, null,4));
 380                     // ctr statements.
 381                     sn.walkStatements(scope + '.prototype', items[0][2].items);
 382
 383
 384                     sn.walkObject(scope + '.prototype', false, items[2][0].props );
 385                     return;
 386
 387
 388
 389             }
 390
 391
 392
 393         },
 394
 395         walkObject : function(inscope, name, items, jsdocTok)
 396         {
 397             var scope = inscope + (( name === false) ? '' : ('.' + name));
 398
 399             if (name !== false) {
 400
 401                 var symbol = new Symbol( scope , false , "OBJECT" ,  jsdocTok.jsdoc);
 402                 symbol._token = jsdocTok;
 403                 this.addSymbol(symbol, jsdocTok.jsdoc);
 404
 405             }
 406             // items can be false in this scenaro: a = {};
 407             if (!items) {
 408                 return;
 409             }
 410             print(typeof(items));
 411             this.debugCall("wallkObject : " + scope + '#' + name + '@' + items[Object.keys(items)[0]].key.line);
 412             for( var k in items) {
 413                 var key = items[k].key;
 414                 var val = items[k].val;
 415
 416
 417                 // x : function(....)
 418                 if (val[0].name == 'FUNCTION' ) {
 419
 420
 421                     this.walkFunctionDef (scope, k, val[1].args, val[2].items, key)
 422
 423
 424                     continue;
 425                 }
 426
 427                 // x: ( .... ) conditional  properties? maybe detect function?
 428
 429
 430                 // x : something else - not a function..
 431
 432
 433                 var symbol = new Symbol( scope +'.'+ k , val[1].args || [] , "PROPERTY" ,  key.jsdoc);
 434                 symbol._token = key;
 435
 436                 this.addSymbol(symbol, key.jsdoc);
 437                 continue;
 438
 439
 440             }
 441
 442
 443         },
 444
 445
 446
 447
 448
 449
 450         addSymbol: function(symbol, comment)
 451         {
 452               //print("ADD symbol: " + JSON.stringify( symbol, null, 4));
 453               //print("PARSER addSYMBOL : " + symbol.alias);
 454
 455             // if a symbol alias is documented more than once the last one with the user docs wins
 456
 457             // dumpe some invalid symbols..
 458             var ptype_ar = symbol.alias.split(/#/);
 459             if (ptype_ar.length > 2) {
 460                 // multiple #
 461                 return;
 462             }
 463             if (ptype_ar.length > 1 && ptype_ar[1].split(/\./).length > 1) {
 464                 // multiple . after #
 465                 return;
 466             }
 467
 468             ScopeNamer.prototype.debugCall("addSymbol : " + symbol.alias );
 469
 470             if (ScopeNamer.symbols.hasSymbol(symbol.alias)) {
 471
 472                 if (!comment) { // we do not have a comment, and it's registered.
 473                     return;
 474                 }
 475                 var oldSymbol = ScopeNamer.symbols.getSymbol(symbol.alias);
 476
 477                 if (oldSymbol.comment && oldSymbol.comment.isUserComment && !oldSymbol.comment.hasTags) {
 478                     if (symbol.comment.isUserComment) { // old and new are both documented
 479                         this.LOG.warn("The symbol '"+symbol.alias+"' is documented more than once.");
 480                     }
 481                     else { // old is documented but new isn't
 482                         return;
 483                     }
 484                 }
 485             }
 486
 487             // we don't document anonymous things
 488             //if (this.conf.ignoreAnonymous && symbol.name.match(/\$anonymous\b/)) return;
 489
 490             // uderscored things may be treated as if they were marked private, this cascades
 491             //if (this.conf.treatUnderscoredAsPrivate && symbol.name.match(/[.#-]_[^.#-]+$/)) {
 492             //    symbol.isPrivate = true;
 493             //}
 494
 495             // -p flag is required to document private things
 496             if ((symbol.isInner || symbol.isPrivate) && !this.docPrivate) return;
 497
 498             // ignored things are not documented, this doesn't cascade
 499             if (symbol.isIgnored) return;
 500
 501
 502             //print("ADD symbol: " + symbol.isa + ' => ' + symbol.alias );
 503             //print("ADD symbol: " + JSON.stringify( symbol, null, 4));
 504
 505             // add it to the file's list... (for dumping later..)
 506             if (this.srcFile) {
 507                 ScopeNamer.filesSymbols[Symbol.srcFile].addSymbol(symbol);
 508             }
 509
 510             ScopeNamer.symbols.addSymbol(symbol);
 511         },
 512         addBuiltin : function(name) {
 513
 514             var builtin = new Symbol(name, [], "CONSTRUCTOR", new imports.DocComment.DocComment(""));
 515             builtin.isNamespace = false;
 516             builtin.srcFile = "";
 517             builtin.isPrivate = false;
 518             this.addSymbol(builtin);
 519             return builtin;
 520         }
 521
 522
 523
 524     }
 525 );
 526
 527 ScopeNamer.symbols =  new  imports.SymbolSet.SymbolSet();
 528
 529
 530
 531
 532
 533 ScopeNamer.addSymbol = ScopeNamer.prototype.addSymbol;
 534 ScopeNamer.addBuiltin = ScopeNamer.prototype.addBuiltin;