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