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