1 //<Script type="text/javascript">
4 GIRepository = imports.gi.GIRepository;
6 console = imports.console;
7 XObject = imports.XObject.XObject;
9 Base = imports.Builder.Provider.Palete.Base.Base;
10 File = imports.File.File;
11 //----------------------- our roo verison
20 // various loader methods..
35 var data = File.read(__script_path__ +'/../GtkUsage.txt');
37 data = data.split(/\n/g);
43 data.forEach( function(d) {
44 if (!d.length || d.match(/^\s+$/) || d.match(/^\s*\//)) { //empty
47 if (d.match(/^left:/)) {
60 if (d.match(/^right:/)) {
65 left.push(d.replace(/\s+/g, ''));
68 right.push(d.replace(/\s+/g, ''));
84 commentLoad : function(ns)
87 if (typeof(this.comments[ns]) != 'undefined') {
91 console.log("LOAD DOCS: " + ns);
92 var gi = GIRepository.IRepository.get_default();
93 var ver = gi.get_version(ns);
95 this.comments[ns] = {};
100 // no idea why this is broken on my build system.
101 function getAttribute(n, name){
102 var properties = n.properties;
104 if (properties.name == name)
105 return properties.children.content;
106 properties = properties.next
112 function walk(element, path) {
119 var n = getAttribute(element, 'name') ;
120 //console.log("WALK" + n);
121 if (element.name == 'signal') {
125 path += path.length ? '.' : '';
128 if (element.name == 'return-value') {
129 path += '.return-value';
134 var d = getAttribute(element,'doc');
136 // Seed.print(path + ':' + d);
140 var child = element.children;
143 //console.log(child.tag);
144 if (child.type == "element"){
151 var pth = GIRepository.IRepository.get_search_path ();
154 var gir_path = pth[0].replace(/lib\/girepository-1.0/, 'share\/gir-1.0');
158 var fn = gir_path + '/'+ ns + '-' + ver + '.gir';
161 if (!File.exists(fn)) {
162 console.log('missing docc file ' + fn);
163 this.comments[ns] = {};
167 var doc = xml.parseFile(fn);
168 //console.log("xmldoc?" + doc);
171 this.comments[ns] = ret;
177 doc : function(what) {
178 var ns = what.split('.').shift();
179 this.commentLoad(ns);
180 return typeof(this.comments[ns][what]) == 'undefined' ? '' : this.comments[ns][what];
183 getPropertiesFor: function(ename, type)
185 print("Loading for " + ename);
187 if (typeof(this.proplist[ename]) != 'undefined') {
188 return this.proplist[ename][type];
190 // use introspection to get lists..
191 var gi = GIRepository.IRepository.get_default();
192 var es = ename.split('.');
193 var bi = gi.find_by_name(es[0], es[1]);
196 print("COULND NOT FIND BY NAME");
199 var etype = GIRepository.base_info_get_type(bi);
200 var meth = etype == GIRepository.IInfoType.INTERFACE ?
202 'interface_info_get_n_properties',
203 'interface_info_get_property',
204 'interface_info_get_n_signals',
205 'interface_info_get_signal',
206 'interface_info_get_n_methods',
207 'interface_info_get_method'
209 'object_info_get_n_properties',
210 'object_info_get_property',
211 'object_info_get_n_signals',
212 'object_info_get_signal',
213 'object_info_get_n_methods',
214 'object_info_get_method'
218 this.proplist[ename] = {}
219 this.proplist[ename]['props'] = [];
220 this.proplist[ename]['events'] = [];
221 this.proplist[ename]['methods'] = [];
222 this.proplist[ename]['inherits']= [];
224 var plist = this.proplist[ename]['props'] ;
225 var elist = this.proplist[ename]['events'];
226 var mlist = this.proplist[ename]['methods'];
227 var ilist = this.proplist[ename]['inherits'];
235 // properties.. -- and parent ones...!!!
236 for (var i =0;i < GIRepository[meth[0]](bi); i++) {
237 var prop = GIRepository[meth[1]](bi, i);
238 var n_original = GIRepository.base_info_get_name(prop);
240 var flags = GIRepository.property_info_get_flags(prop); // check for readonly..
243 var ty = this.typeToName(GIRepository.property_info_get_type(prop));
244 print (n_original +":"+ ty);
249 name : n_original.replace(/\-/g, '_'),
251 desc : this.doc(ename + '.' + n_original),
263 for (var i =0;i < GIRepository[meth[2]](bi); i++) {
264 var prop = GIRepository[meth[3]](bi, i);
265 var n_original = GIRepository.base_info_get_name(prop);
266 // print ('signal: ' + n_original);
268 name : n_original.replace(/\-/g, '_'),
269 type : 'function', //???
270 desc : this.doc(ename + '.signal.' + n_original),
271 sig : this.genSkel(prop) // fixme..
277 for (var i =0;i < GIRepository[meth[4]](bi); i++) {
278 var prop = GIRepository[meth[5]](bi, i);
279 var n_original = GIRepository.base_info_get_name(prop);
280 // print ('signal: ' + n_original);
282 name : n_original.replace(/\-/g, '_'),
283 type : 'function', //???
284 desc : this.doc(ename + '.signal.' + n_original),
286 this.genParams(prop,add);
295 if (etype == GIRepository.IInfoType.INTERFACE ) {
300 var pi = GIRepository.object_info_get_parent(bi);
305 var pname = GIRepository.base_info_get_namespace(pi) + '.' +
306 GIRepository.base_info_get_name(pi);
307 this.getPropertiesFor(pname, 'props');
310 elist.push.apply(elist,this.proplist[pname]['events']);
311 plist.push.apply(plist,this.proplist[pname]['props']);
313 ilist.push.apply(ilist,this.proplist[pname]['inherits']);
314 this.overrides(this.proplist[pname]['methods'], mlist);
319 // implements needs to be more carefull as it could add dupes..
320 // use the parent implements list to ensure no dupes..
321 for(var i =0; i < GIRepository.object_info_get_n_interfaces(bi); i++) {
323 var prop = GIRepository.object_info_get_interface(bi,i);
324 var iface = GIRepository.base_info_get_namespace(prop) +'.'+
325 GIRepository.base_info_get_name(prop);
326 if ( ilist.indexOf(iface) > -1) {
329 this.getPropertiesFor(iface, 'props'); // just load one of them..
332 elist.push.apply(elist,this.proplist[iface]['events']);
333 plist.push.apply(plist,this.proplist[iface]['props']);
334 this.overrides(this.proplist[pname]['methods'], mlist);
336 function sfunc(a,b) {
337 if (a.name == b.name) return 0;
338 return a.name > b.name ? 1 : -1
344 return this.proplist[ename][type];
347 genParams: function(sig, meth)
351 meth.ret_type = this.typeToName(GIRepository.callable_info_get_return_type(sig));
352 // might be a numbeR??
354 for(var a_i =0; a_i < GIRepository.callable_info_get_n_args(sig); a_i++) {
355 var arg = GIRepository.callable_info_get_arg(sig, a_i);
358 name : GIRepository.base_info_get_name(arg),
359 type : this.typeToName(GIRepository.property_info_get_type(arg), true)
367 genSkel: function(sig) // should really use genParams...
371 var ret_type = this.typeToName(GIRepository.callable_info_get_return_type(sig));
372 // might be a numbeR??
373 if (ret_type == 'boolean') {
374 ret = " return false;\n";
376 for(var a_i =0; a_i < GIRepository.callable_info_get_n_args(sig); a_i++) {
377 var arg = GIRepository.callable_info_get_arg(sig, a_i);
379 args.push(GIRepository.base_info_get_name(arg));
381 return 'function (' + args.join(', ') + ") {\n" + ret + "}";
386 typeToName : function (type_info, allow_iface) // find type for properties or arguments.
388 var ty = GIRepository.type_tag_to_string( GIRepository.type_info_get_tag(type_info));
390 if ((ty == 'void') && GIRepository.type_info_is_pointer(type_info)) {
394 return false; // unspported
396 if (ty != 'interface') {
399 // we can accept enum types here..
400 var interface_info = GIRepository.type_info_get_interface (type_info);
401 var interface_type = GIRepository.base_info_get_type (interface_info);
403 if (!allow_iterface && interface_type != GIRepository.IInfoType.ENUM) {
406 return GIRepository.base_info_get_namespace(interface_info) + '.' +
407 GIRepository.base_info_get_name(interface_info);
411 * merge two proprety arrays' ignoring what's overrriden.
416 overrides : function (top, bottom)
420 return top.every(function(t) {
421 if (t.name == b.name) {
426 bottom.forEach(function(e) {
438 findType : function (data, prop, value)
441 if ((prop == '|xns') || (prop == 'xtype')) {
445 var qname = this.guessName(data);
446 if (prop[0] == '|') {
447 prop= prop.substring(1);
450 var prs = this.getPropertiesFor(qname, 'props');
452 prs.forEach(function(e) {
456 if (e.name == prop) {
462 return Base.prototype.findType(data, prop,value);
469 findOptions : function(ename)
472 var es = ename.split('.');
474 return Base.prototype.findOptions(ename);
476 var gi = GIRepository.IRepository.get_default();
477 var bi = gi.find_by_name(es[0], es[1]);
478 var etype = GIRepository.base_info_get_type(bi);
479 if (etype != GIRepository.IInfoType.ENUM) {
480 console.log("Options not handled yet!!!");
484 // got an enum.. let's return the values..
485 for(var i =0; i < GIRepository.enum_info_get_n_values(bi); i++) {
487 var prop = GIRepository.enum_info_get_value(bi,i);
490 ret.push( ename + '.' + GIRepository.base_info_get_name(prop).toUpperCase() )
495 * determine the packing types..
497 getDefaultPack: function(pname, cname) {
498 var list = this.getPackingList(pname,cname);
500 if (!list.every(function(e) { return e.name =='add'; })) {
501 return 'add'; // add is in our list..?? what about args..?!?
505 e.params.forEach(function(p,i) {
506 if (ret == false) { return; } // skip broken..
507 if (i==0) { return; } // skip first..
508 if (p.type == 'boolean') {
512 if (p.type == 'number') {
516 ret = false; // invalid!
521 list.every(function(e) {
523 if (packret !== false) {
528 // should we do best match..?
534 getPackingList :function (pname, cname)
536 var funcs = this.getPropertiesFor(pname,'methods');
539 // let's assume top down...
540 var inherits = [ cname ];
541 inherits.push.apply(inherits, this.getPropertiesFor(cname,'inherits'));
542 funcs.forEach(function(m) {
543 if (m.params.length && (typeof(m.params[0].type) == 'string') &&
544 inherits.indexOf(m.params[0].type) > -1) {