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         var Gtk  = imports.gi.Gtk;
  81         this.pack = [ 'add' ]
  82         switch (true) {
  83             // any others!!
  84             case (this.xtype == Gtk.MenuItem):  this.pack = [ 'append' ]; break;
  85
  86         }
  87
  88     }
  89
  90
  91
  92 }
  93
  94
  95
  96 XObject.prototype = {
  97     /**
  98      * @property el {GObject} the Gtk / etc. element.
  99      */
 100     el : false,
 101     /*
 102      * @property items {Array} list of sub elements
 103      */
 104     /**
 105      * @property parent {XObject} parent Element
 106      */
 107
 108      /**
 109      * @property config {Object} the construction configuration.
 110      */
 111      /**
 112       * @method init
 113       * Initializes the Element (el) hooks up all the listeners
 114       * and packs the children.
 115       * you can override this, in child objects, then
 116       * do this to do thi initaliztion.
 117       *
 118       * XObject.prototype.init.call(this);
 119       *
 120       */
 121     init : function()
 122     {
 123
 124         var items = [];
 125         this.items.forEach(function(i) {
 126             items.push(i);
 127         });
 128         // remove items.
 129         this.listeners = this.listeners || {};
 130         this.items = [];
 131
 132         // do we need to call 'beforeInit here?'
 133
 134         // handle include?
 135         //if ((this.xtype == 'Include')) {
 136         //    o = this.pre_registry[cls];
 137         //}
 138         var isSeed = typeof(Seed) != 'undefined';
 139
 140         // xtype= Gtk.Menu ?? what about c_new stuff?
 141         if (XObject.debug) print("init: ID:"+ this.id +" typeof(xtype): "  + typeof(this.xtype));
 142         if (!this.el && typeof(this.xtype) == 'function') {
 143             if (XObject.debug) print("func?"  + XObject.keys(this.config).join(','));
 144             this.el = this.xtype(this.config);
 145
 146         }
 147         if (!this.el && typeof(this.xtype) == 'object') {
 148             if (XObject.debug) print("obj?"  + XObject.keys(this.config).join(','));
 149             this.el = new (this.xtype)(this.config);
 150
 151         }
 152         //print(this.el);
 153         if (!this.el && this.xns) {
 154
 155             var NS = imports.gi[this.xns];
 156             if (!NS) {
 157                 Seed.print('Invalid xns: ' + this.xns);
 158             }
 159             constructor = NS[this.xtype];
 160             if (!constructor) {
 161                 Seed.print('Invalid xtype: ' + this.xns + '.' + this.xtype);
 162             }
 163             this.el  =   isSeed ? new constructor(this.config) : new constructor();
 164
 165         }
 166         if (XObject.debug) print("init: ID:"+ this.id +" typeof(el):" + this.el);
 167
 168         // always overlay props..
 169         // check for 'write' on object..
 170         /*
 171         if (typeof(XObject.writeablePropsCache[this.xtype.type]) == 'undefined') {
 172
 173             var gi = GIRepository.IRepository.get_default();
 174             var ty = gi.find_by_gtype(this.xtype.type);
 175             var write = [];
 176             for (var i =0; i < GIRepository.object_info_get_n_properties(ty);i++) {
 177                 var p =   GIRepository.object_info_get_property(ty,i);
 178                 if (GIRepository.property_info_get_flags(p) & 2) {
 179                     write.push(GIRepository.base_info_get_name(p));
 180                 }
 181             }
 182             XObject.writeablePropsCache[this.xtype.type] = write;
 183             print(write.join(", "));
 184         }
 185
 186         */
 187
 188
 189         for (var i in this.config) {
 190             if (i == 'type') { // problem with Gtk.Window... - not decided on a better way to handle this.
 191                 continue;
 192             }
 193             this.el[i] = this.config[i];
 194         }
 195
 196         // register it!
 197         //if (o.xnsid  && o.id) {
 198          //   XObject.registry = XObject.registry || { };
 199          //   XObject.registry[o.xnsid] = XObject.registry[o.xnsid] || {};
 200          //   XObject.registry[o.xnsid][o.id] = this;
 201         //}
 202         var _this=this;
 203         items.forEach(function(i) {
 204             _this.addItem(i);
 205         })
 206
 207
 208         for (var i in this.listeners) {
 209             this.addListener(i, this.listeners[i]);
 210         }
 211         // delete this.listeners ?
 212
 213
 214         // do we need to call 'init here?'
 215     },
 216
 217
 218      /**
 219       * @method addItem
 220       * Adds an item to the object using a new XObject
 221       * uses pack property to determine how to add it.
 222       * @arg cfg {Object} same as XObject constructor.
 223       */
 224     addItem : function(o) {
 225         if (typeof(o) == 'undefined') {
 226             print("Invalid Item added to this!");
 227             imports.console.dump(this);
 228             Seed.quit();
 229         }
 230         // what about extended items!?!?!?
 231         var item = (o.constructor == XObject) ? o : new XObject(o);
 232         item.parent = this;
 233         this.items.push(item);
 234         item.init();
 235         //print("CTR:PROTO:" + ( item.id ? item.id : '??'));
 236        // print("addItem - call init [" + item.pack.join(',') + ']');
 237         if (!item.el) {
 238             print("NO EL!");
 239             imports.console.dump(item);
 240             Seed.quit();
 241         }
 242
 243
 244
 245
 246         if (item.pack===false) {  // no
 247             return;
 248         }
 249         if (typeof(item.pack) == 'function') {
 250             // parent, child
 251             item.pack.apply(item, [ this , item  ]);
 252             item.parent = this;
 253             return;
 254         }
 255         var args = [];
 256         var pack_m  = false;
 257         if (typeof(item.pack) == 'string') {
 258             var args = item.pack.split(',');
 259             args.forEach(function(e, i) {
 260
 261                 if (e == 'false') { args[i] = false; return; }
 262                 if (e == 'true') {  args[i] = true;  return; }
 263                 if (parseInt(e) !== NaN) { args[i] = parseInt(e); return; }
 264             });
 265             pack_m = args.shift();
 266         } else {
 267             pack_m = item.pack.shift();
 268             args = item.pack;
 269         }
 270
 271         // handle error.
 272         if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
 273             Seed.print('pack method not available : ' + this.xtype + '.' +  pack_m);
 274             return;
 275         }
 276
 277
 278         //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
 279
 280         args.unshift(item.el);
 281         if (XObject.debug) print(pack_m + '[' + args.join(',') +']');
 282         //Seed.print('args: ' + args.length);
 283         if (pack_m) {
 284             this.el[pack_m].apply(this.el, args);
 285         }
 286
 287
 288
 289     },
 290     /**
 291       * @method addListener
 292       * Connects a method to a signal. (gjs/Seed aware)
 293       *
 294       * @arg sig  {String} name of signal
 295       * @arg fn  {Function} handler.
 296       */
 297     addListener  : function(sig, fn)
 298     {
 299
 300         if (XObject.debug) Seed.print("Add signal " + sig);
 301
 302         var _li = XObject.createDelegate(fn,this);
 303         // private listeners that are not copied to GTk.
 304
 305         if (typeof(Seed) != 'undefined') {
 306           //   Seed.print(typeof(_li));
 307             this.el.signal[sig].connect(_li);
 308         } else {
 309             this.el.connect( sig, _li);
 310         }
 311
 312
 313     },
 314      /**
 315       * @method get
 316       * Finds an object in the child elements using xid of object.
 317       * prefix with '.' to look up the tree..
 318       * prefix with multiple '..' to look further up..
 319       * prefix with '/' to look from the top, eg. '^LeftTree.model'
 320       *
 321       * @arg name  {String} name of signal
 322       * @return   {XObject|false} the object if found.
 323       */
 324     get : function(xid)
 325     {
 326         if (XObject.debug) print("SEARCH FOR " + xid + " in " + this.id);
 327         var ret=  false;
 328         var oid = '' + xid;
 329         if (!xid.length) {
 330             throw {
 331                 name: "ArgumentError",
 332                 message : "ID not found : empty id"
 333             }
 334         }
 335
 336         if (xid[0] == '.') {
 337             return this.parent.get(xid.substring(1));
 338         }
 339         if (xid[0] == '/') {
 340             if (typeof(XObject.cache[xid]) != 'undefined') {
 341                 return XObject.cache[xid];
 342             }
 343             var e = this;
 344             while (e.parent) {
 345                 e = e.parent;
 346             }
 347
 348             try {
 349                 ret = e.get(xid.substring(1));
 350             } catch (ex) { }
 351
 352             if (!ret) {
 353                 throw {
 354                     name: "ArgumentError",
 355                     message : "ID not found : " + oid
 356                 }
 357             }
 358             XObject.cache[xid] = ret;
 359             return XObject.cache[xid];
 360         }
 361         var child = false;
 362
 363         if (xid.indexOf('.') > -1) {
 364             child = xid.split('.');
 365             xid = child.shift();
 366
 367             child = child.join('.');
 368
 369
 370
 371         }
 372         if (xid == this.id) {
 373             try {
 374                 return child === false ? this : this.get(child);
 375             } catch (ex) {
 376                 throw {
 377                     name: "ArgumentError",
 378                     message : "ID not found : " + oid
 379                 }
 380             }
 381
 382         }
 383
 384
 385         this.items.forEach(function(ch) {
 386             if (ret) {
 387                 return;
 388             }
 389             if (ch.id == xid) {
 390                 ret = ch;
 391             }
 392         })
 393         if (ret) {
 394             try {
 395                 return child === false ? ret : ret.get(child);
 396             } catch (ex) {
 397                 throw {
 398                     name: "ArgumentError",
 399                     message : "ID not found : " + oid
 400                 }
 401             }
 402
 403         }
 404         // iterate children.
 405         var _this = this;
 406         this.items.forEach(function(ch) {
 407             if (ret) {
 408                 return;
 409             }
 410             if (!ch.get) {
 411                 print("invalid item...");
 412                 imports.console.dump(_this);
 413                 Seed.quit();
 414             }
 415             try {
 416                 ret = ch.get(xid);
 417             } catch (ex) { }
 418
 419
 420         });
 421         if (!ret) {
 422             throw {
 423                 name: "ArgumentError",
 424                 message : "ID not found : " + oid
 425             }
 426         }
 427         try {
 428             return child === false ? ret : ret.get(child);
 429         } catch (ex) {
 430             throw {
 431                 name: "ArgumentError",
 432                 message : "ID not found : " + oid
 433             }
 434         }
 435     }
 436
 437
 438 }
 439
 440
 441 /**
 442  * Copies all the properties of config to obj.
 443  *
 444  * Pretty much the same as JQuery/Prototype..
 445  * @param {Object} obj The receiver of the properties
 446  * @param {Object} config The source of the properties
 447  * @param {Object} defaults A different object that will also be applied for default values
 448  * @return {Object} returns obj
 449  * @member XObject extend
 450  */
 451
 452
 453 XObject.extend = function(o, c, defaults){
 454     if(defaults){
 455         // no "this" reference for friendly out of scope calls
 456         XObject.extend(o, defaults);
 457     }
 458     if(o && c && typeof c == 'object'){
 459         for(var p in c){
 460             o[p] = c[p];
 461         }
 462     }
 463     return o;
 464 };
 465
 466 XObject.extend(XObject,
 467 {
 468
 469     /**
 470      * @property {Boolean} debug XObject  debugging.  - set to true to debug.
 471      *
 472      */
 473     debug : false,
 474     /**
 475      * @property {Object} cache - cache of object ids
 476      *
 477      */
 478     cache: { },
 479
 480     /**
 481      * Copies all the properties of config to obj, if the do not exist.
 482      * @param {Object} obj The receiver of the properties
 483      * @param {Object} config The source of the properties
 484      * @return {Object} returns obj
 485      * @member Object extendIf
 486      */
 487
 488
 489     extendIf : function(o, c){
 490
 491         if(!o || !c || typeof c != 'object'){
 492             return o;
 493         }
 494         for(var p in c){
 495             if (typeof(o[p]) != 'undefined') {
 496                 continue;
 497             }
 498             o[p] = c[p];
 499         }
 500         return o;
 501     },
 502
 503
 504
 505     /**
 506      * Extends one class with another class and optionally overrides members with the passed literal. This class
 507      * also adds the function "override()" to the class that can be used to override
 508      * members on an instance.
 509      *
 510      * usage:
 511      * MyObject = Object.define(
 512      *     function(...) {
 513      *          ....
 514      *     },
 515      *     parentClass, // or Object
 516      *     {
 517      *        ... methods and properties.
 518      *     }
 519      * });
 520      * @param {Function} constructor The class inheriting the functionality
 521      * @param {Object} superclass The class being extended
 522      * @param {Object} overrides (optional) A literal with members
 523      * @return {Function} constructor (eg. class
 524      * @method define
 525      */
 526     define : function(){
 527         // inline overrides
 528         var io = function(o){
 529             for(var m in o){
 530                 this[m] = o[m];
 531             }
 532         };
 533         return function(constructor, parentClass, overrides) {
 534             if (typeof(parentClass) == 'undefined') {
 535                 print("XObject.define: Missing parentClass: when applying: " );
 536                 print(new String(constructor));
 537                 Seed.quit();
 538             }
 539             if (typeof(parentClass.prototype) == 'undefined') {
 540                 print("Missing protype: when applying: " );
 541                 print(new String(constructor));
 542                 print(new String(parentClass));
 543                 Seed.quit();
 544             }
 545             var F = function(){};
 546             var sbp;
 547             var spp = parentClass.prototype;
 548
 549             F.prototype = spp;
 550             sbp = constructor.prototype = new F();
 551             sbp.constructor=constructor;
 552             constructor.superclass=spp;
 553
 554             // extends Object.
 555             if(spp.constructor == Object.prototype.constructor){
 556                 spp.constructor=parentClass;
 557             }
 558
 559             constructor.override = function(o){
 560                 Object.extend(constructor.prototype, o);
 561             };
 562             sbp.override = io;
 563             XObject.extend(constructor.prototype, overrides);
 564             return constructor;
 565         };
 566     }(),
 567
 568
 569     /**
 570      * returns a list of keys of the object.
 571      * @param {Object} obj object to inspect
 572      * @return {Array} returns list of kyes
 573      * @member XObject keys
 574      */
 575     keys : function(o)
 576     {
 577         var ret = [];
 578         for(var i in o) {
 579             ret.push(i);
 580         }
 581         return ret;
 582     },
 583
 584     /**
 585      * @member XObject createDelegate
 586      * creates a delage metdhod
 587      * @param {Function} method to wrap
 588      * @param {Object} scope
 589      * @param {Array} args to add
 590      * @param {Boolean|Number} append arguments or replace after N arguments.
 591      * @return {Function} returns the delegate
 592      */
 593
 594     createDelegate : function(method, obj, args, appendArgs){
 595
 596         return function() {
 597             var callArgs = args || arguments;
 598             if(appendArgs === true){
 599                 callArgs = Array.prototype.slice.call(arguments, 0);
 600                 callArgs = callArgs.concat(args);
 601             }else if(typeof appendArgs == "number"){
 602                 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
 603                     var applyArgs = [appendArgs, 0].concat(args); // create method call params
 604                     Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
 605                 }
 606                 return method.apply(obj || window, callArgs);
 607             };
 608     }
 609
 610 });