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