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;
95 imports.JSDOC.Collapse.Collapse,
99 * add/remove ';' after return to configure at present..
100 * @param {String} str String to output
102 debugCall : function(str) {
104 if (!this.filename.match(/Identifier\.js/)) return;
110 buildSymbols : function()
112 if (!this.statements) {
113 this.statements = this.collapse(this.tokens);
114 //print(JSON.stringify(this.s, null,4));
117 //this.globalScope(this.statements);
118 this.debugCall("build Symbols");
119 //print (this.statements);
120 //print (JSON.stringify(this.statements, null,2));
122 this.walkStatements('_global_', this.statements)
134 walkStatements: function(scope, statements)
136 this.debugCall("walkStatements :" + scope ) ;
139 var isGlobal = scope == '_global_';
141 statements.some(function(st ) {
142 // handle change of scope..
145 st[0].jsdoc.getTag('scope').length
147 print(st[0].jsdoc.getTag('scope'));
148 scope = st[0].jsdoc.getTag('scope');
149 if (typeof(scope) != 'String') {
150 scope = scope[0].desc;
155 res = _this.walkStatement(scope, st);
163 walkStatement: function(scope, stmt)
167 this.debugCall("walkStatement :" + JSON.stringify(scope)+ '@' + this.tokens[0].line );
172 var isGlobal = scope == '_global_';
176 //if (this.filename.match(/pack\.js/) && isGlobal) {
177 // print(JSON.stringify(stmt , null,4));
179 // @ignore stops the parser..
182 stmt[0].jsdoc.getTag('ignore').length
184 this.debugCall("walkStatement : ignore found - " + scope + '@' + this.tokens[0].line );
185 print("GOT ignore?");
190 while (null != (token = this.next())) {
193 //walkFunction(scope, name , args, stmts )
195 if (token.name == "FUNCTION") {
196 // function a() { .... } << scope is a $this$={a}
197 if (this.lookTok(1).is('NAME')) {
198 name = isGlobal ? this.lookTok(1).data : '';
200 this.walkFunctionDef(scope, name, this.lookTok(2).args, this.lookTok(3).items, token);
203 //a = function() { } << scope might be a $this$={a}
204 if (this.lookTok(-1).data == '=' &&
205 this.lookTok(-2).is('NAME')
207 name = this.lookTok(-2).data;
208 this.walkFunctionDef(scope, name, this.lookTok(1).args, this.lookTok(2).items, this.lookTok(-2));
213 print("+++ FUNCTION unusual context" + token.file + ':' + token.line);
223 // XX.yy(a,b, { .... }) << scope might be a or b.. $this$={a}
224 // aa = XX.yy(a,b, { .... }) << scope might aa $this$={a}
226 if (token.is('NAME') && this.lookTok(1).data =='(') {
228 var jsdoc = token.jsdoc;
229 if ((this.lookTok(-1).data == '=') && this.lookTok(-2).is('NAME')) {
230 assign = this.lookTok(-2).data
231 jsdoc = jsdoc || this.lookTok(-2).jsdoc;
233 this.walkCall(scope, assign, token.data, this.lookTok(1).items, jsdoc);
238 // a = { .... } << scope is a $this$={a}
239 if (token.data == '{' && this.lookTok(-1).data == '=' && this.lookTok(-2).is('NAME')) {
241 // could be var x = ..
242 var jd = this.lookTok(-2).jsdoc ? this.lookTok(-2) : this.lookTok(-3);
244 var isVar = this.lookTok(-3).name == 'VAR';
246 // only register names of objects if
247 var name = this.lookTok(-2).data;
248 name = !isGlobal && isVar ? false : name;
250 name = !isGlobal && name && !name.match(/^this\./) ? false : name;
251 if (!isGlobal && name && name.match(/^this\./) ) {
252 // see if scope ends in prototype..
253 print("SCOPE:" + JSON.stringify(scope));
255 (scope.split('.').pop() == 'prototype') &&
256 (name.split('.').length == 2)
258 name = name.split('.').pop();
266 //print(JSON.stringify(token,null,4));
267 this.walkObject(scope, name, token.props, jd);
271 // this.xxxx = (with jsdoc...)
277 if (token.data == '{') {
278 sn = new ScopeNamer(this);
279 //print("GOT { - walkings statuements;}");
281 continue; // object..!?!?!? = ignore ???
282 print(JSON.stringify(token,null,4));
284 sn.walkStatements(scope, token.items);
290 walkFunctionDef : function (inscope, name, args, stmts, jsdocTok)
292 this.debugCall("wallkFuncDef: " + inscope + '@' + this.look(0).line );
293 var scope = name.length ? (inscope + '.' + name) : inscope;
295 var symbol = new Symbol( scope , args || [] , "FUNCTION" , jsdocTok.jsdoc);
296 symbol._token = jsdocTok;
297 this.addSymbol(symbol, jsdocTok.jsdoc);
299 var sn = new ScopeNamer(this);
300 sn.walkStatements(scope, stmts);
306 walkCall : function (inscope, assign, callname, items, jsdocTok)
308 this.debugCall("wallkCall : " + inscope +':' + assign + '@' + this.look(0).line + ' ' + callname );
309 var scope = inscope + ( assign ? ('.' + assign) : '' );
310 //scope = scope.replace(/\^_global\$\./, '');
315 // add the handers for differnt methods in here....
318 // somecall(BASE, { .. object ..})
319 // or... x = somecall(BASE, { ... object..})
320 case 'XObject.extend':
322 //print(JSON.stringify(items,null,4));
323 // SHOULD WE ADD SCOPE HERE???
324 var topscope = scope.split('.').pop();
326 scope = (topscope == items[0][0].data) ?
328 scope + '.' + items[0][0].data;
329 // 2nd arg is a object def
330 if (items[1][0].data != '{') {
334 if (assign != false && !scope.match(/\.prototype$/)) {
335 var symbol = new Symbol( scope , false , "OBJECT" , jsdocTok);
336 symbol._token = jsdocTok;
337 this.addSymbol(symbol, jsdocTok.jsdoc);
342 var sn = new ScopeNamer(this);
344 //print(JSON.stringify(items,null,4));
345 sn.walkObject(scope , false, items[1][0].props, jsdocTok );
352 case 'XObject.define':
353 // func, extends, props.
355 var symbol = new Symbol( scope , items[0][1].args || [] , "CONSTRUCTOR" , jsdocTok);
356 symbol._token = jsdocTok;
359 this.addSymbol(symbol, jsdocTok.jsdoc);
360 var sn = new ScopeNamer(this);
361 //print(JSON.stringify(items, null,4));
363 sn.walkStatements(scope + '.prototype', items[0][2].items);
366 sn.walkObject(scope + '.prototype', false, items[2][0].props );
377 walkObject : function(inscope, name, items, jsdocTok)
379 var scope = inscope + (( name === false) ? '' : ('.' + name));
381 if (name !== false) {
383 var symbol = new Symbol( scope , false , "OBJECT" , jsdocTok.jsdoc);
384 symbol._token = jsdocTok;
385 this.addSymbol(symbol, jsdocTok.jsdoc);
388 // items can be false in this scenaro: a = {};
392 print(typeof(items));
393 this.debugCall("wallkObject : " + scope + '@' + items[Object.keys(items)[0]].key.line);
394 for( var k in items) {
395 var key = items[k].key;
396 var val = items[k].val;
399 // x : function(....)
400 if (val[0].name == 'FUNCTION' ) {
403 this.walkFunctionDef (scope, k, val[1].args, val[2].items, key)
409 // x: ( .... ) conditional properties? maybe detect function?
412 // x : something else - not a function..
415 var symbol = new Symbol( scope +'.'+ k , val[1].args || [] , "PROPERTY" , key.jsdoc);
418 this.addSymbol(symbol, key.jsdoc);
432 addSymbol: function(symbol, comment)
434 //print("ADD symbol: " + JSON.stringify( symbol, null, 4));
435 //print("PARSER addSYMBOL : " + symbol.alias);
437 // if a symbol alias is documented more than once the last one with the user docs wins
439 // dumpe some invalid symbols..
440 var ptype_ar = symbol.alias.split(/#/);
441 if (ptype_ar.length > 2) {
445 if (ptype_ar.length > 1 && ptype_ar[1].split(/\./).length > 1) {
446 // multiple . after #
450 ScopeNamer.prototype.debugCall("addSymbol : " + symbol.alias );
452 if (ScopeNamer.symbols.hasSymbol(symbol.alias)) {
454 if (!comment) { // we do not have a comment, and it's registered.
457 var oldSymbol = ScopeNamer.symbols.getSymbol(symbol.alias);
459 if (oldSymbol.comment && oldSymbol.comment.isUserComment && !oldSymbol.comment.hasTags) {
460 if (symbol.comment.isUserComment) { // old and new are both documented
461 this.LOG.warn("The symbol '"+symbol.alias+"' is documented more than once.");
463 else { // old is documented but new isn't
469 // we don't document anonymous things
470 //if (this.conf.ignoreAnonymous && symbol.name.match(/\$anonymous\b/)) return;
472 // uderscored things may be treated as if they were marked private, this cascades
473 //if (this.conf.treatUnderscoredAsPrivate && symbol.name.match(/[.#-]_[^.#-]+$/)) {
474 // symbol.isPrivate = true;
477 // -p flag is required to document private things
478 if ((symbol.isInner || symbol.isPrivate) && !this.docPrivate) return;
480 // ignored things are not documented, this doesn't cascade
481 if (symbol.isIgnored) return;
484 //print("ADD symbol: " + symbol.isa + ' => ' + symbol.alias );
485 //print("ADD symbol: " + JSON.stringify( symbol, null, 4));
487 // add it to the file's list... (for dumping later..)
489 ScopeNamer.filesSymbols[Symbol.srcFile].addSymbol(symbol);
492 ScopeNamer.symbols.addSymbol(symbol);
494 addBuiltin : function(name) {
496 var builtin = new Symbol(name, [], "CONSTRUCTOR", new imports.DocComment.DocComment(""));
497 builtin.isNamespace = false;
498 builtin.srcFile = "";
499 builtin.isPrivate = false;
500 this.addSymbol(builtin);
509 ScopeNamer.symbols = new imports.SymbolSet.SymbolSet();
515 ScopeNamer.addSymbol = ScopeNamer.prototype.addSymbol;
516 ScopeNamer.addBuiltin = ScopeNamer.prototype.addBuiltin;