From: Alan Knowles <alan@akbkhome.com>
Date: Mon, 28 Jun 2010 07:49:06 +0000 (+0800)
Subject: JSDOC/Parser.js
X-Git-Url: http://git.roojs.org/?p=gnome.introspection-doc-generator;a=commitdiff_plain;h=d03d56aa054c0ca08f3aefd0ea0fe167e0a34562

JSDOC/Parser.js
---

diff --git a/JSDOC/Parser.js b/JSDOC/Parser.js
index e69de29..917c7cc 100644
--- a/JSDOC/Parser.js
+++ b/JSDOC/Parser.js
@@ -0,0 +1,186 @@
+//<script type="text/javascript">
+
+
+
+/**
+	@namespace
+	@requires JSDOC.Walker
+	@requires JSDOC.Symbol
+	@requires JSDOC.DocComment
+*/
+
+
+
+JSDOC.Parser = {
+	conf: { loaded: false },
+    
+    walker : false, // will be JSDOC.Walker()
+    symbols : false, //will be JSDOC.SymbolSet()
+    filesSymbols : { },
+    
+    /** 
+    * global init once 
+    * 
+    */
+         
+    init: function() {
+        if (this.conf.loaded) {
+            return;
+        }
+        println("init parser conf!?");
+        this.conf = {
+            loaded : true,
+            ignoreCode:               JSDOC.opt.n,
+            ignoreAnonymous:           true, // factory: true
+            treatUnderscoredAsPrivate: true, // factory: true
+            explain:                   false // factory: false
+        };
+         
+		this.symbols = new JSDOC.SymbolSet();
+		//this.walker = new JSDOC.Walker();
+        //JSDOC.Parser.filesSymbols = {};
+	},
+
+
+
+    /**
+     * Parse a token stream.
+     * @param {JSDOC.TokenStream} token stream
+     * @param {String} filename 
+         
+     */
+    
+    
+    parse : function(ts, srcFile) 
+    {
+        this.init();
+        
+        
+        // not a nice way to set stuff...
+        
+        JSDOC.Symbol.srcFile = (srcFile || "");
+        JSDOC.DocComment.shared = ""; // shared comments don't cross file boundaries
+        
+       
+        
+        
+        
+        this.filesSymbols[JSDOC.Symbol.srcFile] = new JSDOC.SymbolSet();
+        
+        this.walker = new JSDOC.Walker2(ts);
+        this.walker.buildSymbolTree()
+        //this.walker.walk(ts); // adds to our symbols
+       // throw "done sym tree";
+        
+        // filter symbols by option
+        for (p in this.symbols._index) {
+            var symbol = this.symbols.getSymbol(p);
+            
+            if (!symbol) continue;
+            
+            if (symbol.is("FILE") || symbol.is("GLOBAL")) {
+                continue;
+            }
+            else if (!JSDOC.opt.a && !symbol.comment.isUserComment) {
+                //println("Deleting Symbols (no a / user comment): " + symbol.alias);
+                //this.symbols.deleteSymbol(symbol.alias);
+                //this.filesSymbols[JSDOC.Symbol.srcFile].deleteSymbol(symbol.alias);
+            }
+            
+            if (/#$/.test(symbol.alias)) { // we don't document prototypes - this should not happen..
+                // rename the symbol ??
+                /*if (!this.symbols.getSymbol(symbol.alias.substring(0,symbol.alias.length-1))) {
+                    // rename it..
+                    println("Renaming Symbol (got  a #): " + symbol.alias);
+                    var n = '' + symbol.alias;
+                    this.symbols.renameSymbol( n ,n.substring(0,n-1));
+                    this.filesSymbols[JSDOC.Symbol.srcFile].renameSymbol( n ,n.substring(0,n-1));
+                    continue;
+                }
+                */
+                println("Deleting Symbols (got  a #): " + symbol.alias);
+                
+                this.symbols.deleteSymbol(symbol.alias);
+                this.filesSymbols[JSDOC.Symbol.srcFile].deleteSymbol(symbol.alias);
+            
+            }
+        }
+        //println(JSDOC.prettyDump(JSDOC.toQDump(this.filesSymbols[JSDOC.Symbol.srcFile]._index,'{','}')));
+        //println("AfterParse: " + this.symbols.keys().toSource().split(",").join(",\n   "));
+        return this.symbols.toArray();
+    },
+
+	
+	addSymbol: function(symbol) 
+    {
+         println("PARSER addSYMBOL : " + symbol.alias);
+        
+		// if a symbol alias is documented more than once the last one with the user docs wins
+		if (this.symbols.hasSymbol(symbol.alias)) {
+			var oldSymbol = this.symbols.getSymbol(symbol.alias);
+            
+			if (oldSymbol.comment.isUserComment && !oldSymbol.comment.hasTags) {
+				if (symbol.comment.isUserComment) { // old and new are both documented
+					JSDOC.opt.LOG.warn("The symbol '"+symbol.alias+"' is documented more than once.");
+				}
+				else { // old is documented but new isn't
+					return;
+				}
+			}
+		}
+		
+		// we don't document anonymous things
+		if (this.conf.ignoreAnonymous && symbol.name.match(/\$anonymous\b/)) return;
+
+		// uderscored things may be treated as if they were marked private, this cascades
+		if (this.conf.treatUnderscoredAsPrivate && symbol.name.match(/[.#-]_[^.#-]+$/)) {
+			symbol.isPrivate = true;
+		}
+		
+		// -p flag is required to document private things
+		if ((symbol.isInner || symbol.isPrivate) && !JSDOC.opt.p) return;
+		
+		// ignored things are not documented, this doesn't cascade
+		if (symbol.isIgnored) return;
+        // add it to the file's list... (for dumping later..)
+        if (JSDOC.Symbol.srcFile) {
+            this.filesSymbols[JSDOC.Symbol.srcFile].addSymbol(symbol);
+        }
+		
+		this.symbols.addSymbol(symbol);
+	},
+	
+	addBuiltin: function(name) {
+  
+		var builtin = new JSDOC.Symbol(name, [], "CONSTRUCTOR", new JSDOC.DocComment(""));
+		builtin.isNamespace = false;
+		builtin.srcFile = "";
+		builtin.isPrivate = false;
+        this.addSymbol(builtin);
+		return builtin;
+	},
+	
+		
+	finish: function() {
+		this.symbols.relate();		
+		
+		// make a litle report about what was found
+		if (this.conf.explain) {
+			var symbols = this.symbols.toArray();
+			var srcFile = "";
+			for (var i = 0, l = symbols.length; i < l; i++) {
+				var symbol = symbols[i];
+				if (srcFile != symbol.srcFile) {
+					srcFile = symbol.srcFile;
+					print("\n"+srcFile+"\n-------------------");
+				}
+				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);
+			}
+			print("-------------------\n");
+		}
+	}
+    
+    
+    
+
+}
\ No newline at end of file