tools/build_gtk_tree.js
[app.Builder.js] / tools / build_gtk_tree.js
1 //<script type="text/javascript">
2
3
4 /**
5  * usage:
6  * 
7  * this.data = new BuildLists();
8  * 
9  * 
10  * 
11  * 
12  * 
13  */
14 // see if we can build the insertion tree for gtk - using introspection
15
16 // it should build the tree of feasible insertions, then we will have to manually prune it..
17
18 // it needs to know
19 // a) what the inherited types are
20 // b) what methods are available for each type, that include a reference to another type..
21
22 // let's start with types.. 
23 GIRepository = imports.gi.GIRepository;
24 GLib        = imports.gi.GLib;
25
26 // we add this in, as it appears to get lost sometimes if we set it using the ENV. variable in builder.sh
27 //GIRepository.Repository.prepend_search_path(GLib.get_home_dir() + '/.Builder/girepository-1.1');
28
29
30 imports.searchPath.push('../../gnome.introspection-doc-generator');
31
32 XObject     = imports.XObject.XObject;
33 File        = imports.File.File; 
34  
35 // Introspecion specific..
36 NameSpace   = imports.Introspect.NameSpace.NameSpace; 
37 Link        = imports.Introspect.Link.Link; 
38
39
40 Array.prototype.pushUnique = function(v) {
41     if (this.indexOf(v) < 0) {
42         this.push(v);
43     }
44 }
45
46 function BuildLists () {
47  
48     
49  
50
51     var ns_list = [ 'Gtk' , 'Gdk', 'Pango', 'GtkSource', 'WebKit', 'Vte', 'GtkClutter'] ; //NameSpace.namespaces();
52      
53     ns_list = ns_list.sort();
54     // let's try and load them, so we find out early what will fail.
55     print("loading library to make sure it works.");
56
57     var classes = {};
58
59     ns_list.forEach(function(ns_name) {   
60         var  core = imports.gi[ns_name];
61         var ns = NameSpace.ns(ns_name); // fetch all the elements in namespace...
62         ns['objects'].forEach( function(n) {
63             var odata = NameSpace.factory('Class', ns_name, n);
64             classes[odata.alias] = odata;
65             
66         });
67         ns['interfaces'].forEach( function(n) {
68              var odata =NameSpace.factory('Interface', ns_name, n);
69             classes[odata.alias] = odata;
70         });
71     });
72     //print(JSON.stringify(classes['Gtk.CellRenderer'] , null, 4));
73     //print(JSON.stringify(classes['Gtk.CellRenderer'].titleType, null, 4));
74     //print(JSON.stringify(classes['Gtk.CellRenderer'].childClasses, null, 4));
75     //print(JSON.stringify(classes['Gtk.CellRenderer'].implementedBy, null, 4));
76           
77     
78
79     print("Looping throught namespaces");
80     var ns_idx = [];
81     var implementations = {};
82     
83     var methods = {};
84     var allmethods = [];  
85     
86     for (cls in classes) {
87         var odata = classes[cls];
88     
89         methods[cls] = {
90             //titleType : odata.titleType,
91             extendsClasses : [],
92             can_contain : [],
93             can_contain_using: [],
94           //  can_be_added_to : [],
95             //using_methods : { },
96             can_be_added_to_as : {}
97         };
98         odata.extendsClasses.forEach(function(child) {
99             methods[cls].extendsClasses.push(child.alias);
100         });
101         
102         implementations[odata.alias] = odata.titleType == 'Class' ? odata.childClasses :  odata.implementedBy;
103         
104     }
105     for (cls in classes) {
106         var odata = classes[cls];
107         
108        
109         
110         //print(cls);
111         //print(JSON.stringify(odata.methods,null,4));
112         odata.methods.forEach(function(m) {
113             
114             
115             
116             
117              if (!m.name.match(/^(add|pack)/)) {
118                 return;
119             }
120             //print(JSON.stringify(m,null,4));
121             m.params.forEach(function(p) {
122                  
123                 if (!p.type || typeof(classes[p.type]) == 'undefined') {
124                     return;
125                 }
126                 // now add it..
127                 //print(JSON.stringify(p));Seed.exit();
128                 var addable_type = p.type;
129                 if (addable_type.indexOf('.') < 0) {
130                     addable_type = p.memberOf + '.' + p.type;
131                 }
132                 
133                 if (m.memberOf == 'Gtk.Buildable') {
134                     return;
135                 }
136                 if (m.name =='add_mnemonic_label') {
137                     return;
138                 }
139                 // in theory you can not add a window to anything.. ???
140                 //if ('Gtk.Window' == addable_type || methods[addable_type].extendsClasses.indexOf('Gtk.Window') > -1) {
141                 //    return;
142                 //}
143         // 
144         
145                 //print(full_method_name );
146                 
147                 //if (allmethods.indexOf(full_method_name) < 0) {
148                 //    allmethods.push(full_method_name);
149                 //}
150                 
151                 methods[cls].can_contain.pushUnique(addable_type);
152                 var add = m.memberOf +':'+ m.name;
153  
154                 methods[cls].can_contain_using.pushUnique(add);
155                 //methods[cls].using_methods[m.name] = m.params;
156                 
157                 //if (methods[addable_type].can_be_added_to.indexOf(cls) < 0) { 
158                 //    methods[addable_type].can_be_added_to.push(cls);
159                 //}
160                 
161                 
162                 
163                 if (typeof(methods[addable_type].can_be_added_to_as[cls]) == 'undefined') {
164                     methods[addable_type].can_be_added_to_as[cls]=[];
165                 }
166                 methods[addable_type].can_be_added_to_as[cls].pushUnique( add );
167                 implementations[cls].forEach(function(imp) {
168                     
169                     
170                     if (typeof(methods[addable_type ].can_be_added_to_as[imp]) == 'undefined') {
171                         methods[addable_type].can_be_added_to_as[imp] = [];
172                     }
173                     
174                     methods[addable_type].can_be_added_to_as[imp].pushUnique(add);
175                      
176                     
177                 });
178                 // also needs to add
179                 //print(addable_type);
180                 //print(JSON.stringify(implementations[addable_type], null,4));
181                  
182                 
183                 implementations[addable_type].forEach(function(addable_child) {
184                     
185                     //if (addable_child == 'Gtk.AboutDialog') {
186                     //    print(JSON.stringify(methods[addable_child].extendsClasses,null,4));Seed.exit();
187                         
188                     //}
189                     
190                     if (addable_child == 'Gtk.Window' ||
191                             methods[addable_child].extendsClasses.indexOf('Gtk.Window') > -1) {
192                         return;
193                     }
194                     
195                     if (typeof(methods[addable_child].can_be_added_to_as[cls]) == 'undefined') {
196                         methods[addable_child].can_be_added_to_as[cls]=[];
197                     }
198                     methods[addable_child].can_be_added_to_as[cls].pushUnique( add );
199                     implementations[cls].forEach(function(imp) {
200                         if (typeof(methods[addable_child ].can_be_added_to_as[imp]) == 'undefined') {
201                             methods[addable_child].can_be_added_to_as[imp] = [];
202                         }
203                         
204                         methods[addable_child].can_be_added_to_as[imp].pushUnique(add);
205                          
206                         
207                     });
208                 
209                   
210                     
211                 });
212                 
213                  
214                 
215                 
216                 
217                 
218                 
219                 
220                 
221                 return;
222             /*
223                     methods[cls].using_methods[m.name] = {};
224                 }
225                 
226                 
227                 if (typeof(methods[cls][full_method_name]) == 'undefined') {
228                     methods[cls][full_method_name] = [];
229                 }
230                 if (methods[cls][full_method_name].indexOf(m.name) > -1) {
231                     return;
232                 }
233                 methods[cls][full_method_name].push(m.name);
234             */  
235             });
236             
237         });
238         //for(method in odata.methods) {
239         //    print(method.name);
240         //}
241         
242         
243     }
244     /*
245     // fill in the added to list..
246     for(var p in methods ) {
247         var odata = methods[p];
248         
249         methods[p].can_be_added_to.forEach(function(c) {
250             methods[p].can_be_added_to_as[c]=c;
251             implementations[c].forEach(function(imp) {
252                 methods[p].can_be_added_to_as[imp]=c;
253             });
254         });
255         
256         
257     }
258     */
259     // now do the reverese 'can be added to'
260     
261     
262     
263     this.methods = methods;
264     this.allmethods = methods;
265     this.implementations = implementations;
266     //print(JSON.stringify(methods,null,4));
267     // dump out a usage file..
268     
269     // basically anything that is a Gtk.Container, should be available at the top.
270     /*
271 left:
272  *top
273 right:
274         Gtk.Window 
275         Gtk.Dialog
276         Gtk.MessageDialog
277         Gtk.AboutDialog
278         Gtk.Dialog
279         Gtk.FontSelectionDialog 
280         Gtk.InputDialog 
281         Gtk.ColorSelectionDialog 
282         Gtk.FileChooserDialog
283         Gtk.Menu
284         GtkClutter.Window
285         Gtk.OffScreenWindow
286     */
287 // these should really be based on heirachy..
288     usage = {};
289     tops = {}
290     usage['*top'] = implementations['Gtk.Container'];
291     usage['*top'].forEach(function(ch) {
292         tops[ch] = [ '*top' ];
293     });
294     for(var cls in methods) {
295         if (cls =='Gtk.Builder') {
296             continue;
297         }
298         for (var par in methods[cls].can_be_added_to_as) {
299             
300             if (typeof(usage[par]) == 'undefined') {
301                 usage[par] = [];
302             }
303             usage[par].pushUnique(cls);
304             if (typeof(tops[cls]) == 'undefined') {
305                 tops[cls] = [];
306             }
307             tops[cls].pushUnique(par);
308         }
309     }
310     function canTop(cls, rec) {
311         
312         rec = rec || 0;
313         //print('CANTOP: ' + cls + ' =' + rec);
314         if (rec > 5) {
315        //     print('SKIP : ' + cls);
316         }
317         if (typeof(tops[cls]) == 'undefined') {
318             return false;
319         }
320         for (var i =0; i < tops[cls].length; i++) {
321             if (tops[cls][i] == '*top') {
322                 return true;
323             }
324             if (cls == tops[cls][i]) {
325                 continue;
326             }
327             if (canTop(tops[cls][i], rec+1)) {
328                 return true;
329             }
330         }
331         return false;
332         
333     }
334     var nusage = {};
335         var usage_left = {};
336     for(var par in usage) {
337         // see if the parent can be added to something.
338         if (!canTop(par)) {
339             continue;
340         }
341                 var duped = false;
342                 for(var dupe in usage) {
343                         if (par != dupe && usage[par].join(',') == usage[dupe].join(',') && nusage[dupe]) {
344                                 duped = true;
345                                 
346                                 if (typeof(usage_left[dupe]) == 'undefined') {
347                                         usage_left[dupe] = []; 
348                                 }
349                                 print(par+ ' is a dupe of ' + dupe);
350                                 usage_left[dupe].pushUnique(par);
351                                 break;
352                         }
353                 }
354                  if (duped) {
355                         continue;
356                  }
357         nusage[par] = usage[par];
358         
359     }
360     usage = nusage;
361     print(JSON.stringify(nusage,null,4));
362     Seed.exit();
363     //print(JSON.stringify(methods['Gtk.Switch'],null,4));
364
365     var str = [];
366         for(var par in usage) {
367                 str.push('left');
368                 str.push('   ' + par);
369                 if (typeof(usage_left[par]) != 'undefined') {
370                         usage_left[par].forEach(function(d) { str.push('    ' + d);});
371                 }
372                 str.push('right');
373                 usage[par].forEach(function(d) { str.push('    ' + d);});
374                 str.push('');
375         }
376         print(str.join("\n"));
377     //print(JSON.stringify(implementations ,null,4));
378     /*
379       methods is
380         [a class]
381             [has methods that use this object]
382                 [list of methods of the top class..]
383      
384      
385       So let's pick one..
386         TOP        ARRAY  2ND
387         Gtk.Button.add(Gtk.Widget) <<
388         
389         
390         What we need:
391         
392         A) what can this dragged element be dropped onto.
393         eg. list of parents.
394         - can_be_added_to_as (left)
395         
396         
397         
398         B) what method is available when this object is dropped onto this one.
399         
400         - get the right hand side?
401         
402         
403      
404      
405     */
406     
407     
408     //print(JSON.stringify(implementations,null,4));
409     
410 }
411 BuildLists();
412
413 // we now have a list of classes / methods that can be used..
414 // we now need a ui to flag stuff as "don't bother with"
415
416