1 //<script type="text/javascript">
4 XObject = imports.XObject.XObject;
5 ///Options = imports.BuildDocs.Options;
6 Parser = imports.Parser.Parser;
7 Symbol = imports.Symbol.Symbol;
8 DocComment = imports.DocComment.DocComment;
11 SymbolSet = XObject.define(
24 for (var p in this._index) {
31 hasSymbol : function(alias) {
32 return this.keys().indexOf(alias) > -1;
35 addSymbol : function(symbol) {
36 print("ADDING SYMBOL:"+symbol.alias.toString());
38 if (this.hasSymbol(symbol.alias)) {
39 imports.BuildDocs.Options.LOG.warn("Overwriting symbol documentation for: "+symbol.alias + ".");
41 this._index[symbol.alias] = symbol;
44 getSymbol : function(alias) {
46 if (this.hasSymbol(alias)) return this._index[alias];
50 toArray : function() {
52 for (var p in this._index) {
53 found.push(this._index[p]);
58 deleteSymbol : function(alias) {
59 if (!this.hasSymbol(alias)) return;
60 delete this._index[alias];
63 renameSymbol : function(oldName, newName) {
64 // todo: should check if oldname or newname already exist
65 if (typeof(this._index[oldName]) == "undefined") {
66 throw "Cant rename " + oldName + " to " + newName + " As it doesnt exist";
68 this._index[newName] = this._index[oldName];
69 this.deleteSymbol(oldName);
70 this._index[newName].alias = newName;
75 this.resolveBorrows();
76 this.resolveMemberOf();
77 this.resolveAugments();
80 resolveBorrows : function() {
81 for (p in this._index) {
82 var symbol = this._index[p];
83 if (symbol.is("FILE") || symbol.is("GLOBAL")) continue;
85 var borrows = symbol.inherits;
86 for (var i = 0; i < borrows.length; i++) {
87 var borrowed = this.getSymbol(borrows[i].alias);
89 imports.BuildDocs.Options.LOG.warn("Can't borrow undocumented "+borrows[i].alias+".");
93 var borrowAsName = borrows[i].as;
94 var borrowAsAlias = borrowAsName;
96 imports.BuildDocs.Options.LOG.warn("Malformed @borrow, 'as' is required.");
100 if (borrowAsName.length > symbol.alias.length && borrowAsName.indexOf(symbol.alias) == 0) {
101 borrowAsName = borrowAsName.replace(borrowed.alias, "")
105 if (borrowAsName.charAt(0) != "#") joiner = ".";
106 borrowAsAlias = borrowed.alias + joiner + borrowAsName;
109 borrowAsName = borrowAsName.replace(/^[#.]/, "");
111 if (this.hasSymbol(borrowAsAlias)) continue;
113 var clone = borrowed.clone();
114 clone.name = borrowAsName;
115 clone.alias = borrowAsAlias;
116 this.addSymbol(clone);
121 resolveMemberOf : function() {
122 for (var p in this._index) {
123 var symbol = this.getSymbol(p);
125 if (symbol.is("FILE") || symbol.is("GLOBAL")) continue;
127 // the memberOf value was provided in the @memberOf tag
128 else if (symbol.memberOf) {
129 var parts = symbol.alias.match(new RegExp("^("+symbol.memberOf+"[.#-])(.+)$"));
131 // like foo.bar is a memberOf foo
133 symbol.memberOf = parts[1];
134 symbol.name = parts[2];
136 // like bar is a memberOf foo
138 var joiner = symbol.memberOf.charAt(symbol.memberOf.length-1);
139 if (!/[.#-]/.test(joiner)) symbol.memberOf += ".";
141 this.renameSymbol(p, symbol.memberOf + symbol.name);
144 // the memberOf must be calculated
146 var parts = symbol.alias.match(/^(.*[.#-])([^.#-]+)$/);
148 symbol.memberOf = parts[1];
149 symbol.name = parts[2];
153 // set isStatic, isInner
154 if (symbol.memberOf) {
155 switch (symbol.memberOf.charAt(symbol.memberOf.length-1)) {
157 symbol.isStatic = false;
158 symbol.isInner = false;
162 symbol.isStatic = true;
163 symbol.isInner = false;
167 symbol.isStatic = false;
168 symbol.isInner = true;
174 // unowned methods and fields belong to the global object
175 if (!symbol.is("CONSTRUCTOR") && !symbol.isNamespace && symbol.memberOf == "") {
176 symbol.memberOf = "_global_";
180 if (symbol.memberOf.match(/[.#-]$/)) {
181 symbol.memberOf = symbol.memberOf.substr(0, symbol.memberOf.length-1);
183 //print("looking for memberOf: " + symbol.memberOf + " FOR " + symbol.alias);
184 // add to parent's methods or properties list
185 if (symbol.memberOf) {
186 var container = this.getSymbol(symbol.memberOf);
188 if (SymbolSet.isBuiltin(symbol.memberOf)) {
189 container = Parser.addBuiltin(symbol.memberOf);
192 // print("symbol NOT a BUILT IN - createing a container");
193 // Eg. Ext.y.z (missing y)
194 // we need to add in the missing symbol...
195 container = new Symbol(symbol.memberOf, [], "OBJECT", new DocComment(""));
196 container.isNamespace = true;
197 this.addSymbol( container );
198 // print(container.toSource());
199 //container = this.getSymbol(symbol.memberOf);
200 // fake container ... so dont ad symbols to it..
203 //LOG.warn("Can't document "+symbol.name +" as a member of undocumented symbol "+symbol.memberOf+".");
204 //LOG.warn("We only have the following symbols: \n" +
205 // this.keys.toSource());
209 if (container && !container.isNamespace) container.addMember(symbol);
214 resolveAugments : function() {
215 // does this sort out multiple extends???
216 for (var p in this._index) {
217 var symbol = this.getSymbol(p);
218 this.buildAugmentsList(symbol); /// build heirachy of inheritance...
219 if (symbol.alias == "_global_" || symbol.is("FILE")) continue;
221 var augments = symbol.augments;
222 for(var ii = 0, il = augments.length; ii < il; ii++) {
223 var contributer = this.getSymbol(augments[ii]);
228 contributer.childClasses.push(symbol.alias);
229 symbol.inheritsFrom.push(contributer.alias);
230 if (!isUnique(symbol.inheritsFrom)) {
231 imports.BuildDocs.Options.LOG.warn("Can't resolve augments: Circular reference: "+symbol.alias+" inherits from "+contributer.alias+" more than once.");
234 var cmethods = contributer.methods;
235 var cproperties = contributer.properties;
236 var cfgs = contributer.cfgs;
237 for (var ci = 0, cl = cmethods.length; ci < cl; ci++) {
238 symbol.inherit(cmethods[ci]);
240 for (var ci = 0, cl = cproperties.length; ci < cl; ci++) {
241 symbol.inherit(cproperties[ci]);
243 for (var ci in cfgs) {
244 symbol.addConfig(cfgs[ci]);
252 imports.BuildDocs.Options.LOG.warn("Can't augment contributer: '"+augments[ii]+"', not found. FOR: " + symbol.alias);
254 //LOG.warn("We only have the following symbols: \n" +
255 // this.keys().toSource().split(",").join(", \n"));
262 buildAugmentsList : function(symbol)
264 // basic idea is to add all the child extends to the parent.. without looping forever..
266 if (!symbol.augments.length) {
271 print("buildAugmentsList:" + symbol.alias);
272 var addAugments = function (alist, forceit) { // returns number added..
276 print("buildAugmentsList:addAugments" + alist.length);
278 for(var ii = 0; ii < alist.length; ii++) {
279 print("getAlias:" + alist[ii]);
280 if (alist[ii] == symbol.alias) {
283 var contributer = _t.getSymbol(alist[ii]);
288 if (!forceit && symbol.augments.indexOf(alist[ii]) > -1) {
291 if (symbol.augments.indexOf(alist[ii]) < 0) {
292 symbol.augments.push(alist[ii]);
296 addAugments(contributer.augments,false);
300 print("buildAugmentsList: ADDED:" + rval);
303 addAugments(symbol.augments, true);
304 //while(addAugments(symbol.augments) > 0) { }
309 SymbolSet.isBuiltin = function(name) {
310 return (SymbolSet.isBuiltin.coreObjects.indexOf(name) > -1);
312 SymbolSet.isBuiltin .coreObjects = [
313 '_global_', 'Array', 'Boolean', 'Date', 'Function',
314 'Math', 'Number', 'Object', 'RegExp', 'String'