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