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