git.roojs.org Git - app.Builder.js/blob - 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                                 //"Gtk.Widget:add_accelerator",
 137                                 //"Gtk.Widget:add_device_events"
 138
 139                 if (m.name.match(/^(add_mnemonic_label|add_accelerator|add_device_events)$/)) {
 140                     return;
 141                 }
 142
 143                 // in theory you can not add a window to anything.. ???
 144                 //if ('Gtk.Window' == addable_type || methods[addable_type].extendsClasses.indexOf('Gtk.Window') > -1) {
 145                 //    return;
 146                 //}
 147         //
 148
 149                 //print(full_method_name );
 150
 151                 //if (allmethods.indexOf(full_method_name) < 0) {
 152                 //    allmethods.push(full_method_name);
 153                 //}
 154
 155                 methods[cls].can_contain.pushUnique(addable_type);
 156                 var add = m.memberOf +':'+ m.name;
 157
 158                 methods[cls].can_contain_using.pushUnique(add);
 159                 //methods[cls].using_methods[m.name] = m.params;
 160
 161                 //if (methods[addable_type].can_be_added_to.indexOf(cls) < 0) {
 162                 //    methods[addable_type].can_be_added_to.push(cls);
 163                 //}
 164
 165
 166
 167                 if (typeof(methods[addable_type].can_be_added_to_as[cls]) == 'undefined') {
 168                     methods[addable_type].can_be_added_to_as[cls]=[];
 169                 }
 170                 methods[addable_type].can_be_added_to_as[cls].pushUnique( add );
 171                 implementations[cls].forEach(function(imp) {
 172
 173
 174                     if (typeof(methods[addable_type ].can_be_added_to_as[imp]) == 'undefined') {
 175                         methods[addable_type].can_be_added_to_as[imp] = [];
 176                     }
 177
 178                     methods[addable_type].can_be_added_to_as[imp].pushUnique(add);
 179
 180
 181                 });
 182                 // also needs to add
 183                 //print(addable_type);
 184                 //print(JSON.stringify(implementations[addable_type], null,4));
 185
 186
 187                 implementations[addable_type].forEach(function(addable_child) {
 188
 189                     //if (addable_child == 'Gtk.AboutDialog') {
 190                     //    print(JSON.stringify(methods[addable_child].extendsClasses,null,4));Seed.exit();
 191
 192                     //}
 193
 194                     if (addable_child == 'Gtk.Window' ||
 195                             methods[addable_child].extendsClasses.indexOf('Gtk.Window') > -1) {
 196                         return;
 197                     }
 198
 199                     if (typeof(methods[addable_child].can_be_added_to_as[cls]) == 'undefined') {
 200                         methods[addable_child].can_be_added_to_as[cls]=[];
 201                     }
 202                     methods[addable_child].can_be_added_to_as[cls].pushUnique( add );
 203                     implementations[cls].forEach(function(imp) {
 204                         if (typeof(methods[addable_child ].can_be_added_to_as[imp]) == 'undefined') {
 205                             methods[addable_child].can_be_added_to_as[imp] = [];
 206                         }
 207
 208                         methods[addable_child].can_be_added_to_as[imp].pushUnique(add);
 209
 210
 211                     });
 212
 213
 214
 215                 });
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225                 return;
 226             /*
 227                     methods[cls].using_methods[m.name] = {};
 228                 }
 229
 230
 231                 if (typeof(methods[cls][full_method_name]) == 'undefined') {
 232                     methods[cls][full_method_name] = [];
 233                 }
 234                 if (methods[cls][full_method_name].indexOf(m.name) > -1) {
 235                     return;
 236                 }
 237                 methods[cls][full_method_name].push(m.name);
 238             */
 239             });
 240
 241         });
 242         //for(method in odata.methods) {
 243         //    print(method.name);
 244         //}
 245
 246
 247     }
 248     /*
 249     // fill in the added to list..
 250     for(var p in methods ) {
 251         var odata = methods[p];
 252
 253         methods[p].can_be_added_to.forEach(function(c) {
 254             methods[p].can_be_added_to_as[c]=c;
 255             implementations[c].forEach(function(imp) {
 256                 methods[p].can_be_added_to_as[imp]=c;
 257             });
 258         });
 259
 260
 261     }
 262     */
 263     // now do the reverese 'can be added to'
 264
 265
 266
 267     this.methods = methods;
 268     this.allmethods = methods;
 269     this.implementations = implementations;
 270     //print(JSON.stringify(methods,null,4)); Seed.exit();
 271     // dump out a usage file..
 272         this.failed = [];
 273     var failed = this.failed;
 274     function verifyUsageMethod(parent,child,method)
 275     {
 276         // currently only verifies add on container.
 277         if (method !='Gtk.Container:add') {
 278             return true;
 279         }
 280         if (failed.indexOf(parent) > -1) {
 281             return false;
 282         }
 283
 284         var ar =  parent.split('.')
 285         var cls =ar[1];
 286         var ns =ar[0];
 287
 288         /*
 289         if (parent == 'Gtk.Bin' || methods['Gtk.Bin'].extendsClasses.indexOf(parent) > -1) {
 290             return false;
 291         }
 292         if (['GtkSource.CompletionInfo',
 293              'Gtk.MenuShell',
 294              'GtkSource.View', // ??? nothing can be added to it?
 295              'WebKit.WebView', // ??? nothing can be added to it?
 296              'GtkClutter.Embed'
 297              ].indexOf(parent) > -1) {
 298              return false;
 299         }
 300         */
 301
 302
 303         try {
 304             var x = new imports.gi[ns][cls]();
 305         } catch(e) {
 306             failed.push(parent);
 307             print("TRY ctor:  " + parent );
 308             print(JSON.stringify(e));
 309             return false;
 310         }
 311
 312         //print("TRY child type:  " + parent);
 313         var ct = x.child_type();
 314         //print(parent + " : says children are of type : " + ct);
 315         // get the Gtype for the child?
 316         var GObject = imports.gi.GObject;
 317         var match = GObject.type_from_name(ar.join(''));
 318         //print([match, ct]);
 319         //print ("matching?" + (GObject.type_is_a(match,  ct ) ? "YES" : "NO"));
 320
 321
 322         return GObject.type_is_a(match,  ct )  ? true : false;
 323
 324     }
 325
 326     function is_a(cls, instance_of) {
 327         return methods[cls].extendsClasses.indexOf(instance_of) > -1;
 328     }
 329
 330     function verifyUsage(parent,child)
 331     {
 332         // find all the methods that child can be added to parent.
 333         var mts = methods[parent].can_contain_using;
 334         for(var i =0;i<mts.length;i++) {
 335             var m = mts[i].split(':');
 336             if (!is_a(child,m[0])) {
 337                 continue;
 338
 339             }
 340             if (verifyUsageMethod(parent,child,mts[i])) {
 341                 return true;
 342             }
 343         }
 344         return false;
 345
 346
 347     }
 348
 349
 350
 351
 352
 353
 354     // basically anything that is a Gtk.Container, should be available at the top.
 355     /*
 356 left:
 357  *top
 358 right:
 359         Gtk.Window
 360         Gtk.Dialog
 361         Gtk.MessageDialog
 362         Gtk.AboutDialog
 363         Gtk.Dialog
 364         Gtk.FontSelectionDialog
 365         Gtk.InputDialog
 366         Gtk.ColorSelectionDialog
 367         Gtk.FileChooserDialog
 368         Gtk.Menu
 369         GtkClutter.Window
 370         Gtk.OffScreenWindow
 371     */
 372 // these should really be based on heirachy..
 373     usage = {};
 374     tops = {}
 375     usage['*top'] = implementations['Gtk.Container'];
 376     usage['*top'].forEach(function(ch) {
 377         tops[ch] = [ '*top' ];
 378     });
 379     for(var cls in methods) {
 380         if (cls =='Gtk.Builder') {
 381             continue;
 382         }
 383         for (var par in methods[cls].can_be_added_to_as) {
 384
 385             if (!verifyUsage(par,cls)) {
 386                 continue;
 387             }
 388
 389             if (typeof(usage[par]) == 'undefined') {
 390                 usage[par] = [];
 391             }
 392
 393
 394
 395             usage[par].pushUnique(cls);
 396             if (typeof(tops[cls]) == 'undefined') {
 397                 tops[cls] = [];
 398             }
 399             tops[cls].pushUnique(par);
 400         }
 401     }
 402
 403
 404     function canTop(cls, rec) {
 405
 406         rec = rec || 0;
 407         //print('CANTOP: ' + cls + ' =' + rec);
 408         if (rec > 5) {
 409        //     print('SKIP : ' + cls);
 410         }
 411         if (typeof(tops[cls]) == 'undefined') {
 412             return false;
 413         }
 414         for (var i =0; i < tops[cls].length; i++) {
 415             if (tops[cls][i] == '*top') {
 416                 return true;
 417             }
 418             if (cls == tops[cls][i]) {
 419                 continue;
 420             }
 421             if (canTop(tops[cls][i], rec+1)) {
 422                 return true;
 423             }
 424         }
 425         return false;
 426     }
 427     var lefts = {};
 428     for(var par in usage) {
 429         var left = usage[par].join(',');
 430         if (typeof(lefts[left]) == 'undefined') {
 431             lefts[left] = [];
 432         }
 433         lefts[left].push(par);
 434     }
 435     print (JSON.stringify(lefts,null,4));
 436     Seed.quit();
 437
 438
 439
 440
 441     print (JSON.stringify(usage,null,4));
 442     var nusage = {};
 443         var usage_left = {};
 444     for(var par in usage) {
 445         // see if the parent can be added to something.
 446         if (!canTop(par)) {
 447             continue;
 448         }
 449                 var duped = false;
 450                 for(var dupe in usage) {
 451                         if (par != dupe
 452                                 && typeof(nusage[dupe]) != 'undefined'
 453                                 && usage[par].join(',') == usage[dupe].join(',')) {
 454                                 duped = true;
 455
 456                                 if (typeof(usage_left[dupe]) == 'undefined') {
 457                                         usage_left[dupe] = [];
 458                                 }
 459                                 //print(par+ ' is a dupe of ' + dupe);
 460                                 usage_left[dupe].pushUnique(par);
 461                                 break;
 462                         }
 463                 }
 464                  if (duped) {
 465                         continue;
 466                  }
 467         nusage[par] = usage[par];
 468
 469     }
 470     usage = nusage;
 471     //print(JSON.stringify(nusage,null,4));  Seed.exit();
 472     print(JSON.stringify(methods['Gtk.TextView'],null,4));
 473
 474     var str = [];
 475         for(var par in usage) {
 476                 str.push('left');
 477                 str.push('   ' + par);
 478                 if (typeof(usage_left[par]) != 'undefined') {
 479                         usage_left[par].forEach(function(d) { str.push('    ' + d);});
 480                 }
 481                 str.push('right');
 482                 usage[par].forEach(function(d) { str.push('    ' + d);});
 483                 str.push('');
 484         }
 485         print(str.join("\n"));
 486     //print(JSON.stringify(implementations ,null,4));
 487     /*
 488       methods is
 489         [a class]
 490             [has  methods that use this object]
 491                 [list of methods of the top class..]
 492
 493
 494       So let's pick one..
 495         TOP        ARRAY  2ND
 496         Gtk.Button.add(Gtk.Widget) <<
 497
 498
 499         What we need:
 500
 501         A) what can this dragged element be dropped onto.
 502         eg. list of parents.
 503         - can_be_added_to_as (left)
 504
 505
 506
 507         B) what method is available when this object is dropped onto this one.
 508
 509         - get the right hand side?
 510
 511
 512
 513
 514     */
 515
 516
 517     //print(JSON.stringify(implementations,null,4));
 518
 519 }
 520 imports.gi.Gtk.init(Seed.argv);
 521
 522 imports.gi.GtkClutter.init(Seed.argv);
 523 BuildLists();
 524
 525 // we now have a list of classes / methods that can be used..
 526 // we now need a ui to flag stuff as "don't bother with"
 527
 528