1 XObject = imports.XObject.XObject;
4 console = imports.console.console;
6 Symbol = imports.Symbol.Symbol;
12 * The point of this class is to iterate through the Collapsed tree
13 * and add the property 'scopedName' to the tokens.
18 After spending some time looking at this, a few conclusions...
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
23 scopes are normally changed when these things occur:
26 globalScope(stmts) => statementsScope($global$, stmts)
30 objectScope(sname, props )
31 a = { .... } << scope is a $this$={a}
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..
42 functionScope(sname, stmts )
43 function a() { .... } << scope is a $this$={a}
44 a = function() { } << scope might be a $this$={a}
51 XX.yy(a,b, { .... }) << scope might be a or b.. $this$={a}
52 aa = XX.yy(a,b, { .... }) << scope might aa $this$={a}
54 callscope(name, pref, args)
59 foo = new (function() { }
61 RETURN function(...) {
72 * sn = new ScopeName({
73 tokens : ... result from tokenizer,
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.
83 ScopeNamer = XObject.define(
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_';
95 imports.JSDOC.Collapse.Collapse,
101 * add/remove ';' after return to configure at present..
102 * @param {String} str String to output
104 debugCall : function(str) {
106 //if (this.filename.match(/File\.js/)) return print(str);
112 buildSymbols : function()
114 if (!this.statements) {
115 this.statements = this.collapse(this.tokens);
116 //print(JSON.stringify(this.s, null,4));
119 //this.globalScope(this.statements);
120 this.debugCall("build Symbols");
121 //print (this.statements);
122 //print (JSON.stringify(this.statements, null,2));
124 this.walkStatements(this.global, this.statements)
136 walkStatements: function(scope, statements)
138 this.debugCall("walkStatements :" + scope ) ;
141 var isGlobal = scope == this.global;
143 statements.some(function(st ) {
144 // handle change of scope..
147 st[0].jsdoc.getTag('scope').length
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;
160 res = _this.walkStatement(scope, st);
168 walkStatement: function(scope, stmt)
172 this.debugCall("walkStatement :" + JSON.stringify(scope)+ '@' + this.tokens[0].line );
177 var isGlobal = scope == this.global;
181 //if (this.filename.match(/pack\.js/) && isGlobal) {
182 // print(JSON.stringify(stmt , null,4));
184 // @ignore stops the parser..
187 stmt[0].jsdoc.getTag('ignore').length
189 this.debugCall("walkStatement : ignore found - " + scope + '@' + this.tokens[0].line );
190 print("GOT ignore?");
195 while (null != (token = this.next())) {
198 //walkFunction(scope, name , args, stmts )
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 : '';
205 this.walkFunctionDef(scope, name, this.lookTok(2).args, this.lookTok(3).items, token);
208 //a = function() { } << scope might be a $this$={a}
209 if (this.lookTok(-1).data == '=' &&
210 this.lookTok(-2).is('NAME')
212 name = this.lookTok(-2).data;
213 this.walkFunctionDef(scope, name, this.lookTok(1).args, this.lookTok(2).items, this.lookTok(-2));
218 print("+++ FUNCTION unusual context" + token.file + ':' + token.line);
228 // XX.yy(a,b, { .... }) << scope might be a or b.. $this$={a}
229 // aa = XX.yy(a,b, { .... }) << scope might aa $this$={a}
231 if (token.is('NAME') && this.lookTok(1).data =='(') {
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;
238 this.walkCall(scope, assign, token.data, this.lookTok(1).items, jsdoc);
243 // a = { .... } << scope is a $this$={a}
244 if (token.data == '{' && this.lookTok(-1).data == '=' && this.lookTok(-2).is('NAME')) {
246 // could be var x = ..
247 var jd = this.lookTok(-2).jsdoc ? this.lookTok(-2) : this.lookTok(-3);
249 var isVar = this.lookTok(-3).name == 'VAR';
251 // only register names of objects if
252 var name = this.lookTok(-2).data;
264 if (name && !name.match(/^this\./)) {
267 if (name && name.match(/^this\./) ) {
268 // see if scope ends in prototype..
269 print("SCOPE:" + JSON.stringify(scope));
271 (scope.split('.').pop() == 'prototype') &&
272 (name.split('.').length == 2)
274 name = name.split('.').pop();
284 //print(JSON.stringify(token,null,4));
285 this.walkObject(scope, name, token.props, jd);
289 // this.xxxx = (with jsdoc...)
295 if (token.data == '{') {
296 sn = new ScopeNamer(this);
297 //print("GOT { - walkings statuements;}");
299 continue; // object..!?!?!? = ignore ???
300 print(JSON.stringify(token,null,4));
302 sn.walkStatements(scope, token.items);
308 walkFunctionDef : function (inscope, name, args, stmts, jsdocTok)
310 this.debugCall("wallkFuncDef: " + inscope + '#' + name + '@' + this.look(0).line );
311 var scope = name.length ? (inscope + '.' + name) : inscope;
313 var symbol = new Symbol( scope , args || [] , "FUNCTION" , jsdocTok.jsdoc);
314 symbol._token = jsdocTok;
315 this.addSymbol(symbol, jsdocTok.jsdoc);
317 var sn = new ScopeNamer(this);
318 sn.walkStatements(scope, stmts);
324 walkCall : function (inscope, assign, callname, items, jsdocTok)
326 this.debugCall("walkCall : " + inscope +':' + assign + '@' + this.look(0).line + ' ' + callname );
327 var scope = inscope + ( assign ? ('.' + assign) : '' );
328 //scope = scope.replace(/\^_global\$\./, '');
333 // add the handers for differnt methods in here....
336 // somecall(BASE, { .. object ..})
337 // or... x = somecall(BASE, { ... object..})
338 case 'XObject.extend':
340 //print(JSON.stringify(items,null,4));
341 // SHOULD WE ADD SCOPE HERE???
342 var topscope = scope.split('.').pop();
344 scope = (topscope == items[0][0].data) ?
346 scope + '.' + items[0][0].data;
347 // 2nd arg is a object def
348 if (items[1][0].data != '{') {
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);
360 var sn = new ScopeNamer(this);
362 //print(JSON.stringify(items,null,4));
363 sn.walkObject(scope , false, items[1][0].props, jsdocTok );
370 case 'XObject.define':
371 // func, extends, props.
373 var symbol = new Symbol( scope , items[0][1].args || [] , "CONSTRUCTOR" , jsdocTok);
374 symbol._token = jsdocTok;
377 this.addSymbol(symbol, jsdocTok.jsdoc);
378 var sn = new ScopeNamer(this);
379 //print(JSON.stringify(items, null,4));
381 sn.walkStatements(scope + '.prototype', items[0][2].items);
384 sn.walkObject(scope + '.prototype', false, items[2][0].props );
395 walkObject : function(inscope, name, items, jsdocTok)
397 var scope = inscope + (( name === false) ? '' : ('.' + name));
399 if (name !== false) {
401 var symbol = new Symbol( scope , false , "OBJECT" , jsdocTok.jsdoc);
402 symbol._token = jsdocTok;
403 this.addSymbol(symbol, jsdocTok.jsdoc);
406 // items can be false in this scenaro: a = {};
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;
417 // x : function(....)
418 if (val[0].name == 'FUNCTION' ) {
421 this.walkFunctionDef (scope, k, val[1].args, val[2].items, key)
427 // x: ( .... ) conditional properties? maybe detect function?
430 // x : something else - not a function..
433 var symbol = new Symbol( scope +'.'+ k , val[1].args || [] , "PROPERTY" , key.jsdoc);
436 this.addSymbol(symbol, key.jsdoc);
450 addSymbol: function(symbol, comment)
452 //print("ADD symbol: " + JSON.stringify( symbol, null, 4));
453 //print("PARSER addSYMBOL : " + symbol.alias);
455 // if a symbol alias is documented more than once the last one with the user docs wins
457 // dumpe some invalid symbols..
458 var ptype_ar = symbol.alias.split(/#/);
459 if (ptype_ar.length > 2) {
463 if (ptype_ar.length > 1 && ptype_ar[1].split(/\./).length > 1) {
464 // multiple . after #
468 ScopeNamer.prototype.debugCall("addSymbol : " + symbol.alias );
470 if (ScopeNamer.symbols.hasSymbol(symbol.alias)) {
472 if (!comment) { // we do not have a comment, and it's registered.
475 var oldSymbol = ScopeNamer.symbols.getSymbol(symbol.alias);
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.");
481 else { // old is documented but new isn't
487 // we don't document anonymous things
488 //if (this.conf.ignoreAnonymous && symbol.name.match(/\$anonymous\b/)) return;
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;
495 // -p flag is required to document private things
496 if ((symbol.isInner || symbol.isPrivate) && !this.docPrivate) return;
498 // ignored things are not documented, this doesn't cascade
499 if (symbol.isIgnored) return;
502 //print("ADD symbol: " + symbol.isa + ' => ' + symbol.alias );
503 //print("ADD symbol: " + JSON.stringify( symbol, null, 4));
505 // add it to the file's list... (for dumping later..)
507 ScopeNamer.filesSymbols[Symbol.srcFile].addSymbol(symbol);
510 ScopeNamer.symbols.addSymbol(symbol);
512 addBuiltin : function(name) {
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);
527 ScopeNamer.symbols = new imports.SymbolSet.SymbolSet();
533 ScopeNamer.addSymbol = ScopeNamer.prototype.addSymbol;
534 ScopeNamer.addBuiltin = ScopeNamer.prototype.addBuiltin;