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         if (item.pack===false) {  // no
 245             return;
 246         }
 247         if (typeof(item.pack) == 'function') {
 248             // parent, child
 249             item.pack.apply(item, [ this , item  ]);
 250             item.parent = this;
 251             return;
 252         }
 253         var args = [];
 254         var pack_m  = false;
 255         if (typeof(item.pack) == 'string') {
 256
 257             item.pack.split(',').forEach(function(e, i) {
 258
 259                 if (e == 'false') { args.push( false); return; }
 260                 if (e == 'true') {  args.push( true);  return; }
 261                 if (!isNaN(parseInt(e))) { args.push( parseInt(e)); return; }
 262                 args.push(e);
 263             });
 264             //print(args.join(","));
 265
 266             pack_m = args.shift();
 267         } else {
 268             pack_m = item.pack.shift();
 269             args = item.pack;
 270         }
 271
 272         // handle error.
 273         if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
 274             Seed.print('pack method not available : ' + this.xtype + '.' +  pack_m);
 275             return;
 276         }
 277
 278
 279         //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
 280
 281         args.unshift(item.el);
 282         if (XObject.debug) print(pack_m + '[' + args.join(',') +']');
 283         //Seed.print('args: ' + args.length);
 284         if (pack_m) {
 285             this.el[pack_m].apply(this.el, args);
 286         }
 287
 288
 289
 290     },
 291     /**
 292       * @method addListener
 293       * Connects a method to a signal. (gjs/Seed aware)
 294       *
 295       * @arg sig  {String} name of signal
 296       * @arg fn  {Function} handler.
 297       */
 298     addListener  : function(sig, fn)
 299     {
 300
 301         if (XObject.debug) Seed.print("Add signal " + sig);
 302
 303         var _li = XObject.createDelegate(fn,this);
 304         // private listeners that are not copied to GTk.
 305
 306         if (typeof(Seed) != 'undefined') {
 307           //   Seed.print(typeof(_li));
 308             this.el.signal[sig].connect(_li);
 309         } else {
 310             this.el.connect( sig, _li);
 311         }
 312
 313
 314     },
 315      /**
 316       * @method get
 317       * Finds an object in the child elements using xid of object.
 318       * prefix with '.' to look up the tree..
 319       * prefix with multiple '..' to look further up..
 320       * prefix with '/' to look from the top, eg. '^LeftTree.model'
 321       *
 322       * @arg name  {String} name of signal
 323       * @return   {XObject|false} the object if found.
 324       */
 325     get : function(xid)
 326     {
 327         if (XObject.debug) print("SEARCH FOR " + xid + " in " + this.id);
 328         var ret=  false;
 329         var oid = '' + xid;
 330         if (!xid.length) {
 331             throw {
 332                 name: "ArgumentError",
 333                 message : "ID not found : empty id"
 334             }
 335         }
 336
 337         if (xid[0] == '.') {
 338             return this.parent.get(xid.substring(1));
 339         }
 340         if (xid[0] == '/') {
 341             if (typeof(XObject.cache[xid]) != 'undefined') {
 342                 return XObject.cache[xid];
 343             }
 344             var e = this;
 345             while (e.parent) {
 346                 e = e.parent;
 347             }
 348
 349             try {
 350                 ret = e.get(xid.substring(1));
 351             } catch (ex) { }
 352
 353             if (!ret) {
 354                 throw {
 355                     name: "ArgumentError",
 356                     message : "ID not found : " + oid
 357                 }
 358             }
 359             XObject.cache[xid] = ret;
 360             return XObject.cache[xid];
 361         }
 362         var child = false;
 363
 364         if (xid.indexOf('.') > -1) {
 365             child = xid.split('.');
 366             xid = child.shift();
 367
 368             child = child.join('.');
 369
 370
 371
 372         }
 373         if (xid == this.id) {
 374             try {
 375                 return child === false ? this : this.get(child);
 376             } catch (ex) {
 377                 throw {
 378                     name: "ArgumentError",
 379                     message : "ID not found : " + oid
 380                 }
 381             }
 382
 383         }
 384
 385
 386         this.items.forEach(function(ch) {
 387             if (ret) {
 388                 return;
 389             }
 390             if (ch.id == xid) {
 391                 ret = ch;
 392             }
 393         })
 394         if (ret) {
 395             try {
 396                 return child === false ? ret : ret.get(child);
 397             } catch (ex) {
 398                 throw {
 399                     name: "ArgumentError",
 400                     message : "ID not found : " + oid
 401                 }
 402             }
 403
 404         }
 405         // iterate children.
 406         var _this = this;
 407         this.items.forEach(function(ch) {
 408             if (ret) {
 409                 return;
 410             }
 411             if (!ch.get) {
 412                 print("invalid item...");
 413                 imports.console.dump(_this);
 414                 Seed.quit();
 415             }
 416             try {
 417                 ret = ch.get(xid);
 418             } catch (ex) { }
 419
 420
 421         });
 422         if (!ret) {
 423             throw {
 424                 name: "ArgumentError",
 425                 message : "ID not found : " + oid
 426             }
 427         }
 428         try {
 429             return child === false ? ret : ret.get(child);
 430         } catch (ex) {
 431             throw {
 432                 name: "ArgumentError",
 433                 message : "ID not found : " + oid
 434             }
 435         }
 436     }
 437
 438
 439 }
 440
 441
 442 /**
 443  * Copies all the properties of config to obj.
 444  *
 445  * Pretty much the same as JQuery/Prototype..
 446  * @param {Object} obj The receiver of the properties
 447  * @param {Object} config The source of the properties
 448  * @param {Object} defaults A different object that will also be applied for default values
 449  * @return {Object} returns obj
 450  * @member XObject extend
 451  */
 452
 453
 454 XObject.extend = function(o, c, defaults){
 455     if(defaults){
 456         // no "this" reference for friendly out of scope calls
 457         XObject.extend(o, defaults);
 458     }
 459     if(o && c && typeof c == 'object'){
 460         for(var p in c){
 461             o[p] = c[p];
 462         }
 463     }
 464     return o;
 465 };
 466
 467 XObject.extend(XObject,
 468 {
 469
 470     /**
 471      * @property {Boolean} debug XObject  debugging.  - set to true to debug.
 472      *
 473      */
 474     debug : true,
 475     /**
 476      * @property {Object} cache - cache of object ids
 477      *
 478      */
 479     cache: { },
 480
 481     /**
 482      * Copies all the properties of config to obj, if the do not exist.
 483      * @param {Object} obj The receiver of the properties
 484      * @param {Object} config The source of the properties
 485      * @return {Object} returns obj
 486      * @member Object extendIf
 487      */
 488
 489
 490     extendIf : function(o, c){
 491
 492         if(!o || !c || typeof c != 'object'){
 493             return o;
 494         }
 495         for(var p in c){
 496             if (typeof(o[p]) != 'undefined') {
 497                 continue;
 498             }
 499             o[p] = c[p];
 500         }
 501         return o;
 502     },
 503
 504
 505
 506     /**
 507      * Extends one class with another class and optionally overrides members with the passed literal. This class
 508      * also adds the function "override()" to the class that can be used to override
 509      * members on an instance.
 510      *
 511      * usage:
 512      * MyObject = Object.define(
 513      *     function(...) {
 514      *          ....
 515      *     },
 516      *     parentClass, // or Object
 517      *     {
 518      *        ... methods and properties.
 519      *     }
 520      * });
 521      * @param {Function} constructor The class inheriting the functionality
 522      * @param {Object} superclass The class being extended
 523      * @param {Object} overrides (optional) A literal with members
 524      * @return {Function} constructor (eg. class
 525      * @method define
 526      */
 527     define : function(){
 528         // inline overrides
 529         var io = function(o){
 530             for(var m in o){
 531                 this[m] = o[m];
 532             }
 533         };
 534         return function(constructor, parentClass, overrides) {
 535             if (typeof(parentClass) == 'undefined') {
 536                 print("XObject.define: Missing parentClass: when applying: " );
 537                 print(new String(constructor));
 538                 Seed.quit();
 539             }
 540             if (typeof(parentClass.prototype) == 'undefined') {
 541                 print("Missing protype: when applying: " );
 542                 print(new String(constructor));
 543                 print(new String(parentClass));
 544                 Seed.quit();
 545             }
 546             var F = function(){};
 547             var sbp;
 548             var spp = parentClass.prototype;
 549
 550             F.prototype = spp;
 551             sbp = constructor.prototype = new F();
 552             sbp.constructor=constructor;
 553             constructor.superclass=spp;
 554
 555             // extends Object.
 556             if(spp.constructor == Object.prototype.constructor){
 557                 spp.constructor=parentClass;
 558             }
 559
 560             constructor.override = function(o){
 561                 Object.extend(constructor.prototype, o);
 562             };
 563             sbp.override = io;
 564             XObject.extend(constructor.prototype, overrides);
 565             return constructor;
 566         };
 567     }(),
 568
 569
 570     /**
 571      * returns a list of keys of the object.
 572      * @param {Object} obj object to inspect
 573      * @return {Array} returns list of kyes
 574      * @member XObject keys
 575      */
 576     keys : function(o)
 577     {
 578         var ret = [];
 579         for(var i in o) {
 580             ret.push(i);
 581         }
 582         return ret;
 583     },
 584
 585     /**
 586      * @member XObject createDelegate
 587      * creates a delage metdhod
 588      * @param {Function} method to wrap
 589      * @param {Object} scope
 590      * @param {Array} args to add
 591      * @param {Boolean|Number} append arguments or replace after N arguments.
 592      * @return {Function} returns the delegate
 593      */
 594
 595     createDelegate : function(method, obj, args, appendArgs){
 596
 597         return function() {
 598             var callArgs = args || arguments;
 599             if(appendArgs === true){
 600                 callArgs = Array.prototype.slice.call(arguments, 0);
 601                 callArgs = callArgs.concat(args);
 602             }else if(typeof appendArgs == "number"){
 603                 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
 604                     var applyArgs = [appendArgs, 0].concat(args); // create method call params
 605                     Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
 606                 }
 607                 return method.apply(obj || window, callArgs);
 608             };
 609     }
 610
 611 });