JSDOC/ScopeNamer.js
[app.jsdoc] / JSDOC / ScopeNamer.js
index 5ada2d7..56759a7 100644 (file)
@@ -7,7 +7,8 @@ Symbol = imports.Symbol.Symbol;
 
 /**
  * @class ScopeNamer
- * @namespace JSDOC
+ * @extends Collapse
+ * @scope JSDOC
  * The point of this class is to iterate through the Collapsed tree
  * and add the property 'scopedName' to the tokens.
  *
@@ -87,18 +88,24 @@ ScopeNamer = XObject.define(
         this.args = this.args ? this.args.slice(0)  : [];
         Symbol.srcFile = this.filename;
         this.createJSDOC = true;
-        
+        this.global = '_global_';
        // console.dump(ar);
         
     }, 
     imports.JSDOC.Collapse.Collapse, 
     {
+        
+        global : false,
         /**
          * Call debugging
          * add/remove ';' after return to configure at present..
          * @param {String} str String to output
          */
-        debugCall : function(str)  { return print(str); }, 
+        debugCall : function(str)  {
+            
+            if (this.filename.match(/Scope\.js/)) return print(str);
+            return;
+        }, 
         
         collapseTop : true,
         
@@ -131,9 +138,23 @@ ScopeNamer = XObject.define(
             this.debugCall("walkStatements :" + scope ) ;            
             var _this = this;
             var res = false;
-            
-            
-            statements.forEach(function(st ) {
+            var isGlobal = scope == '_global_';
+           
+            statements.some(function(st ) {
+                // handle change of scope..
+                if (isGlobal &&
+                        st[0].jsdoc &&
+                        st[0].jsdoc.getTag('scope').length
+                   ) {
+                    //print(st[0].jsdoc.getTag('scope'));
+                    scope = st[0].jsdoc.getTag('scope');
+                    // might be an array..
+                    if (typeof(scope) != 'String') {
+                        scope = scope[0].desc;
+                    }
+                }
+                
+                
                 res = _this.walkStatement(scope, st);
                 if (res === true) {
                     return true;
@@ -146,20 +167,39 @@ ScopeNamer = XObject.define(
         {
             this.tokens = stmt;
             this.rewind();
-            this.debugCall("walkStatement :" + scope + '@' + this.tokens[0].line );
+            this.debugCall("walkStatement :" + JSON.stringify(scope)+ '@' + this.tokens[0].line );
              
             var name;
             var sn;
             
-            while (null != (token = this.next())) {
+            var isGlobal = scope == '_global_';
             
+            
+            
+            //if (this.filename.match(/pack\.js/) && isGlobal) {
+            //    print(JSON.stringify(stmt , null,4));
+            //}
+            // @ignore stops the parser..
+            if (isGlobal &&
+                    stmt[0].jsdoc &&
+                    stmt[0].jsdoc.getTag('ignore').length
+               ) {
+                this.debugCall("walkStatement : ignore found - " + scope + '@' + this.tokens[0].line );
+                print("GOT ignore?");
+                return true;
+            }
+           
+            
+            while (null != (token = this.next())) {
+                
                 //'function' 
                 //walkFunction(scope, name , args,  stmts  )
                 //
                 if (token.name == "FUNCTION") {
                     // function a() { .... } << scope is a  $this$={a}
                     if (this.lookTok(1).is('NAME')) {
-                        name = this.lookTok(2).data;
+                        name = isGlobal ? this.lookTok(1).data : '';
+                        
                         this.walkFunctionDef(scope, name, this.lookTok(2).args, this.lookTok(3).items, token);
                         continue;
                     }
@@ -202,8 +242,32 @@ ScopeNamer = XObject.define(
                 if (token.data == '{' && this.lookTok(-1).data == '=' && this.lookTok(-2).is('NAME')) {
                     
                     // could be var x = ..
-                    var jd = this.lookTok(-2).jsdoc ? this.lookTok(-2) : this.lookTok(-3); 
-                    this.walkObject(scope, this.lookTok(-2).data, token.props, jd);
+                    var jd = this.lookTok(-2).jsdoc ? this.lookTok(-2) : this.lookTok(-3);
+                    
+                    var isVar = this.lookTok(-3).name == 'VAR';
+                    
+                    // only register names of objects if 
+                    var name = this.lookTok(-2).data;
+                    name = !isGlobal && isVar ? false : name;
+                    
+                    name = !isGlobal && name && !name.match(/^this\./) ? false : name;
+                    if (!isGlobal && name && name.match(/^this\./) ) { 
+                        // see if scope ends in prototype..
+                        print("SCOPE:" + JSON.stringify(scope));
+                        if (
+                            (scope.split('.').pop() == 'prototype') &&
+                            (name.split('.').length == 2)
+                        ){
+                            name = name.split('.').pop();
+                        } else {
+                            name = false;
+                        }
+                        
+                    }  else {
+                        name = false;
+                    }
+                    //print(JSON.stringify(token,null,4));
+                    this.walkObject(scope, name, token.props, jd);
                     continue;
                 }
                  
@@ -228,13 +292,13 @@ ScopeNamer = XObject.define(
         
         walkFunctionDef : function (inscope, name, args, stmts, jsdocTok)
         {
-            this.debugCall("wallkFuncDef: " + inscope + '@' + this.look(0).line );
-            var scope = inscope + '.' + name;
-            
-            
-            var symbol = new Symbol( scope , args || [] , "FUNCTION" ,  jsdocTok.jsdoc);
-            symbol._token = jsdocTok;
-            this.addSymbol(symbol, jsdocTok.jsdoc);
+            this.debugCall("wallkFuncDef: " + inscope + '#' + name + '@' + this.look(0).line );
+            var scope = name.length ? (inscope + '.' + name) : inscope;
+            if (name.length) { 
+                var symbol = new Symbol( scope , args || [] , "FUNCTION" ,  jsdocTok.jsdoc);
+                symbol._token = jsdocTok;
+                this.addSymbol(symbol, jsdocTok.jsdoc);
+            }
             var sn = new ScopeNamer(this);
             sn.walkStatements(scope, stmts);
             
@@ -244,7 +308,7 @@ ScopeNamer = XObject.define(
         
         walkCall : function (inscope, assign, callname, items, jsdocTok)
         {
-            this.debugCall("wallkCall : " + inscope + '@' + this.look(0).line + ' ' + callname );
+            this.debugCall("wallkCall : " + inscope  +':' + assign + '@' + this.look(0).line + ' ' + callname );
             var scope = inscope + ( assign ? ('.' + assign) : '' );
             //scope = scope.replace(/\^_global\$\./, '');
             
@@ -259,15 +323,29 @@ ScopeNamer = XObject.define(
                 case 'XObject.extend':
                 case 'Roo.apply':
                     //print(JSON.stringify(items,null,4));
-                    scope = items[0][0].data;
+                    // SHOULD WE ADD SCOPE HERE???
+                    var topscope = scope.split('.').pop();
+                    
+                    scope = (topscope == items[0][0].data) ?
+                        items[0][0].data :
+                        scope + '.' + items[0][0].data;
                     // 2nd arg is a object def
                     if (items[1][0].data != '{') {
                         return;
                     }
+                    
+                    if (assign != false   && !scope.match(/\.prototype$/)) { 
+                        var symbol = new Symbol( scope , false , "OBJECT" ,  jsdocTok);
+                        symbol._token = jsdocTok;
+                        this.addSymbol(symbol, jsdocTok.jsdoc);
+                        
+                    }
+                    
+                    
                     var sn = new ScopeNamer(this);
                     
-                    print(JSON.stringify(items,null,4));
-                    sn.walkObject(scope + '.prototype', false, items[1][0].props, jsdocTok );
+                    //print(JSON.stringify(items,null,4));
+                    sn.walkObject(scope , false, items[1][0].props, jsdocTok );
                     
                     return;
                 
@@ -283,10 +361,12 @@ ScopeNamer = XObject.define(
                     
                     this.addSymbol(symbol, jsdocTok.jsdoc);
                     var sn = new ScopeNamer(this);
+                    //print(JSON.stringify(items, null,4));
+                    // ctr statements.
+                    sn.walkStatements(scope + '.prototype', items[0][2].items);
                     
                     
-                    sn.walkStatements(scope, items[0][2].items);
-                    sn.walkObject(scope + '.prototype', false, items[2].props );
+                    sn.walkObject(scope + '.prototype', false, items[2][0].props );
                     return;
                 
                 
@@ -308,6 +388,10 @@ ScopeNamer = XObject.define(
                 this.addSymbol(symbol, jsdocTok.jsdoc);
                  
             }
+            // items can be false in this scenaro: a = {};
+            if (!items) {
+                return;
+            }
             print(typeof(items));
             this.debugCall("wallkObject : " + scope + '@' + items[Object.keys(items)[0]].key.line);
             for( var k in items) {
@@ -334,7 +418,7 @@ ScopeNamer = XObject.define(
                 var symbol = new Symbol( scope +'.'+ k , val[1].args || [] , "PROPERTY" ,  key.jsdoc);
                 symbol._token = key;
                    
-                this.addSymbol(key, key.jsdoc);
+                this.addSymbol(symbol, key.jsdoc);
                 continue;
                  
                 
@@ -350,9 +434,24 @@ ScopeNamer = XObject.define(
         
         addSymbol: function(symbol, comment)
         {
-                     //print("PARSER addSYMBOL : " + symbol.alias);
-             this.debugCall("addSymbol : " +symbol.alias );       
+              //print("ADD symbol: " + JSON.stringify( symbol, null, 4));
+              //print("PARSER addSYMBOL : " + symbol.alias);
+            
             // if a symbol alias is documented more than once the last one with the user docs wins
+            
+            // dumpe some invalid symbols..
+            var ptype_ar = symbol.alias.split(/#/);
+            if (ptype_ar.length > 2) {
+                // multiple #
+                return;
+            }
+            if (ptype_ar.length > 1 && ptype_ar[1].split(/\./).length > 1) {
+                // multiple . after #
+                return;
+            }
+            
+            ScopeNamer.prototype.debugCall("addSymbol : " + symbol.alias );       
+            
             if (ScopeNamer.symbols.hasSymbol(symbol.alias)) {
                 
                 if (!comment) { // we do not have a comment, and it's registered.