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     this.config = cfg;
  54     if (cfg.init) {
  55         this.init = cfg.init; // override!
  56     }
  57
  58
  59 }
  60
  61
  62
  63 XObject.prototype = {
  64     /**
  65      * @property el {GObject} the Gtk / etc. element.
  66      */
  67     el : false,
  68     /*
  69      * @property items {Array} list of sub elements
  70      */
  71     /**
  72      * @property parent {XObject} parent Element
  73      */
  74
  75      /**
  76      * @property config {Object} the construction configuration.
  77      */
  78      /**
  79       * @method init
  80       * Initializes the Element (el) hooks up all the listeners
  81       * and packs the children.
  82       * you can override this, in child objects, then
  83       * do this to do thi initaliztion.
  84       *
  85       * XObject.prototype.init.call(this);
  86       *
  87       */
  88     init : function()
  89     {
  90         var cfg = this.config;
  91
  92         print("new xobj?"  + XObject.keys(cfg).join(','));
  93         //print(cfg);
  94         o =  {};
  95
  96         cfg.items = cfg.items || [];
  97
  98         XObject.extend(o, cfg); // copy everything into o.
  99
 100         o.pack = typeof(o.pack) == 'undefined' ? 'add' : o.pack;
 101
 102         XObject.extend(this, o);
 103
 104         // remove items.
 105
 106         this.listeners = this.listeners || {};
 107         this.items = [];
 108
 109         // remove objects/functions from o, so they can be sent to the contructor.
 110         for (var i in o) {
 111             if ((typeof(o[i]) == 'object') ||
 112                 (typeof(o[i]) == 'function') ||
 113                 i == 'pack' ||
 114                 i == 'id' ||
 115                 i == 'xtype' ||
 116                 i == 'xdebug' ||
 117                 i == 'xns'
 118             ) {
 119                 delete o[i];
 120             }
 121         }
 122
 123         // do we need to call 'beforeInit here?'
 124
 125         // handle include?
 126         //if ((this.xtype == 'Include')) {
 127         //    o = this.pre_registry[cls];
 128         //}
 129         var isSeed = typeof(Seed) != 'undefined';
 130
 131         // xtype= Gtk.Menu ?? what about c_new stuff?
 132         print(this.xtype);
 133         if (typeof(this.xtype) == 'function') {
 134             print("func?"  + XObject.keys(o).join(','));
 135             this.el = this.el ||   this.xtype(o);
 136         }
 137         if (typeof(this.xtype) == 'object') {
 138             print("obj?"  + XObject.keys(o).join(','));
 139             this.el = this.el ||  new this.xtype(o);
 140         }
 141         //print(this.el);
 142         if (!this.el && o.xns) {
 143
 144             var NS = imports.gi[o.xns];
 145             if (!NS) {
 146                 Seed.print('Invalid xns: ' + o.xns);
 147             }
 148             constructor = NS[o.xtype];
 149             if (!constructor) {
 150                 Seed.print('Invalid xtype: ' + o.xns + '.' + o.xtype);
 151             }
 152             this.el  =   isSeed ? new constructor(o) : new constructor();
 153
 154         }
 155         // always overlay props..
 156         // check for 'write' on object..
 157         /*
 158         if (typeof(XObject.writeablePropsCache[this.xtype.type]) == 'undefined') {
 159
 160             var gi = GIRepository.IRepository.get_default();
 161             var ty = gi.find_by_gtype(this.xtype.type);
 162             var write = [];
 163             for (var i =0; i < GIRepository.object_info_get_n_properties(ty);i++) {
 164                 var p =   GIRepository.object_info_get_property(ty,i);
 165                 if (GIRepository.property_info_get_flags(p) & 2) {
 166                     write.push(GIRepository.base_info_get_name(p));
 167                 }
 168             }
 169             XObject.writeablePropsCache[this.xtype.type] = write;
 170             print(write.join(", "));
 171         }
 172
 173         */
 174
 175         for (var i in o) {
 176             // only write to writable properties
 177           //  if (XObject.writeablePropsCache[this.xtype.type].indexOf(i) < 0) {
 178           //      continue;
 179            // }
 180             this.el[i] = o[i];
 181         }
 182         // register it!
 183         //if (o.xnsid  && o.id) {
 184          //   XObject.registry = XObject.registry || { };
 185          //   XObject.registry[o.xnsid] = XObject.registry[o.xnsid] || {};
 186          //   XObject.registry[o.xnsid][o.id] = this;
 187         //}
 188
 189         cfg.items.forEach(this.addItem, this);
 190
 191         for (var i in this.listeners) {
 192             this.addListener(i, this.listeners[i]);
 193         }
 194         // delete this.listeners ?
 195
 196
 197         // do we need to call 'init here?'
 198     },
 199
 200
 201      /**
 202       * @method addItem
 203       * Adds an item to the object using a new XObject
 204       * uses pack property to determine how to add it.
 205       * @arg cfg {Object} same as XObject constructor.
 206       */
 207     addItem : function(o) {
 208
 209
 210         print(o.constructor );
 211
 212         var item = (o.constructor == XObject) ? o : new XObject(o);
 213         print("addItem - call init");
 214         item.init();
 215
 216         item.parent = this;
 217         this.items.push(item);
 218
 219         if (item.pack===false) {  // no
 220             return;
 221         }
 222         if (typeof(item.pack) == 'function') {
 223             // parent, child
 224             item.pack.apply(o, [ o , o.items[i] ]);
 225             item.parent = this;
 226             return;
 227         }
 228         var args = [];
 229         var pack_m  = false;
 230         if (typeof(item.pack) == 'string') {
 231             pack_m = item.pack;
 232         } else {
 233             pack_m = item.pack.shift();
 234             args = item.pack;
 235         }
 236
 237         // handle error.
 238         if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
 239             Seed.print('pack method not available : ' + this.xtype + '.' +  pack_m);
 240             return;
 241         }
 242
 243
 244         //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
 245
 246         args.unshift(item.el);
 247         print('[' + args.join(',') +']');
 248         //Seed.print('args: ' + args.length);
 249         if (pack_m) {
 250             this.el[pack_m].apply(this.el, args);
 251         }
 252
 253
 254
 255     },
 256     /**
 257       * @method addListener
 258       * Connects a method to a signal. (gjs/Seed aware)
 259       *
 260       * @arg sig  {String} name of signal
 261       * @arg fn  {Function} handler.
 262       */
 263     addListener  : function(sig, fn)
 264     {
 265
 266         Seed.print("Add signal " + sig);
 267
 268         var _li = XObject.createDelegate(fn,this);
 269         // private listeners that are not copied to GTk.
 270
 271         if (typeof(Seed) != 'undefined') {
 272           //   Seed.print(typeof(_li));
 273             this.el.signal[sig].connect(_li);
 274         } else {
 275             this.el.connect( sig, _li);
 276         }
 277
 278
 279     },
 280      /**
 281       * @method get
 282       * Finds an object in the child elements using xid of object.
 283       * prefix with '.' to look up the tree.. multiple '..' to look further up..
 284       *
 285       * @arg name  {String} name of signal
 286       * @return   {XObject|false} the object if found.
 287       */
 288     get : function(xid)
 289     {
 290         var ret=  false;
 291         if (xid[0] == '.') {
 292             return this.parent.get(xid.substring(1));
 293         }
 294
 295
 296         this.items.forEach(function(ch) {
 297             if (ch.id == xid) {
 298                 ret = ch;
 299                 return true;
 300             }
 301         })
 302         if (ret) {
 303             return ret;
 304         }
 305         // iterate children.
 306         this.items.forEach(function(ch) {
 307             ret = ch.get(xid);
 308             if (ret) {
 309                 return true;
 310             }
 311         })
 312         return ret;
 313     }
 314
 315
 316 }
 317
 318
 319 XObject.writeablePropsCache = { };
 320
 321 /**
 322  * Copies all the properties of config to obj.
 323  *
 324  * Pretty much the same as JQuery/Prototype..
 325  * @param {Object} obj The receiver of the properties
 326  * @param {Object} config The source of the properties
 327  * @param {Object} defaults A different object that will also be applied for default values
 328  * @return {Object} returns obj
 329  * @member XObject extend
 330  */
 331
 332
 333 XObject.extend = function(o, c, defaults){
 334     if(defaults){
 335         // no "this" reference for friendly out of scope calls
 336         XObject.extend(o, defaults);
 337     }
 338     if(o && c && typeof c == 'object'){
 339         for(var p in c){
 340             o[p] = c[p];
 341         }
 342     }
 343     return o;
 344 };
 345
 346 XObject.extend(XObject,
 347 {
 348     /**
 349      * Copies all the properties of config to obj, if the do not exist.
 350      * @param {Object} obj The receiver of the properties
 351      * @param {Object} config The source of the properties
 352      * @return {Object} returns obj
 353      * @member Object extendIf
 354      */
 355
 356
 357     extendIf : function(o, c){
 358
 359         if(!o || !c || typeof c != 'object'){
 360             return o;
 361         }
 362         for(var p in c){
 363             if (typeof(o[p]) != 'undefined') {
 364                 continue;
 365             }
 366             o[p] = c[p];
 367         }
 368         return o;
 369     },
 370
 371
 372
 373     /**
 374      * Extends one class with another class and optionally overrides members with the passed literal. This class
 375      * also adds the function "override()" to the class that can be used to override
 376      * members on an instance.
 377      *
 378      * usage:
 379      * MyObject = Object.define(
 380      *     function(...) {
 381      *          ....
 382      *     },
 383      *     parentClass, // or Object
 384      *     {
 385      *        ... methods and properties.
 386      *     }
 387      * });
 388      * @param {Function} constructor The class inheriting the functionality
 389      * @param {Object} superclass The class being extended
 390      * @param {Object} overrides (optional) A literal with members
 391      * @return {Function} constructor (eg. class
 392      * @method define
 393      */
 394     define : function(){
 395         // inline overrides
 396         var io = function(o){
 397             for(var m in o){
 398                 this[m] = o[m];
 399             }
 400         };
 401         return function(constructor, parentClass, overrides) {
 402             if (typeof(parentClass) == 'undefined') {
 403                 print("XObject.define: Missing parentClass: when applying: " );
 404                 print(new String(constructor));
 405                 Seed.quit();
 406             }
 407             if (typeof(parentClass.prototype) == 'undefined') {
 408                 print("Missing protype: when applying: " );
 409                 print(new String(constructor));
 410                 print(new String(parentClass));
 411                 Seed.quit();
 412             }
 413             var F = function(){};
 414             var sbp;
 415             var spp = parentClass.prototype;
 416
 417             F.prototype = spp;
 418             sbp = constructor.prototype = new F();
 419             sbp.constructor=constructor;
 420             constructor.superclass=spp;
 421
 422             // extends Object.
 423             if(spp.constructor == Object.prototype.constructor){
 424                 spp.constructor=parentClass;
 425             }
 426
 427             constructor.override = function(o){
 428                 Object.extend(constructor.prototype, o);
 429             };
 430             sbp.override = io;
 431             XObject.extend(constructor.prototype, overrides);
 432             return constructor;
 433         };
 434     }(),
 435
 436
 437     /**
 438      * returns a list of keys of the object.
 439      * @param {Object} obj object to inspect
 440      * @return {Array} returns list of kyes
 441      * @member XObject keys
 442      */
 443     keys : function(o)
 444     {
 445         var ret = [];
 446         for(var i in o) {
 447             ret.push(i);
 448         }
 449         return ret;
 450     },
 451
 452     /**
 453      * @member XObject createDelegate
 454      * creates a delage metdhod
 455      * @param {Function} method to wrap
 456      * @param {Object} scope
 457      * @param {Array} args to add
 458      * @param {Boolean|Number} append arguments or replace after N arguments.
 459      * @return {Function} returns the delegate
 460      */
 461
 462     createDelegate : function(method, obj, args, appendArgs){
 463
 464         return function() {
 465             var callArgs = args || arguments;
 466             if(appendArgs === true){
 467                 callArgs = Array.prototype.slice.call(arguments, 0);
 468                 callArgs = callArgs.concat(args);
 469             }else if(typeof appendArgs == "number"){
 470                 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
 471                     var applyArgs = [appendArgs, 0].concat(args); // create method call params
 472                     Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
 473                 }
 474                 return method.apply(obj || window, callArgs);
 475             };
 476     }
 477
 478 });