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(/BuildDocs\.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 scope = st[0].jsdoc.getTag('scope');
151 res = _this.walkStatement(scope, st);
159 walkStatement: function(scope, stmt)
163 this.debugCall("walkStatement :" + scope + '@' + this.tokens[0].line );
168 var isGlobal = scope == '_global_';
172 //if (this.filename.match(/pack\.js/) && isGlobal) {
173 // print(JSON.stringify(stmt , null,4));
175 // @ignore stops the parser..
178 stmt[0].jsdoc.getTag('ignore').length
180 this.debugCall("walkStatement : ignore found - " + scope + '@' + this.tokens[0].line );
181 print("GOT ignore?");
186 while (null != (token = this.next())) {
189 //walkFunction(scope, name , args, stmts )
191 if (token.name == "FUNCTION") {
192 // function a() { .... } << scope is a $this$={a}
193 if (this.lookTok(1).is('NAME')) {
194 name = isGlobal ? this.lookTok(1).data : '';
196 this.walkFunctionDef(scope, name, this.lookTok(2).args, this.lookTok(3).items, token);
199 //a = function() { } << scope might be a $this$={a}
200 if (this.lookTok(-1).data == '=' &&
201 this.lookTok(-2).is('NAME')
203 name = this.lookTok(-2).data;
204 this.walkFunctionDef(scope, name, this.lookTok(1).args, this.lookTok(2).items, this.lookTok(-2));
209 print("+++ FUNCTION unusual context" + token.file + ':' + token.line);
219 // XX.yy(a,b, { .... }) << scope might be a or b.. $this$={a}
220 // aa = XX.yy(a,b, { .... }) << scope might aa $this$={a}
222 if (token.is('NAME') && this.lookTok(1).data =='(') {
224 var jsdoc = token.jsdoc;
225 if ((this.lookTok(-1).data == '=') && this.lookTok(-2).is('NAME')) {
226 assign = this.lookTok(-2).data
227 jsdoc = jsdoc || this.lookTok(-2).jsdoc;
229 this.walkCall(scope, assign, token.data, this.lookTok(1).items, jsdoc);
234 // a = { .... } << scope is a $this$={a}
235 if (token.data == '{' && this.lookTok(-1).data == '=' && this.lookTok(-2).is('NAME')) {
237 // could be var x = ..
238 var jd = this.lookTok(-2).jsdoc ? this.lookTok(-2) : this.lookTok(-3);
240 var isVar = this.lookTok(-3).name == 'VAR';
242 // only register names of objects if
243 var name = this.lookTok(-2).data;
244 name = !isGlobal && isVar ? false : name;
245 name = !isGlobal && name && !name.match(/^this\./) ? false : name;
246 //print(JSON.stringify(token,null,4));
247 this.walkObject(scope, name, token.props, jd);
251 // this.xxxx = (with jsdoc...)
257 if (token.data == '{') {
258 sn = new ScopeNamer(this);
259 //print("GOT { - walkings statuements;}");
261 continue; // object..!?!?!? = ignore ???
262 print(JSON.stringify(token,null,4));
264 sn.walkStatements(scope, token.items);
270 walkFunctionDef : function (inscope, name, args, stmts, jsdocTok)
272 this.debugCall("wallkFuncDef: " + inscope + '@' + this.look(0).line );
273 var scope = name.length ? (inscope + '.' + name) : inscope;
275 var symbol = new Symbol( scope , args || [] , "FUNCTION" , jsdocTok.jsdoc);
276 symbol._token = jsdocTok;
277 this.addSymbol(symbol, jsdocTok.jsdoc);
279 var sn = new ScopeNamer(this);
280 sn.walkStatements(scope, stmts);
286 walkCall : function (inscope, assign, callname, items, jsdocTok)
288 this.debugCall("wallkCall : " + inscope +':' + assign + '@' + this.look(0).line + ' ' + callname );
289 var scope = inscope + ( assign ? ('.' + assign) : '' );
290 //scope = scope.replace(/\^_global\$\./, '');
295 // add the handers for differnt methods in here....
298 // somecall(BASE, { .. object ..})
299 // or... x = somecall(BASE, { ... object..})
300 case 'XObject.extend':
302 //print(JSON.stringify(items,null,4));
303 scope = items[0][0].data;
304 // 2nd arg is a object def
305 if (items[1][0].data != '{') {
309 if (assign != false && !scope.match(/\.prototype$/)) {
310 var symbol = new Symbol( scope , false , "OBJECT" , jsdocTok);
311 symbol._token = jsdocTok;
312 this.addSymbol(symbol, jsdocTok.jsdoc);
317 var sn = new ScopeNamer(this);
319 //print(JSON.stringify(items,null,4));
320 sn.walkObject(scope , false, items[1][0].props, jsdocTok );
327 case 'XObject.define':
328 // func, extends, props.
330 var symbol = new Symbol( scope , items[0][1].args || [] , "CONSTRUCTOR" , jsdocTok);
331 symbol._token = jsdocTok;
334 this.addSymbol(symbol, jsdocTok.jsdoc);
335 var sn = new ScopeNamer(this);
336 //print(JSON.stringify(items, null,4));
338 sn.walkStatements(scope + '.prototype', items[0][2].items);
341 sn.walkObject(scope + '.prototype', false, items[2][0].props );
352 walkObject : function(inscope, name, items, jsdocTok)
354 var scope = inscope + (( name === false) ? '' : ('.' + name));
356 if (name !== false) {
358 var symbol = new Symbol( scope , false , "OBJECT" , jsdocTok.jsdoc);
359 symbol._token = jsdocTok;
360 this.addSymbol(symbol, jsdocTok.jsdoc);
363 // items can be false in this scenaro: a = {};
367 print(typeof(items));
368 this.debugCall("wallkObject : " + scope + '@' + items[Object.keys(items)[0]].key.line);
369 for( var k in items) {
370 var key = items[k].key;
371 var val = items[k].val;
374 // x : function(....)
375 if (val[0].name == 'FUNCTION' ) {
378 this.walkFunctionDef (scope, k, val[1].args, val[2].items, key)
384 // x: ( .... ) conditional properties? maybe detect function?
387 // x : something else - not a function..
390 var symbol = new Symbol( scope +'.'+ k , val[1].args || [] , "PROPERTY" , key.jsdoc);
393 this.addSymbol(symbol, key.jsdoc);
407 addSymbol: function(symbol, comment)
409 //print("ADD symbol: " + JSON.stringify( symbol, null, 4));
410 //print("PARSER addSYMBOL : " + symbol.alias);
412 // if a symbol alias is documented more than once the last one with the user docs wins
414 // dumpe some invalid symbols..
415 var ptype_ar = symbol.alias.split(/#/);
416 if (ptype_ar.length > 2) {
420 if (ptype_ar.length > 1 && ptype_ar[1].split(/\./).length > 1) {
421 // multiple . after #
425 ScopeNamer.prototype.debugCall("addSymbol : " + symbol.alias );
427 if (ScopeNamer.symbols.hasSymbol(symbol.alias)) {
429 if (!comment) { // we do not have a comment, and it's registered.
432 var oldSymbol = ScopeNamer.symbols.getSymbol(symbol.alias);
434 if (oldSymbol.comment && oldSymbol.comment.isUserComment && !oldSymbol.comment.hasTags) {
435 if (symbol.comment.isUserComment) { // old and new are both documented
436 this.LOG.warn("The symbol '"+symbol.alias+"' is documented more than once.");
438 else { // old is documented but new isn't
444 // we don't document anonymous things
445 //if (this.conf.ignoreAnonymous && symbol.name.match(/\$anonymous\b/)) return;
447 // uderscored things may be treated as if they were marked private, this cascades
448 //if (this.conf.treatUnderscoredAsPrivate && symbol.name.match(/[.#-]_[^.#-]+$/)) {
449 // symbol.isPrivate = true;
452 // -p flag is required to document private things
453 if ((symbol.isInner || symbol.isPrivate) && !this.docPrivate) return;
455 // ignored things are not documented, this doesn't cascade
456 if (symbol.isIgnored) return;
459 //print("ADD symbol: " + symbol.isa + ' => ' + symbol.alias );
460 //print("ADD symbol: " + JSON.stringify( symbol, null, 4));
462 // add it to the file's list... (for dumping later..)
464 ScopeNamer.filesSymbols[Symbol.srcFile].addSymbol(symbol);
467 ScopeNamer.symbols.addSymbol(symbol);
469 addBuiltin : function(name) {
471 var builtin = new Symbol(name, [], "CONSTRUCTOR", new imports.DocComment.DocComment(""));
472 builtin.isNamespace = false;
473 builtin.srcFile = "";
474 builtin.isPrivate = false;
475 this.addSymbol(builtin);
484 ScopeNamer.symbols = new imports.SymbolSet.SymbolSet();
490 ScopeNamer.addSymbol = ScopeNamer.prototype.addSymbol;
491 ScopeNamer.addBuiltin = ScopeNamer.prototype.addBuiltin;