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());
45 if (this.hasSymbol(symbol.alias)) {
46 imports.BuildDocs.Options.LOG.warn("Overwriting symbol documentation for: "+symbol.alias + ".");
48 this._index[symbol.alias] = symbol;
51 getSymbol : function(alias) {
53 if (this.hasSymbol(alias)) return this._index[alias];
57 toArray : function() {
59 for (var p in this._index) {
60 found.push(this._index[p]);
67 toObject : function() {
69 for (var p in this._index) {
70 ret[p] = this._index[p].toObject();
76 deleteSymbol : function(alias) {
77 if (!this.hasSymbol(alias)) return;
78 delete this._index[alias];
81 renameSymbol : function(oldName, newName) {
82 // todo: should check if oldname or newname already exist
83 if (typeof(this._index[oldName]) == "undefined") {
84 throw "Cant rename " + oldName + " to " + newName + " As it doesnt exist";
86 this._index[newName] = this._index[oldName];
87 this.deleteSymbol(oldName);
88 this._index[newName].alias = newName;
93 this.resolveBorrows();
94 this.resolveMemberOf();
95 this.resolveAugments();
98 resolveBorrows : function() {
99 for (p in this._index) {
100 var symbol = this._index[p];
101 if (symbol.is("FILE") || symbol.is("GLOBAL")) continue;
103 var borrows = symbol.inherits;
104 for (var i = 0; i < borrows.length; i++) {
105 var borrowed = this.getSymbol(borrows[i].alias);
107 imports.BuildDocs.Options.LOG.warn("Can't borrow undocumented "+borrows[i].alias+".");
111 var borrowAsName = borrows[i].as;
112 var borrowAsAlias = borrowAsName;
114 imports.BuildDocs.Options.LOG.warn("Malformed @borrow, 'as' is required.");
118 if (borrowAsName.length > symbol.alias.length && borrowAsName.indexOf(symbol.alias) == 0) {
119 borrowAsName = borrowAsName.replace(borrowed.alias, "")
123 if (borrowAsName.charAt(0) != "#") joiner = ".";
124 borrowAsAlias = borrowed.alias + joiner + borrowAsName;
127 borrowAsName = borrowAsName.replace(/^[#.]/, "");
129 if (this.hasSymbol(borrowAsAlias)) continue;
131 var clone = borrowed.clone();
132 clone.name = borrowAsName;
133 clone.alias = borrowAsAlias;
134 this.addSymbol(clone);
139 resolveMemberOf : function() {
140 for (var p in this._index) {
141 var symbol = this.getSymbol(p);
143 if (symbol.is("FILE") || symbol.is("GLOBAL")) continue;
145 // the memberOf value was provided in the @memberOf tag
146 else if (symbol.memberOf) {
147 var parts = symbol.alias.match(new RegExp("^("+symbol.memberOf+"[.#-])(.+)$"));
149 // like foo.bar is a memberOf foo
151 symbol.memberOf = parts[1];
152 symbol.name = parts[2];
154 // like bar is a memberOf foo
156 var joiner = symbol.memberOf.charAt(symbol.memberOf.length-1);
157 if (!/[.#-]/.test(joiner)) symbol.memberOf += ".";
159 this.renameSymbol(p, symbol.memberOf + symbol.name);
162 // the memberOf must be calculated
164 var parts = symbol.alias.match(/^(.*[.#-])([^.#-]+)$/);
166 symbol.memberOf = parts[1];
167 symbol.name = parts[2];
171 // set isStatic, isInner
172 if (symbol.memberOf) {
173 switch (symbol.memberOf.charAt(symbol.memberOf.length-1)) {
175 symbol.isStatic = false;
176 symbol.isInner = false;
180 symbol.isStatic = true;
181 symbol.isInner = false;
185 symbol.isStatic = false;
186 symbol.isInner = true;
192 // unowned methods and fields belong to the global object
193 if (!symbol.is("CONSTRUCTOR") && !symbol.isNamespace && symbol.memberOf == "") {
194 symbol.memberOf = "_global_";
198 if (symbol.memberOf.match(/[.#-]$/)) {
199 symbol.memberOf = symbol.memberOf.substr(0, symbol.memberOf.length-1);
201 //print("looking for memberOf: " + symbol.memberOf + " FOR " + symbol.alias);
202 // add to parent's methods or properties list
203 if (symbol.memberOf) {
204 var container = this.getSymbol(symbol.memberOf);
206 if (SymbolSet.isBuiltin(symbol.memberOf)) {
207 container = imports.Parser.Parser.addBuiltin(symbol.memberOf);
210 // print("symbol NOT a BUILT IN - createing a container");
211 // Eg. Ext.y.z (missing y)
212 // we need to add in the missing symbol...
213 container = new imports.Symbol.Symbol(symbol.memberOf, [], "OBJECT", new DocComment(""));
214 container.isNamespace = true;
215 this.addSymbol( container );
216 // print(container.toSource());
217 //container = this.getSymbol(symbol.memberOf);
218 // fake container ... so dont ad symbols to it..
221 //LOG.warn("Can't document "+symbol.name +" as a member of undocumented symbol "+symbol.memberOf+".");
222 //LOG.warn("We only have the following symbols: \n" +
223 // this.keys.toSource());
227 if (container && !container.isNamespace) container.addMember(symbol);
232 resolveAugments : function() {
233 // does this sort out multiple extends???
234 for (var p in this._index) {
235 var symbol = this.getSymbol(p);
236 this.buildAugmentsList(symbol); /// build heirachy of inheritance...
237 if (symbol.alias == "_global_" || symbol.is("FILE")) continue;
239 var augments = symbol.augments;
240 for(var ii = 0, il = augments.length; ii < il; ii++) {
241 var contributer = this.getSymbol(augments[ii]);
246 contributer.childClasses.push(symbol.alias);
247 symbol.inheritsFrom.push(contributer.alias);
248 if (!isUnique(symbol.inheritsFrom)) {
249 imports.BuildDocs.Options.LOG.warn("Can't resolve augments: Circular reference: "+symbol.alias+" inherits from "+contributer.alias+" more than once.");
252 var cmethods = contributer.methods;
253 var cproperties = contributer.properties;
254 var cfgs = contributer.cfgs;
255 for (var ci = 0, cl = cmethods.length; ci < cl; ci++) {
256 symbol.inherit(cmethods[ci]);
258 for (var ci = 0, cl = cproperties.length; ci < cl; ci++) {
259 symbol.inherit(cproperties[ci]);
261 for (var ci in cfgs) {
262 symbol.addConfig(cfgs[ci]);
270 imports.BuildDocs.Options.LOG.warn("Can't augment contributer: '"+augments[ii]+"', not found. FOR: " + symbol.alias);
272 //LOG.warn("We only have the following symbols: \n" +
273 // this.keys().toSource().split(",").join(", \n"));
280 buildAugmentsList : function(symbol)
282 // basic idea is to add all the child extends to the parent.. without looping forever..
284 if (!symbol.augments.length) {
289 print("buildAugmentsList:" + symbol.alias);
290 var addAugments = function (alist, forceit) { // returns number added..
294 print("buildAugmentsList:addAugments" + alist.length);
296 for(var ii = 0; ii < alist.length; ii++) {
297 print("getAlias:" + alist[ii]);
298 if (alist[ii] == symbol.alias) {
301 var contributer = _t.getSymbol(alist[ii]);
306 if (!forceit && symbol.augments.indexOf(alist[ii]) > -1) {
309 if (symbol.augments.indexOf(alist[ii]) < 0) {
310 symbol.augments.push(alist[ii]);
314 addAugments(contributer.augments,false);
318 print("buildAugmentsList: ADDED:" + rval);
321 addAugments(symbol.augments, true);
322 //while(addAugments(symbol.augments) > 0) { }
328 SymbolSet.isBuiltin = function(name) {
329 return (SymbolSet.isBuiltin.coreObjects.indexOf(name) > -1);
331 SymbolSet.isBuiltin .coreObjects = [
332 '_global_', 'Array', 'Boolean', 'Date', 'Function',
333 'Math', 'Number', 'Object', 'RegExp', 'String'