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         var gi = GIRepository.IRepository.get_default();
 158         var ty = gi.find_by_gtype(this.xtype.type);
 159         var write = [];
 160         for (var i =0; i < GIRepository.object_info_get_n_properties(ty);i++) {
 161             var p =   GIRepository.object_info_get_property(ty,i);
 162             if (GIRepository.property_info_get_flags(p) & GObject.ParamFlags.WRITABLE) {
 163                 write.push(GIRepository.base_info_get_name(p));
 164             }
 165         }
 166         print(write.join(','));
 167
 168
 169         for (var i in o) {
 170             this.el[i] = o[i];
 171         }
 172         // register it!
 173         //if (o.xnsid  && o.id) {
 174          //   XObject.registry = XObject.registry || { };
 175          //   XObject.registry[o.xnsid] = XObject.registry[o.xnsid] || {};
 176          //   XObject.registry[o.xnsid][o.id] = this;
 177         //}
 178
 179         cfg.items.forEach(this.addItem, this);
 180
 181         for (var i in this.listeners) {
 182             this.addListener(i, this.listeners[i]);
 183         }
 184         // delete this.listeners ?
 185
 186
 187         // do we need to call 'init here?'
 188     },
 189
 190
 191      /**
 192       * @method addItem
 193       * Adds an item to the object using a new XObject
 194       * uses pack property to determine how to add it.
 195       * @arg cfg {Object} same as XObject constructor.
 196       */
 197     addItem : function(o) {
 198
 199
 200         var item = (o.constructor == XObject) ? o : new XObject(o);
 201         item.init();
 202         item.parent = this;
 203         this.items.push(item);
 204
 205         if (item.pack===false) {  // no
 206             return;
 207         }
 208         if (typeof(item.pack) == 'function') {
 209             // parent, child
 210             item.pack.apply(o, [ o , o.items[i] ]);
 211             item.parent = this;
 212             return;
 213         }
 214         var args = [];
 215         var pack_m  = false;
 216         if (typeof(item.pack) == 'string') {
 217             pack_m = item.pack;
 218         } else {
 219             pack_m = item.pack.shift();
 220             args = item.pack;
 221         }
 222
 223         // handle error.
 224         if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
 225             Seed.print('pack method not available : ' + this.xtype + '.' +  pack_m);
 226             return;
 227         }
 228
 229
 230         //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
 231
 232         args.unshift(item.el);
 233         print('[' + args.join(',') +']');
 234         //Seed.print('args: ' + args.length);
 235         if (pack_m) {
 236             this.el[pack_m].apply(this.el, args);
 237         }
 238
 239
 240
 241     },
 242     /**
 243       * @method addListener
 244       * Connects a method to a signal. (gjs/Seed aware)
 245       *
 246       * @arg sig  {String} name of signal
 247       * @arg fn  {Function} handler.
 248       */
 249     addListener  : function(sig, fn)
 250     {
 251
 252         Seed.print("Add signal " + sig);
 253
 254         var _li = XObject.createDelegate(fn,this);
 255         // private listeners that are not copied to GTk.
 256
 257         if (typeof(Seed) != 'undefined') {
 258           //   Seed.print(typeof(_li));
 259             this.el.signal[sig].connect(_li);
 260         } else {
 261             this.el.connect( sig, _li);
 262         }
 263
 264
 265     },
 266      /**
 267       * @method get
 268       * Finds an object in the child elements using xid of object.
 269       * prefix with '.' to look up the tree.. multiple '..' to look further up..
 270       *
 271       * @arg name  {String} name of signal
 272       * @return   {XObject|false} the object if found.
 273       */
 274     get : function(xid)
 275     {
 276         var ret=  false;
 277         if (xid[0] == '.') {
 278             return this.parent.get(xid.substring(1));
 279         }
 280
 281
 282         this.items.forEach(function(ch) {
 283             if (ch.id == xid) {
 284                 ret = ch;
 285                 return true;
 286             }
 287         })
 288         if (ret) {
 289             return ret;
 290         }
 291         // iterate children.
 292         this.items.forEach(function(ch) {
 293             ret = ch.get(xid);
 294             if (ret) {
 295                 return true;
 296             }
 297         })
 298         return ret;
 299     }
 300
 301
 302 }
 303
 304
 305 /**
 306  * Copies all the properties of config to obj.
 307  *
 308  * Pretty much the same as JQuery/Prototype..
 309  * @param {Object} obj The receiver of the properties
 310  * @param {Object} config The source of the properties
 311  * @param {Object} defaults A different object that will also be applied for default values
 312  * @return {Object} returns obj
 313  * @member XObject extend
 314  */
 315
 316
 317 XObject.extend = function(o, c, defaults){
 318     if(defaults){
 319         // no "this" reference for friendly out of scope calls
 320         XObject.extend(o, defaults);
 321     }
 322     if(o && c && typeof c == 'object'){
 323         for(var p in c){
 324             o[p] = c[p];
 325         }
 326     }
 327     return o;
 328 };
 329
 330 XObject.extend(XObject,
 331 {
 332     /**
 333      * Copies all the properties of config to obj, if the do not exist.
 334      * @param {Object} obj The receiver of the properties
 335      * @param {Object} config The source of the properties
 336      * @return {Object} returns obj
 337      * @member Object extendIf
 338      */
 339
 340
 341     extendIf : function(o, c){
 342
 343         if(!o || !c || typeof c != 'object'){
 344             return o;
 345         }
 346         for(var p in c){
 347             if (typeof(o[p]) != 'undefined') {
 348                 continue;
 349             }
 350             o[p] = c[p];
 351         }
 352         return o;
 353     },
 354
 355
 356
 357     /**
 358      * Extends one class with another class and optionally overrides members with the passed literal. This class
 359      * also adds the function "override()" to the class that can be used to override
 360      * members on an instance.
 361      *
 362      * usage:
 363      * MyObject = Object.define(
 364      *     function(...) {
 365      *          ....
 366      *     },
 367      *     parentClass, // or Object
 368      *     {
 369      *        ... methods and properties.
 370      *     }
 371      * });
 372      * @param {Function} constructor The class inheriting the functionality
 373      * @param {Object} superclass The class being extended
 374      * @param {Object} overrides (optional) A literal with members
 375      * @return {Function} constructor (eg. class
 376      * @method define
 377      */
 378     define : function(){
 379         // inline overrides
 380         var io = function(o){
 381             for(var m in o){
 382                 this[m] = o[m];
 383             }
 384         };
 385         return function(constructor, parentClass, overrides) {
 386             if (typeof(parentClass) == 'undefined') {
 387                 print("XObject.define: Missing parentClass: when applying: " );
 388                 print(new String(constructor));
 389                 Seed.quit();
 390             }
 391             if (typeof(parentClass.prototype) == 'undefined') {
 392                 print("Missing protype: when applying: " );
 393                 print(new String(constructor));
 394                 print(new String(parentClass));
 395                 Seed.quit();
 396             }
 397             var F = function(){};
 398             var sbp;
 399             var spp = parentClass.prototype;
 400
 401             F.prototype = spp;
 402             sbp = constructor.prototype = new F();
 403             sbp.constructor=constructor;
 404             constructor.superclass=spp;
 405
 406             // extends Object.
 407             if(spp.constructor == Object.prototype.constructor){
 408                 spp.constructor=parentClass;
 409             }
 410
 411             constructor.override = function(o){
 412                 Object.extend(constructor.prototype, o);
 413             };
 414             sbp.override = io;
 415             XObject.extend(constructor.prototype, overrides);
 416             return constructor;
 417         };
 418     }(),
 419
 420
 421     /**
 422      * returns a list of keys of the object.
 423      * @param {Object} obj object to inspect
 424      * @return {Array} returns list of kyes
 425      * @member XObject keys
 426      */
 427     keys : function(o)
 428     {
 429         var ret = [];
 430         for(var i in o) {
 431             ret.push(i);
 432         }
 433         return ret;
 434     },
 435
 436     /**
 437      * @member XObject createDelegate
 438      * creates a delage metdhod
 439      * @param {Function} method to wrap
 440      * @param {Object} scope
 441      * @param {Array} args to add
 442      * @param {Boolean|Number} append arguments or replace after N arguments.
 443      * @return {Function} returns the delegate
 444      */
 445
 446     createDelegate : function(method, obj, args, appendArgs){
 447
 448         return function() {
 449             var callArgs = args || arguments;
 450             if(appendArgs === true){
 451                 callArgs = Array.prototype.slice.call(arguments, 0);
 452                 callArgs = callArgs.concat(args);
 453             }else if(typeof appendArgs == "number"){
 454                 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
 455                     var applyArgs = [appendArgs, 0].concat(args); // create method call params
 456                     Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
 457                 }
 458                 return method.apply(obj || window, callArgs);
 459             };
 460     }
 461
 462 });