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();
79 //this.walker.walk(ts); // adds to our symbols
80 // throw "done sym tree";
82 // filter symbols by option
83 for (p in this.symbols._index) {
84 var symbol = this.symbols.getSymbol(p);
86 print(JSON.stringify(symbol, null,4));
88 if (!symbol) continue;
90 if (symbol.is("FILE") || symbol.is("GLOBAL")) {
93 //else if (!Options.a && !symbol.comment.isUserComment) {
94 //print("Deleting Symbols (no a / user comment): " + symbol.alias);
95 //this.symbols.deleteSymbol(symbol.alias);
96 //this.filesSymbols[Symbol.srcFile].deleteSymbol(symbol.alias);
99 if (/#$/.test(symbol.alias)) { // we don't document prototypes - this should not happen..
100 // rename the symbol ??
101 /*if (!this.symbols.getSymbol(symbol.alias.substring(0,symbol.alias.length-1))) {
103 print("Renaming Symbol (got a #): " + symbol.alias);
104 var n = '' + symbol.alias;
105 this.symbols.renameSymbol( n ,n.substring(0,n-1));
106 this.filesSymbols[Symbol.srcFile].renameSymbol( n ,n.substring(0,n-1));
110 print("Deleting Symbols (got a #): " + symbol.alias);
112 this.symbols.deleteSymbol(symbol.alias);
113 this.filesSymbols[Symbol.srcFile].deleteSymbol(symbol.alias);
117 //print(prettyDump(toQDump(this.filesSymbols[Symbol.srcFile]._index,'{','}')));
118 //print("AfterParse: " + this.symbols.keys().toSource().split(",").join(",\n "));
119 return this.symbols.toArray();
123 addSymbol: function(symbol)
125 print("PARSER addSYMBOL : " + symbol.alias);
127 // if a symbol alias is documented more than once the last one with the user docs wins
128 if (this.symbols.hasSymbol(symbol.alias)) {
129 var oldSymbol = this.symbols.getSymbol(symbol.alias);
131 if (oldSymbol.comment.isUserComment && !oldSymbol.comment.hasTags) {
132 if (symbol.comment.isUserComment) { // old and new are both documented
133 Options.LOG.warn("The symbol '"+symbol.alias+"' is documented more than once.");
135 else { // old is documented but new isn't
141 // we don't document anonymous things
142 if (this.conf.ignoreAnonymous && symbol.name.match(/\$anonymous\b/)) return;
144 // uderscored things may be treated as if they were marked private, this cascades
145 if (this.conf.treatUnderscoredAsPrivate && symbol.name.match(/[.#-]_[^.#-]+$/)) {
146 symbol.isPrivate = true;
149 // -p flag is required to document private things
150 if ((symbol.isInner || symbol.isPrivate) && !Options.p) return;
152 // ignored things are not documented, this doesn't cascade
153 if (symbol.isIgnored) return;
154 // add it to the file's list... (for dumping later..)
155 if (Symbol.srcFile) {
156 this.filesSymbols[Symbol.srcFile].addSymbol(symbol);
159 this.symbols.addSymbol(symbol);
162 addBuiltin: function(name) {
164 var builtin = new Symbol(name, [], "CONSTRUCTOR", new DocComment(""));
165 builtin.isNamespace = false;
166 builtin.srcFile = "";
167 builtin.isPrivate = false;
168 this.addSymbol(builtin);
174 this.symbols.relate();
176 // make a litle report about what was found
177 if (this.conf.explain) {
178 var symbols = this.symbols.toArray();
180 for (var i = 0, l = symbols.length; i < l; i++) {
181 var symbol = symbols[i];
182 if (srcFile != symbol.srcFile) {
183 srcFile = symbol.srcFile;
184 print("\n"+srcFile+"\n-------------------");
186 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);
188 print("-------------------\n");