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