b5e1e8825ce03a178e032e31fd64e42bb1c189be
[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'] ; //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_be_added_to : [],
94             //using_methods : { },
95             can_be_added_to_as : {}
96         };
97         odata.extendsClasses.forEach(function(child) {
98             methods[cls].extendsClasses.push(child.alias);
99         });
100         
101         implementations[odata.alias] = odata.titleType == 'Class' ? odata.childClasses :  odata.implementedBy;
102         
103     }
104     for (cls in classes) {
105         var odata = classes[cls];
106         
107        
108         
109         //print(cls);
110         //print(JSON.stringify(odata.methods,null,4));
111         odata.methods.forEach(function(m) {
112             
113             
114             
115             
116              if (!m.name.match(/^(add|pack)/)) {
117                 return;
118             }
119             //print(JSON.stringify(m,null,4));
120             m.params.forEach(function(p) {
121                  
122                 if (!p.type || typeof(classes[p.type]) == 'undefined') {
123                     return;
124                 }
125                 // now add it..
126                 //print(JSON.stringify(p));Seed.exit();
127                 var addable_type = p.type;
128                 if (addable_type.indexOf('.') < 0) {
129                     addable_type = p.memberOf + '.' + p.type;
130                 }
131                 
132                 
133                
134                 // in theory you can not add a window to anything.. ???
135                 //if ('Gtk.Window' == addable_type || methods[addable_type].extendsClasses.indexOf('Gtk.Window') > -1) {
136                 //    return;
137                 //}
138         // 
139         
140                 //print(full_method_name );
141                 
142                 //if (allmethods.indexOf(full_method_name) < 0) {
143                 //    allmethods.push(full_method_name);
144                 //}
145                 
146                 methods[cls].can_contain.pushUnique(addable_type);
147                 
148                 //methods[cls].using_methods[m.name] = m.params;
149                 
150                 //if (methods[addable_type].can_be_added_to.indexOf(cls) < 0) { 
151                 //    methods[addable_type].can_be_added_to.push(cls);
152                 //}
153                 
154                 
155                 var add = m.memberOf +':'+ m.name;
156                 
157                 if (typeof(methods[addable_type].can_be_added_to_as[cls]) == 'undefined') {
158                     methods[addable_type].can_be_added_to_as[cls]=[];
159                 }
160                 methods[addable_type].can_be_added_to_as[cls].pushUnique( add );
161                 implementations[cls].forEach(function(imp) {
162                     
163                     
164                     if (typeof(methods[addable_type ].can_be_added_to_as[imp]) == 'undefined') {
165                         methods[addable_type].can_be_added_to_as[imp] = [];
166                     }
167                     
168                     methods[addable_type].can_be_added_to_as[imp].pushUnique(add);
169                      
170                     
171                 });
172                 // also needs to add
173                 //print(addable_type);
174                 //print(JSON.stringify(implementations[addable_type], null,4));
175                  
176                 
177                 implementations[addable_type].forEach(function(addable_child) {
178                     
179                     //if (addable_child == 'Gtk.AboutDialog') {
180                     //    print(JSON.stringify(methods[addable_child].extendsClasses,null,4));Seed.exit();
181                         
182                     //}
183                     
184                     if (addable_child == 'Gtk.Window' ||
185                             methods[addable_child].extendsClasses.indexOf('Gtk.Window') > -1) {
186                         return;
187                     }
188                     
189                     if (typeof(methods[addable_child].can_be_added_to_as[cls]) == 'undefined') {
190                         methods[addable_child].can_be_added_to_as[cls]=[];
191                     }
192                     methods[addable_child].can_be_added_to_as[cls].pushUnique( add );
193                     implementations[cls].forEach(function(imp) {
194                         if (typeof(methods[addable_child ].can_be_added_to_as[imp]) == 'undefined') {
195                             methods[addable_child].can_be_added_to_as[imp] = [];
196                         }
197                         
198                         methods[addable_child].can_be_added_to_as[imp].pushUnique(add);
199                          
200                         
201                     });
202                 
203                   
204                     
205                 });
206                 
207                  
208                 
209                 
210                 
211                 
212                 
213                 
214                 
215                 return;
216             /*
217                     methods[cls].using_methods[m.name] = {};
218                 }
219                 
220                 
221                 if (typeof(methods[cls][full_method_name]) == 'undefined') {
222                     methods[cls][full_method_name] = [];
223                 }
224                 if (methods[cls][full_method_name].indexOf(m.name) > -1) {
225                     return;
226                 }
227                 methods[cls][full_method_name].push(m.name);
228             */  
229             });
230             
231         });
232         //for(method in odata.methods) {
233         //    print(method.name);
234         //}
235         
236         
237     }
238     /*
239     // fill in the added to list..
240     for(var p in methods ) {
241         var odata = methods[p];
242         
243         methods[p].can_be_added_to.forEach(function(c) {
244             methods[p].can_be_added_to_as[c]=c;
245             implementations[c].forEach(function(imp) {
246                 methods[p].can_be_added_to_as[imp]=c;
247             });
248         });
249         
250         
251     }
252     */
253     // now do the reverese 'can be added to'
254     
255     
256     
257     this.methods = methods;
258     this.allmethods = methods;
259     this.implementations = implementations;
260     //print(JSON.stringify(methods,null,4));
261     // dump out a usage file..
262     
263     // basically anything that is a Gtk.Container, should be available at the top.
264     /*
265 left:
266  *top
267 right:
268         Gtk.Window 
269         Gtk.Dialog
270         Gtk.MessageDialog
271         Gtk.AboutDialog
272         Gtk.Dialog
273         Gtk.FontSelectionDialog 
274         Gtk.InputDialog 
275         Gtk.ColorSelectionDialog 
276         Gtk.FileChooserDialog
277         Gtk.Menu
278         GtkClutter.Window
279         Gtk.OffScreenWindow
280     */
281 // these should really be based on heirachy..
282     usage = {};
283     tops = {}
284     usage['*top'] = implementations['Gtk.Container'];
285     usage['*top'].forEach(function(ch) {
286         tops[ch] = [ '*top' ];
287     });
288     for(var cls in methods) {
289         for (var par in methods[cls].can_be_added_to_as) {
290             if (typeof(usage[par]) == 'undefined') {
291                 usage[par] = [];
292             }
293             usage[par].pushUnique(cls);
294             if (typeof(tops[cls]) == 'undefined') {
295                 tops[cls] = [];
296             }
297             tops[cls].pushUnique(par);
298         }
299     }
300     function canTop(cls, rec) {
301         
302         rec = rec || 0;
303         //print('CANTOP: ' + cls + ' =' + rec);
304         if (rec > 5) {
305        //     print('SKIP : ' + cls);
306         }
307         if (typeof(tops[cls]) == 'undefined') {
308             return false;
309         }
310         for (var i =0; i < tops[cls].length; i++) {
311             if (tops[cls][i] == '*top') {
312                 return true;
313             }
314             if (cls == tops[cls][i]) {
315                 continue;
316             }
317             if (canTop(tops[cls][i], rec+1)) {
318                 return true;
319             }
320         }
321         return false;
322         
323     }
324     var nusage = {};
325     for(var par in usage) {
326         // see if the parent can be added to something.
327         if (!canTop(par)) {
328             continue;
329         }
330         nusage[par] = usage[par];
331         
332     }
333     
334     print(JSON.stringify(nusage,null,4));
335     
336     
337     
338     
339     //print(JSON.stringify(implementations ,null,4));
340     /*
341       methods is
342         [a class]
343             [has methods that use this object]
344                 [list of methods of the top class..]
345      
346      
347       So let's pick one..
348         TOP        ARRAY  2ND
349         Gtk.Button.add(Gtk.Widget) <<
350         
351         
352         What we need:
353         
354         A) what can this dragged element be dropped onto.
355         eg. list of parents.
356         - can_be_added_to_as (left)
357         
358         
359         
360         B) what method is available when this object is dropped onto this one.
361         
362         - get the right hand side?
363         
364         
365      
366      
367     */
368     
369     
370     //print(JSON.stringify(implementations,null,4));
371     
372 }
373 BuildLists();
374
375 // we now have a list of classes / methods that can be used..
376 // we now need a ui to flag stuff as "don't bother with"
377
378