JsTemplate/Link.js
[gnome.introspection-doc-generator] / JsTemplate / Link.js
1 //<script type="text/javascript">
2
3 XObject  = imports.XObject.XObject;
4
5 /**
6  * Generic Template Link handler..
7  * 
8  * 
9  * 
10  */
11
12 /** Handle the creation of HTML links to documented symbols.
13         @constructor
14 */
15 Link = XObject.define(
16     /*
17     * constructor
18     */ 
19     function (opts) {
20         XObject.extend(this,opts);
21         
22     }, 
23     Object,
24     {
25         
26          /**
27          * url {String} url for link..
28          */
29         url: "",
30         /**
31          * text {String} text to show on link.
32          */
33         
34         text : "",
35         
36         /**
37          * alias {String} not sure?
38          */
39         alias : "",
40         /**
41          * src {String} not sure?
42          */
43         src : "",
44         file : "",
45         
46         innerName : "",
47         classLink : false,
48         targetName : "",
49     
50         
51         
52         target : function(targetName) {
53             if (typeof(targetName) != 'undefined') this.targetName = targetName;
54             return this;
55         },
56         inner : function(inner) {
57             if (typeof(inner) != 'undefined') this.innerName = inner;
58             return this;
59         },
60         withText : function(text) {
61             if (typeof(text) != 'undefined') this.text = text;
62             return this;
63         },
64         toSrc : function(filename) {
65             if (typeof(filename) != 'undefined') this.src = filename;
66             
67             return this;
68         },
69         toSymbol : function(alias) {
70             if (typeof(alias) != 'undefined') {
71                 this.alias = new String(alias);
72             }
73             return this;
74         },
75         toClass : function(alias) {
76             this.classLink = true;
77             return this.toSymbol(alias);
78         },
79         toFile : function(file) {
80             if (typeof(file) != 'undefined') this.file = file;
81             return this;
82         },
83         
84         toString : function() {
85     
86             var thisLink = this;
87
88             if (this.alias) {
89                 return  this.alias.replace(/(^|[^a-z$0-9_#.:-])([|a-z$0-9_#.:-]+)($|[^a-z$0-9_#.:-])/i,
90                     function(match, prematch, symbolName, postmatch) {
91                         var symbolNames = symbolName.split("|");
92                         var links = [];
93                         for (var i = 0, l = symbolNames.length; i < l; i++) {
94                             thisLink.alias = symbolNames[i];
95                             links.push(thisLink._makeSymbolLink(symbolNames[i]));
96                         }
97                         return prematch+links.join("|")+postmatch;
98                     }
99                 );
100             }
101             if (this.url) {
102                 return thisLink._makeLink(this.url);
103             }
104             if (this.src) {
105                 return thisLink._makeSrcLink(this.src);
106             }
107             if (this.file) {
108                 return thisLink._makeFileLink(this.file);
109             }
110
111         },
112         
113         
114         
115         
116         
117         
118         
119         /** Create a link to a snother symbol. */
120         _makeSymbolLink : function(alias) {
121             
122             // look for '/' in alias..
123             if (/\//.test(alias)) {
124                 var bits = alias.split('/');
125                 var ret = "";
126                 for(var i=0; i < bits.length; i++) {
127                     if (i > 0) {
128                         ret +="/";
129                     }
130                     ret += this._makeSymbolLink(bits[i]);
131                 }
132                 return ret;
133                 
134             }
135             
136             
137             
138             var linkBase = './';
139             var linkTo = Link.symbolSet.getSymbol(alias);
140             var linkPath;
141             var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
142             
143             // is it an internal link?
144             if (alias.charAt(0) == "#") {
145                 linkPath = alias;
146                 fullLinkPath = alias;
147             
148             // if there is no symbol by that name just return the name unaltered
149             } else if (!linkTo) {
150                 
151                 if (typeof(Link.builtins[alias]) != 'undefined') {
152                     return "<a href=\""+ Link.builtins[alias]+"\""+target+">"+alias+"</a>";
153                  }
154                 
155                 return this.text || alias;
156             
157             
158             // it's a symbol in another file
159             } else {
160
161                 if (!linkTo.is("CONSTRUCTOR") && !linkTo.isNamespace) { // it's a method or property
162                     linkPath = escape(linkTo.memberOf) || "_global_";
163                     linkPath += imports.JSDOC.Options.Options.ext + "#" + Link.symbolNameToLinkName(linkTo);
164                 }
165                 else {
166                     linkPath = escape(linkTo.alias);
167                     linkPath += imports.JSDOC.Options.Options.ext + (this.classLink? "":"#" + Link.hashPrefix + "constructor");
168                 }
169                 //linkPath = linkBase + linkPath;
170                 fullLinkPath = linkBase + linkPath;
171             }
172             
173             var linkText = this.text || alias;
174             
175             var link = {linkPath: linkPath, linkText: linkText, fullLinkPath: fullLinkPath};
176             
177             //if (typeof JSDOC.PluginManager != "undefined") {
178             //    JSDOC.PluginManager.run("onSymbolLink", link);
179             //}
180             
181             return "<a href=\""+link.fullLinkPath+"\""+target+" roo:cls=\""+link.linkPath+"\">"+link.linkText+"</a>";
182         },
183
184
185         /** Create a link to a source file. */
186         _makeSrcLink : function(srcFilePath) {
187             var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
188                 
189             // transform filepath into a filename
190             var srcFile = srcFilePath.replace(/\.\.?[\\\/]/g, "").replace(/[:\\\/]/g, "."); // was _
191             var lsrcFile = srcFilePath.replace(/\.\.?[\\\/]/g, "").replace(/[:\\\/]/g, ".");
192             var outFilePath = Link.base + '/symbols/' +  srcFile.replace(/.js$/, '') + 
193                 imports.JSDOC.Options.Options.publishExt;
194             
195             if (!this.text) this.text = srcFilePath; //FilePath.fileName(srcFilePath);
196             return "<a href=\""+outFilePath+"\""+target+" roo:cls=\"src/"+lsrcFile+"\">"+this.text+"</a>";
197         },
198
199         /** Create a link to a source file. */
200         _makeFileLink : function(filePath) {
201             var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
202                 
203             var outFilePath =  Link.base + filePath;
204
205             if (!this.text) this.text = filePath;
206             return "<a href=\""+outFilePath+"\""+target+">"+this.text+"</a>";
207         },
208         
209           /** very basic link... */
210         _makeLink : function(url) {
211             var target = (this.targetName)? " target=\""+this.targetName+"\"" : "";
212              
213             if (!this.text) this.text = url;
214             return "<a href=\""+url+"\""+target+">"+this.text+"</a>";
215         }
216         
217 });
218
219
220
221
222 /** prefixed for hashes */
223 Link.hashPrefix = "";
224
225 /** Appended to the front of relative link paths. */
226 Link.base = "";
227
228 Link.symbolNameToLinkName = function(symbol) {
229         var linker = "";
230         if (symbol.isStatic) linker = ".";
231         else if (symbol.isInner) linker = "-";
232         
233         return Link.hashPrefix+linker+symbol.name;
234 }
235
236
237 Link.builtins = {
238     'Object' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object',
239     'Object...' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object',
240     'Function' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Function',
241     'String' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:String',
242     'Number' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Number',
243     'Boolean' : 'http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean',
244     'HTMLElement' : 'http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037'
245 }
246     
247