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