1 //<script type="text/javascript">
3 Walker2 = imports.Walker2.Walker2;
4 Symbol = imports.Symbol.Symbol;
5 SymbolSet = imports.SymbolSet.SymbolSet;
6 DocComment = imports.DocComment.DocComment;
7 Options = imports.BuildDocs.Options;
9 * Parser is a static instance..
20 walker : false, // will be JSDOC.Walker()
21 symbols : false, //will be JSDOC.SymbolSet()
31 if (this.conf.loaded) {
34 print("init parser conf!?");
37 //ignoreCode: Options.n,
38 ignoreAnonymous: true, // factory: true
39 treatUnderscoredAsPrivate: true, // factory: true
40 explain: false // factory: false
43 this.symbols = new SymbolSet();
44 //this.walker = new JSDOC.Walker();
45 //JSDOC.Parser.filesSymbols = {};
51 * Parse a token stream.
52 * @param {JSDOC.TokenStream} token stream
53 * @param {String} filename
58 parse : function(ts, srcFile)
63 // not a nice way to set stuff...
65 Symbol.srcFile = (srcFile || "");
66 DocComment.shared = ""; // shared comments don't cross file boundaries
72 this.filesSymbols[Symbol.srcFile] = new SymbolSet();
74 this.walker = new Walker2(ts);
75 this.walker.buildSymbolTree()
76 //this.walker.walk(ts); // adds to our symbols
77 // throw "done sym tree";
79 // filter symbols by option
80 for (p in this.symbols._index) {
81 var symbol = this.symbols.getSymbol(p);
83 if (!symbol) continue;
85 if (symbol.is("FILE") || symbol.is("GLOBAL")) {
88 //else if (!Options.a && !symbol.comment.isUserComment) {
89 //print("Deleting Symbols (no a / user comment): " + symbol.alias);
90 //this.symbols.deleteSymbol(symbol.alias);
91 //this.filesSymbols[Symbol.srcFile].deleteSymbol(symbol.alias);
94 if (/#$/.test(symbol.alias)) { // we don't document prototypes - this should not happen..
95 // rename the symbol ??
96 /*if (!this.symbols.getSymbol(symbol.alias.substring(0,symbol.alias.length-1))) {
98 print("Renaming Symbol (got a #): " + symbol.alias);
99 var n = '' + symbol.alias;
100 this.symbols.renameSymbol( n ,n.substring(0,n-1));
101 this.filesSymbols[Symbol.srcFile].renameSymbol( n ,n.substring(0,n-1));
105 print("Deleting Symbols (got a #): " + symbol.alias);
107 this.symbols.deleteSymbol(symbol.alias);
108 this.filesSymbols[Symbol.srcFile].deleteSymbol(symbol.alias);
112 //print(prettyDump(toQDump(this.filesSymbols[Symbol.srcFile]._index,'{','}')));
113 //print("AfterParse: " + this.symbols.keys().toSource().split(",").join(",\n "));
114 return this.symbols.toArray();
118 addSymbol: function(symbol)
120 print("PARSER addSYMBOL : " + symbol.alias);
122 // if a symbol alias is documented more than once the last one with the user docs wins
123 if (this.symbols.hasSymbol(symbol.alias)) {
124 var oldSymbol = this.symbols.getSymbol(symbol.alias);
126 if (oldSymbol.comment.isUserComment && !oldSymbol.comment.hasTags) {
127 if (symbol.comment.isUserComment) { // old and new are both documented
128 Options.LOG.warn("The symbol '"+symbol.alias+"' is documented more than once.");
130 else { // old is documented but new isn't
136 // we don't document anonymous things
137 if (this.conf.ignoreAnonymous && symbol.name.match(/\$anonymous\b/)) return;
139 // uderscored things may be treated as if they were marked private, this cascades
140 if (this.conf.treatUnderscoredAsPrivate && symbol.name.match(/[.#-]_[^.#-]+$/)) {
141 symbol.isPrivate = true;
144 // -p flag is required to document private things
145 if ((symbol.isInner || symbol.isPrivate) && !Options.p) return;
147 // ignored things are not documented, this doesn't cascade
148 if (symbol.isIgnored) return;
149 // add it to the file's list... (for dumping later..)
150 if (Symbol.srcFile) {
151 this.filesSymbols[Symbol.srcFile].addSymbol(symbol);
154 this.symbols.addSymbol(symbol);
157 addBuiltin: function(name) {
159 var builtin = new Symbol(name, [], "CONSTRUCTOR", new DocComment(""));
160 builtin.isNamespace = false;
161 builtin.srcFile = "";
162 builtin.isPrivate = false;
163 this.addSymbol(builtin);
169 this.symbols.relate();
171 // make a litle report about what was found
172 if (this.conf.explain) {
173 var symbols = this.symbols.toArray();
175 for (var i = 0, l = symbols.length; i < l; i++) {
176 var symbol = symbols[i];
177 if (srcFile != symbol.srcFile) {
178 srcFile = symbol.srcFile;
179 print("\n"+srcFile+"\n-------------------");
181 print(i+":\n alias => "+symbol.alias + "\n name => "+symbol.name+ "\n isa => "+symbol.isa + "\n memberOf => " + symbol.memberOf + "\n isStatic => " + symbol.isStatic + ", isInner => " + symbol.isInner);
183 print("-------------------\n");