1 //<script type="text/javascript">
4 XObject = imports.XObject.XObject;
5 DocComment = imports.DocComment.DocComment;
6 // circular references..
7 ///Options = imports.BuildDocs.Options;
8 //Parser = imports.Parser.Parser;
9 //Symbol = imports.Symbol.Symbol;
13 SymbolSet = XObject.define(
30 for (var p in this._index) {
37 hasSymbol : function(alias) {
38 return typeof(this._index[alias]) != 'undefined';
39 //return this.keys().indexOf(alias) > -1;
42 addSymbol : function(symbol) {
43 //print("ADDING SYMBOL:"+symbol.alias.toString());
46 if (this.hasSymbol(symbol.alias)) {
47 imports.BuildDocs.Options.LOG.warn("Overwriting symbol documentation for: "+symbol.alias + ".");
49 this._index[symbol.alias] = symbol;
52 getSymbol : function(alias) {
54 if (this.hasSymbol(alias)) return this._index[alias];
58 toArray : function() {
60 for (var p in this._index) {
61 found.push(this._index[p]);
70 '*object' : 'SymbolSet',
77 deleteSymbol : function(alias) {
78 if (!this.hasSymbol(alias)) return;
79 delete this._index[alias];
82 renameSymbol : function(oldName, newName) {
83 // todo: should check if oldname or newname already exist
84 if (typeof(this._index[oldName]) == "undefined") {
85 throw "Cant rename " + oldName + " to " + newName + " As it doesnt exist";
87 this._index[newName] = this._index[oldName];
88 this.deleteSymbol(oldName);
89 this._index[newName].alias = newName;
94 this.resolveBorrows();
95 this.resolveMemberOf();
96 this.resolveAugments();
99 resolveBorrows : function() {
100 for (p in this._index) {
101 var symbol = this._index[p];
102 if (symbol.is("FILE") || symbol.is("GLOBAL")) continue;
104 var borrows = symbol.inherits;
105 for (var i = 0; i < borrows.length; i++) {
106 var borrowed = this.getSymbol(borrows[i].alias);
108 imports.BuildDocs.Options.LOG.warn("Can't borrow undocumented "+borrows[i].alias+".");
112 var borrowAsName = borrows[i].as;
113 var borrowAsAlias = borrowAsName;
115 imports.BuildDocs.Options.LOG.warn("Malformed @borrow, 'as' is required.");
119 if (borrowAsName.length > symbol.alias.length && borrowAsName.indexOf(symbol.alias) == 0) {
120 borrowAsName = borrowAsName.replace(borrowed.alias, "")
124 if (borrowAsName.charAt(0) != "#") joiner = ".";
125 borrowAsAlias = borrowed.alias + joiner + borrowAsName;
128 borrowAsName = borrowAsName.replace(/^[#.]/, "");
130 if (this.hasSymbol(borrowAsAlias)) continue;
132 var clone = borrowed.clone();
133 clone.name = borrowAsName;
134 clone.alias = borrowAsAlias;
135 this.addSymbol(clone);
140 resolveMemberOf : function() {
141 for (var p in this._index) {
142 var symbol = this.getSymbol(p);
144 if (symbol.is("FILE") || symbol.is("GLOBAL")) continue;
146 // the memberOf value was provided in the @memberOf tag
147 else if (symbol.memberOf) {
148 var parts = symbol.alias.match(new RegExp("^("+symbol.memberOf+"[.#-])(.+)$"));
150 // like foo.bar is a memberOf foo
152 symbol.memberOf = parts[1];
153 symbol.name = parts[2];
155 // like bar is a memberOf foo
157 var joiner = symbol.memberOf.charAt(symbol.memberOf.length-1);
158 if (!/[.#-]/.test(joiner)) symbol.memberOf += ".";
160 this.renameSymbol(p, symbol.memberOf + symbol.name);
163 // the memberOf must be calculated
165 var parts = symbol.alias.match(/^(.*[.#-])([^.#-]+)$/);
167 symbol.memberOf = parts[1];
168 symbol.name = parts[2];
172 // set isStatic, isInner
173 if (symbol.memberOf) {
174 switch (symbol.memberOf.charAt(symbol.memberOf.length-1)) {
176 symbol.isStatic = false;
177 symbol.isInner = false;
181 symbol.isStatic = true;
182 symbol.isInner = false;
186 symbol.isStatic = false;
187 symbol.isInner = true;
193 // unowned methods and fields belong to the global object
194 if (!symbol.is("CONSTRUCTOR") && !symbol.isNamespace && symbol.memberOf == "") {
195 symbol.memberOf = "_global_";
199 if (symbol.memberOf.match(/[.#-]$/)) {
200 symbol.memberOf = symbol.memberOf.substr(0, symbol.memberOf.length-1);
202 //print("looking for memberOf: " + symbol.memberOf + " FOR " + symbol.alias);
203 // add to parent's methods or properties list
204 if (symbol.memberOf) {
205 var container = this.getSymbol(symbol.memberOf);
207 if (SymbolSet.isBuiltin(symbol.memberOf)) {
208 container = imports.Parser.Parser.addBuiltin(symbol.memberOf);
211 // print("symbol NOT a BUILT IN - createing a container");
212 // Eg. Ext.y.z (missing y)
213 // we need to add in the missing symbol...
214 container = new imports.Symbol.Symbol(symbol.memberOf, [], "OBJECT", new DocComment(""));
215 container.isNamespace = true;
216 this.addSymbol( container );
217 // print(container.toSource());
218 //container = this.getSymbol(symbol.memberOf);
219 // fake container ... so dont ad symbols to it..
222 //LOG.warn("Can't document "+symbol.name +" as a member of undocumented symbol "+symbol.memberOf+".");
223 //LOG.warn("We only have the following symbols: \n" +
224 // this.keys.toSource());
228 if (container && !container.isNamespace) container.addMember(symbol);
233 resolveAugments : function() {
234 // does this sort out multiple extends???
235 for (var p in this._index) {
236 var symbol = this.getSymbol(p);
237 this.buildAugmentsList(symbol); /// build heirachy of inheritance...
238 if (symbol.alias == "_global_" || symbol.is("FILE")) continue;
240 var augments = symbol.augments;
241 for(var ii = 0, il = augments.length; ii < il; ii++) {
242 var contributer = this.getSymbol(augments[ii]);
247 contributer.childClasses.push(symbol.alias);
248 symbol.inheritsFrom.push(contributer.alias);
249 //if (!isUnique(symbol.inheritsFrom)) {
250 // imports.BuildDocs.Options.LOG.warn("Can't resolve augments: Circular reference: "+symbol.alias+" inherits from "+contributer.alias+" more than once.");
253 var cmethods = contributer.methods;
254 var cproperties = contributer.properties;
255 var cfgs = contributer.cfgs;
256 for (var ci = 0, cl = cmethods.length; ci < cl; ci++) {
257 symbol.inherit(cmethods[ci]);
259 for (var ci = 0, cl = cproperties.length; ci < cl; ci++) {
260 symbol.inherit(cproperties[ci]);
262 for (var ci in cfgs) {
263 symbol.addConfig(cfgs[ci]);
271 imports.BuildDocs.Options.LOG.warn("Can't augment contributer: '"+augments[ii]+"', not found. FOR: " + symbol.alias);
273 //LOG.warn("We only have the following symbols: \n" +
274 // this.keys().toSource().split(",").join(", \n"));
281 buildAugmentsList : function(symbol)
283 // basic idea is to add all the child extends to the parent.. without looping forever..
285 if (!symbol.augments.length) {
290 print("buildAugmentsList:" + symbol.alias);
291 var addAugments = function (alist, forceit) { // returns number added..
295 print("buildAugmentsList:addAugments" + alist.length);
297 for(var ii = 0; ii < alist.length; ii++) {
298 print("getAlias:" + alist[ii]);
299 if (alist[ii] == symbol.alias) {
302 var contributer = _t.getSymbol(alist[ii]);
307 if (!forceit && symbol.augments.indexOf(alist[ii]) > -1) {
310 if (symbol.augments.indexOf(alist[ii]) < 0) {
311 symbol.augments.push(alist[ii]);
315 addAugments(contributer.augments,false);
319 print("buildAugmentsList: ADDED:" + rval);
322 addAugments(symbol.augments, true);
323 //while(addAugments(symbol.augments) > 0) { }
329 SymbolSet.isBuiltin = function(name) {
330 return (SymbolSet.isBuiltin.coreObjects.indexOf(name) > -1);
332 SymbolSet.isBuiltin .coreObjects = [
333 '_global_', 'Array', 'Boolean', 'Date', 'Function',
334 'Math', 'Number', 'Object', 'RegExp', 'String'