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