git.roojs.org Git - app.Builder.js/blob - XObject.js

   1 //<script type="text/javascript">
   2 GIRepository = imports.gi.GIRepository;
   3 GObject = imports.gi.GObject;
   4 /**
   5  * XObject
   6  * Yet another attempt to create a usable object construction library for seed..
   7  *
   8  * Why is this useful?
   9  * A) It turns rather messy code into a tree structure, making it easy to find code relating to
  10  *    an interface element
  11  * B) In theory it should be gjs/Seed compatible..
  12  * C) It provides getElementById style lookups for elements.
  13  * D) It provides classic OO constructors for Javascript (extend/define)
  14  * E) It does not modify any buildin prototypes..
  15  *
  16  * Extend this.. to use it's wonderful features..
  17  *
  18  * normal usage:
  19  * XObject = imports.XObject.XObject;
  20  *
  21  * Xyz = new XObject({
  22  *     xtype: Gtk.Window,
  23  *     id : 'window',
  24  *     items : [
  25  *
  26  *     ]
  27  *  });
  28  *  Xyz.init(); // create and show.
  29  *
  30  *
  31  *
  32  * @arg xtype {String|Function} constructor or string.
  33  * @arg id {String}  (optional) id for registry
  34  * @arg xns {String|Object}   (optional) namespace eg. Gtk or 'Gtk' - used with xtype.
  35  * @arg items {Array}   (optional) list of child elements which will be constructed.. using XObject
  36  * @arg listeners {Object}   (optional) map Gobject signals to functions
  37  * @arg pack {Function|String|Array}   (optional) how this object gets added to it's parent
  38  * @arg el {Object}   (optional) premade GObject
  39  *
  40  *  --- needs a xdebug option!
  41  *
  42  *
  43  * He's some questions.
  44  * - should we generate ID's for all elements? (if so we probably need to garbage collect)
  45  * - should we have a special property to use as the constructor / gobject.properties rather
  46  *   than sending all basic types to this?
  47  *
  48  *
  49  */
  50
  51 function XObject (cfg) {
  52     // first apply cfg if set.
  53       //print("new XOBJECT!!!");
  54     this.config = {};
  55     this.constructor = XObject;
  56
  57     // copy down all elements into self..
  58
  59     for (var i in cfg) {
  60         this[i] = cfg[i];
  61         if (typeof(cfg[i]) == 'function') { // do we skip objects.
  62             continue;
  63         }
  64         // these properties are not copied to cfg.
  65         if (    i == 'pack' ||
  66                 i == 'items' ||
  67                 i == 'id' ||
  68                 i == 'xtype' ||
  69                 i == 'xdebug' ||
  70                 i == 'xns') {
  71             continue;
  72         }
  73
  74
  75         this.config[i] = cfg[i];
  76     }
  77     this.items = this.items || [];
  78     // pack can be false!
  79     if (typeof(this.pack) == 'undefined') {
  80
  81         this.pack = [ 'add' ]
  82         /*
  83         var Gtk  = imports.gi.Gtk;
  84         switch (true) {
  85             // any others!!
  86             case (this.xtype == Gtk.MenuItem):  this.pack = [ 'append' ]; break;
  87
  88         }
  89         */
  90
  91     }
  92
  93
  94
  95 }
  96
  97
  98
  99 XObject.prototype = {
 100     /**
 101      * @property el {GObject} the Gtk / etc. element.
 102      */
 103     el : false,
 104     /*
 105      * @property items {Array} list of sub elements
 106      */
 107     /**
 108      * @property parent {XObject} parent Element
 109      */
 110
 111      /**
 112      * @property config {Object} the construction configuration.
 113      */
 114      /**
 115       * @method init
 116       * Initializes the Element (el) hooks up all the listeners
 117       * and packs the children.
 118       * you can override this, in child objects, then
 119       * do this to do thi initaliztion.
 120       *
 121       * XObject.prototype.init.call(this);
 122       *
 123       */
 124     init : function()
 125     {
 126
 127         var items = [];
 128         this.items.forEach(function(i) {
 129             items.push(i);
 130         });
 131         // remove items.
 132         this.listeners = this.listeners || {};
 133         this.items = [];
 134
 135         // do we need to call 'beforeInit here?'
 136
 137         // handle include?
 138         //if ((this.xtype == 'Include')) {
 139         //    o = this.pre_registry[cls];
 140         //}
 141         var isSeed = typeof(Seed) != 'undefined';
 142
 143         // xtype= Gtk.Menu ?? what about c_new stuff?
 144         if (XObject.debug) print("init: ID:"+ this.id +" typeof(xtype): "  + typeof(this.xtype));
 145         if (!this.el && typeof(this.xtype) == 'function') {
 146             if (XObject.debug) print("func?"  + XObject.keys(this.config).join(','));
 147             this.el = this.xtype(this.config);
 148
 149         }
 150         if (!this.el && typeof(this.xtype) == 'object') {
 151             if (XObject.debug) print("obj?"  + XObject.keys(this.config).join(','));
 152             this.el = new (this.xtype)(this.config);
 153
 154         }
 155         //print(this.el);
 156         if (!this.el && this.xns) {
 157
 158             var NS = imports.gi[this.xns];
 159             if (!NS) {
 160                 Seed.print('Invalid xns: ' + this.xns);
 161             }
 162             constructor = NS[this.xtype];
 163             if (!constructor) {
 164                 Seed.print('Invalid xtype: ' + this.xns + '.' + this.xtype);
 165             }
 166             this.el  =   isSeed ? new constructor(this.config) : new constructor();
 167
 168         }
 169         if (XObject.debug) print("init: ID:"+ this.id +" typeof(el):" + this.el);
 170
 171         // always overlay props..
 172         // check for 'write' on object..
 173         /*
 174         if (typeof(XObject.writeablePropsCache[this.xtype.type]) == 'undefined') {
 175
 176             var gi = GIRepository.IRepository.get_default();
 177             var ty = gi.find_by_gtype(this.xtype.type);
 178             var write = [];
 179             for (var i =0; i < GIRepository.object_info_get_n_properties(ty);i++) {
 180                 var p =   GIRepository.object_info_get_property(ty,i);
 181                 if (GIRepository.property_info_get_flags(p) & 2) {
 182                     write.push(GIRepository.base_info_get_name(p));
 183                 }
 184             }
 185             XObject.writeablePropsCache[this.xtype.type] = write;
 186             print(write.join(", "));
 187         }
 188
 189         */
 190
 191
 192         for (var i in this.config) {
 193             if (i == 'type') { // problem with Gtk.Window... - not decided on a better way to handle this.
 194                 continue;
 195             }
 196             if (i == 'buttons') { // problem with Gtk.MessageDialog..
 197                 continue;
 198             }
 199             if (i[0] == '.') { // parent? -
 200                 continue;
 201             }
 202             this.el[i] = this.config[i];
 203         }
 204
 205         // register it!
 206         //if (o.xnsid  && o.id) {
 207          //   XObject.registry = XObject.registry || { };
 208          //   XObject.registry[o.xnsid] = XObject.registry[o.xnsid] || {};
 209          //   XObject.registry[o.xnsid][o.id] = this;
 210         //}
 211
 212         var type = this.xtype.type ? GObject.type_name(this.xtype.type) : '';
 213         print("MAKE " + type);
 214
 215
 216         var _this=this;
 217         items.forEach(function(i,n) {
 218
 219             if (type == 'GtkTable' && i.pack == 'add') {
 220                 var c = n % _this.config.n_columns;
 221                 var r = Math.floor(n/_this.config.n_columns);
 222                 i.pack = [ 'attach', c, c+1, r, r+1,
 223                         typeof(i.x_options) == 'undefined' ?  5 : i.x_options,
 224                         typeof(i.y_options) == 'undefined' ?  5 : i.y_options,
 225                         typeof(i.x_padding) == 'undefined' ?  0 : i.x_padding,
 226                         typeof(i.x_padding) == 'undefined' ?  0 : i.x_padding
 227
 228                 ]
 229             }
 230
 231             _this.addItem(i);
 232         })
 233
 234
 235         for (var i in this.listeners) {
 236             this.addListener(i, this.listeners[i]);
 237         }
 238
 239         // delete this.listeners ?
 240         // do again so child props work!
 241
 242         // do we need to call 'init here?'
 243     },
 244
 245
 246      /**
 247       * @method addItem
 248       * Adds an item to the object using a new XObject
 249       * uses pack property to determine how to add it.
 250       * @arg cfg {Object} same as XObject constructor.
 251       */
 252     addItem : function(o) {
 253         if (typeof(o) == 'undefined') {
 254             print("Invalid Item added to this!");
 255             imports.console.dump(this);
 256             Seed.quit();
 257         }
 258         // what about extended items!?!?!?
 259         var item = (o.constructor == XObject) ? o : new XObject(o);
 260         item.parent = this;
 261         this.items.push(item);
 262         item.init();
 263         //print("CTR:PROTO:" + ( item.id ? item.id : '??'));
 264        // print("addItem - call init [" + item.pack.join(',') + ']');
 265         if (!item.el) {
 266             print("NO EL!");
 267             imports.console.dump(item);
 268             Seed.quit();
 269         }
 270
 271
 272         if (item.pack===false) {  // no
 273             return;
 274         }
 275         if (typeof(item.pack) == 'function') {
 276             // parent, child
 277             item.pack.apply(item, [ this , item  ]);
 278             item.parent = this;
 279             return;
 280         }
 281         var args = [];
 282         var pack_m  = false;
 283         if (typeof(item.pack) == 'string') {
 284
 285             item.pack.split(',').forEach(function(e, i) {
 286
 287                 if (e == 'false') { args.push( false); return; }
 288                 if (e == 'true') {  args.push( true);  return; }
 289                 if (!isNaN(parseInt(e))) { args.push( parseInt(e)); return; }
 290                 args.push(e);
 291             });
 292             //print(args.join(","));
 293
 294             pack_m = args.shift();
 295         } else {
 296             pack_m = item.pack.shift();
 297             args = item.pack;
 298         }
 299
 300         // handle error.
 301         if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
 302
 303             throw {
 304                 name: "ArgumentError",
 305                 message : 'pack method not available : ' + this.id + " : " + this.xtype + '.' +  pack_m + " ADDING " + item.el
 306
 307             }
 308
 309
 310
 311
 312             return;
 313         }
 314
 315
 316         //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
 317
 318         args.unshift(item.el);
 319         if (XObject.debug) print(pack_m + '[' + args.join(',') +']');
 320         //Seed.print('args: ' + args.length);
 321         if (pack_m) {
 322             this.el[pack_m].apply(this.el, args);
 323         }
 324
 325
 326
 327     },
 328     /**
 329       * @method addListener
 330       * Connects a method to a signal. (gjs/Seed aware)
 331       *
 332       * @arg sig  {String} name of signal
 333       * @arg fn  {Function} handler.
 334       */
 335     addListener  : function(sig, fn)
 336     {
 337
 338         if (XObject.debug) Seed.print("Add signal " + sig);
 339         fn.id= sig;
 340         var _li = XObject.createDelegate(fn,this);
 341         // private listeners that are not copied to GTk.
 342
 343         if (typeof(Seed) != 'undefined') {
 344           //   Seed.print(typeof(_li));
 345             this.el.signal[sig].connect(_li);
 346         } else {
 347             this.el.connect( sig, _li);
 348         }
 349
 350
 351     },
 352      /**
 353       * @method get
 354       * Finds an object in the child elements using xid of object.
 355       * prefix with '.' to look up the tree..
 356       * prefix with multiple '..' to look further up..
 357       * prefix with '/' to look from the top, eg. '^LeftTree.model'
 358       *
 359       * @arg name  {String} name of signal
 360       * @return   {XObject|false} the object if found.
 361       */
 362     get : function(xid)
 363     {
 364         if (XObject.debug) print("SEARCH FOR " + xid + " in " + this.id);
 365         var ret=  false;
 366         var oid = '' + xid;
 367         if (!xid.length) {
 368             throw {
 369                 name: "ArgumentError",
 370                 message : "ID not found : empty id"
 371             }
 372         }
 373
 374         if (xid[0] == '.') {
 375             return this.parent.get(xid.substring(1));
 376         }
 377         if (xid[0] == '/') {
 378
 379             if (typeof(XObject.cache[xid]) != 'undefined') {
 380                 return XObject.cache[xid];
 381             }
 382             if (xid.indexOf('.') > -1) {
 383
 384                 var child = xid.split('.');
 385                 var nxid = child.shift();
 386
 387                 child = child.join('.');
 388                 if (typeof(XObject.cache[nxid]) != 'undefined') {
 389                     return XObject.cache[nxid].get(child);
 390                 }
 391
 392
 393             }
 394             var e = this;
 395             while (e.parent) {
 396                 e = e.parent;
 397             }
 398
 399             try {
 400                 ret = e.get(xid.substring(1));
 401             } catch (ex) { }
 402
 403             if (!ret) {
 404                 throw {
 405                     name: "ArgumentError",
 406                     message : "ID not found : " + oid
 407                 }
 408             }
 409             XObject.cache[xid] = ret;
 410             return XObject.cache[xid];
 411         }
 412         var child = false;
 413
 414         if (xid.indexOf('.') > -1) {
 415             child = xid.split('.');
 416             xid = child.shift();
 417
 418             child = child.join('.');
 419
 420         }
 421         if (xid == this.id) {
 422             try {
 423                 return child === false ? this : this.get(child);
 424             } catch (ex) {
 425                 throw {
 426                     name: "ArgumentError",
 427                     message : "ID not found : " + oid
 428                 }
 429             }
 430
 431         }
 432
 433
 434         this.items.forEach(function(ch) {
 435             if (ret) {
 436                 return;
 437             }
 438             if (ch.id == xid) {
 439                 ret = ch;
 440             }
 441         })
 442         if (ret) {
 443             try {
 444                 return child === false ? ret : ret.get(child);
 445             } catch (ex) {
 446                 throw {
 447                     name: "ArgumentError",
 448                     message : "ID not found : " + oid
 449                 }
 450             }
 451
 452         }
 453         // iterate children.
 454         var _this = this;
 455         this.items.forEach(function(ch) {
 456             if (ret) {
 457                 return;
 458             }
 459             if (!ch.get) {
 460                 print("invalid item...");
 461                 imports.console.dump(_this);
 462                 Seed.quit();
 463             }
 464             try {
 465                 ret = ch.get(xid);
 466             } catch (ex) { }
 467
 468
 469         });
 470         if (!ret) {
 471             throw {
 472                 name: "ArgumentError",
 473                 message : "ID not found : " + oid
 474             }
 475         }
 476         try {
 477             return child === false ? ret : ret.get(child);
 478         } catch (ex) {
 479             throw {
 480                 name: "ArgumentError",
 481                 message : "ID not found : " + oid
 482             }
 483         }
 484     }
 485
 486
 487 }
 488
 489
 490 /**
 491  * Copies all the properties of config to obj.
 492  *
 493  * Pretty much the same as JQuery/Prototype..
 494  * @param {Object} obj The receiver of the properties
 495  * @param {Object} config The source of the properties
 496  * @param {Object} defaults A different object that will also be applied for default values
 497  * @return {Object} returns obj
 498  * @member XObject extend
 499  */
 500
 501
 502 XObject.extend = function(o, c, defaults){
 503     if(defaults){
 504         // no "this" reference for friendly out of scope calls
 505         XObject.extend(o, defaults);
 506     }
 507     if(o && c && typeof c == 'object'){
 508         for(var p in c){
 509             o[p] = c[p];
 510         }
 511     }
 512     return o;
 513 };
 514
 515 XObject.extend(XObject,
 516 {
 517
 518     /**
 519      * @property {Boolean} debug XObject  debugging.  - set to true to debug.
 520      *
 521      */
 522     debug : true,
 523     /**
 524      * @property {Object} cache - cache of object ids
 525      *
 526      */
 527     cache: { },
 528
 529     /**
 530      * Copies all the properties of config to obj, if the do not exist.
 531      * @param {Object} obj The receiver of the properties
 532      * @param {Object} config The source of the properties
 533      * @return {Object} returns obj
 534      * @member Object extendIf
 535      */
 536
 537
 538     extendIf : function(o, c){
 539
 540         if(!o || !c || typeof c != 'object'){
 541             return o;
 542         }
 543         for(var p in c){
 544             if (typeof(o[p]) != 'undefined') {
 545                 continue;
 546             }
 547             o[p] = c[p];
 548         }
 549         return o;
 550     },
 551
 552
 553
 554     /**
 555      * Extends one class with another class and optionally overrides members with the passed literal. This class
 556      * also adds the function "override()" to the class that can be used to override
 557      * members on an instance.
 558      *
 559      * usage:
 560      * MyObject = Object.define(
 561      *     function(...) {
 562      *          ....
 563      *     },
 564      *     parentClass, // or Object
 565      *     {
 566      *        ... methods and properties.
 567      *     }
 568      * });
 569      * @param {Function} constructor The class inheriting the functionality
 570      * @param {Object} superclass The class being extended
 571      * @param {Object} overrides (optional) A literal with members
 572      * @return {Function} constructor (eg. class
 573      * @method define
 574      */
 575     define : function(){
 576         // inline overrides
 577         var io = function(o){
 578             for(var m in o){
 579                 this[m] = o[m];
 580             }
 581         };
 582         return function(constructor, parentClass, overrides) {
 583             if (typeof(parentClass) == 'undefined') {
 584                 print("XObject.define: Missing parentClass: when applying: " );
 585                 print(new String(constructor));
 586                 Seed.quit();
 587             }
 588             if (typeof(parentClass.prototype) == 'undefined') {
 589                 print("Missing protype: when applying: " );
 590                 print(new String(constructor));
 591                 print(new String(parentClass));
 592                 Seed.quit();
 593             }
 594             var F = function(){};
 595             var sbp;
 596             var spp = parentClass.prototype;
 597
 598             F.prototype = spp;
 599             sbp = constructor.prototype = new F();
 600             sbp.constructor=constructor;
 601             constructor.superclass=spp;
 602
 603             // extends Object.
 604             if(spp.constructor == Object.prototype.constructor){
 605                 spp.constructor=parentClass;
 606             }
 607
 608             constructor.override = function(o){
 609                 Object.extend(constructor.prototype, o);
 610             };
 611             sbp.override = io;
 612             XObject.extend(constructor.prototype, overrides);
 613             return constructor;
 614         };
 615     }(),
 616
 617
 618     /**
 619      * returns a list of keys of the object.
 620      * @param {Object} obj object to inspect
 621      * @return {Array} returns list of kyes
 622      * @member XObject keys
 623      */
 624     keys : function(o)
 625     {
 626         var ret = [];
 627         for(var i in o) {
 628             ret.push(i);
 629         }
 630         return ret;
 631     },
 632
 633     /**
 634      * @member XObject createDelegate
 635      * creates a delage metdhod
 636      * @param {Function} method to wrap
 637      * @param {Object} scope
 638      * @param {Array} args to add
 639      * @param {Boolean|Number} append arguments or replace after N arguments.
 640      * @return {Function} returns the delegate
 641      */
 642
 643     createDelegate : function(method, obj, args, appendArgs){
 644
 645         return function() {
 646             if (XObject.debug) print("CALL: " + obj.id + ':'+ method.id);
 647
 648             var callArgs = args || arguments;
 649             if(appendArgs === true){
 650                 callArgs = Array.prototype.slice.call(arguments, 0);
 651                 callArgs = callArgs.concat(args);
 652             }else if(typeof appendArgs == "number"){
 653                 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
 654                     var applyArgs = [appendArgs, 0].concat(args); // create method call params
 655                     Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
 656                 }
 657                 return method.apply(obj || window, callArgs);
 658             };
 659     }
 660
 661 });