XObject.js

[app.Builder.js] / XObject.js

//<script type="text/javascript">
GIRepository = imports.gi.GIRepository;
GObject = imports.gi.GObject;
/**
 * XObject
 * Yet another attempt to create a usable object construction library for seed..
 * 
 * Why is this useful?
 * A) It turns rather messy code into a tree structure, making it easy to find code relating to 
 *    an interface element
 * B) In theory it should be gjs/Seed compatible..
 * C) It provides getElementById style lookups for elements.
 * D) It provides classic OO constructors for Javascript (extend/define)
 * E) It does not modify any buildin prototypes.. 
 *
 * Extend this.. to use it's wonderful features..
 * 
 * normal usage:
 * XObject = imports.XObject.XObject;
 * 
 * Xyz = new XObject({
 *     xtype: Gtk.Window,
 *     id : 'window',
 *     items : [
 *     
 *     ]
 *  });
 *  Xyz.init(); // create and show.
 * 
 * 
 * 
 * @arg xtype {String|Function} constructor or string.
 * @arg id {String}  (optional) id for registry
 * @arg xns {String|Object}   (optional) namespace eg. Gtk or 'Gtk' - used with xtype.
 * @arg items {Array}   (optional) list of child elements which will be constructed.. using XObject
 * @arg listeners {Object}   (optional) map Gobject signals to functions
 * @arg pack {Function|String|Array}   (optional) how this object gets added to it's parent
 * @arg el {Object}   (optional) premade GObject
 * 
 *  --- needs a xdebug option!
 * 
 * 
 * He's some questions.
 * - should we generate ID's for all elements? (if so we probably need to garbage collect)
 * - should we have a special property to use as the constructor / gobject.properties rather
 *   than sending all basic types to this?
 * 
 * 
 */

function XObject (cfg) {
    // first apply cfg if set.
      //print("new XOBJECT!!!");
    this.config = {};
    this.constructor = XObject;
    
    // copy down all elements into self..
    
    for (var i in cfg) {
        this[i] = cfg[i];
        if ((typeof(cfg[i]) == 'function') || (typeof(cfg[i]) == 'function')) {
            continue;
        }
        // these properties are not copied to cfg.
        if (i == 'pack' ||
                i == 'id' ||
                i == 'xtype' ||
                i == 'xdebug' ||
                i == 'xns') {
            continue;
        }
        
        
        this.config[i] = cfg[i];
    }
    this.items = this.items || [];
    // pack can be false!
    this.pack = typeof(this.pack) == 'undefined' ? ['add'] : this.pack;
    
    
}



XObject.prototype = {
    /**
     * @property el {GObject} the Gtk / etc. element.
     */
    el : false, 
    /*
     * @property items {Array} list of sub elements
     */
    /**
     * @property parent {XObject} parent Element
     */
     
     /**
     * @property config {Object} the construction configuration.
     */
     /**
      * @method init
      * Initializes the Element (el) hooks up all the listeners
      * and packs the children.
      * you can override this, in child objects, then 
      * do this to do thi initaliztion.
      * 
      * XObject.prototype.init.call(this); 
      * 
      */ 
    init : function()
    {
         
        var items = [];
        this.items.forEach(function(i) {
            items.push(i);
        });
        // remove items.
        this.listeners = this.listeners || {}; 
        this.items = [];
         
        // do we need to call 'beforeInit here?'
         
        // handle include?
        //if ((this.xtype == 'Include')) {
        //    o = this.pre_registry[cls];
        //}
        var isSeed = typeof(Seed) != 'undefined';
         
        // xtype= Gtk.Menu ?? what about c_new stuff?
        if (XObject.debug) print("init: typeof(xtype): "  + typeof(this.xtype));
        if (!this.el && typeof(this.xtype) == 'function') {
            if (XObject.debug) print("func?"  + XObject.keys(this.config).join(','));
            this.el = this.xtype(this.config);
        }
        if (!this.el && typeof(this.xtype) == 'object') {
            if (XObject.debug) print("obj?"  + XObject.keys(this.config).join(','));
            this.el = new (this.xtype)(this.config);
        }
        //print(this.el);
        if (!this.el && this.xns) {
            
            var NS = imports.gi[this.xns];
            if (!NS) {
                Seed.print('Invalid xns: ' + this.xns);
            }
            constructor = NS[this.xtype];
            if (!constructor) {
                Seed.print('Invalid xtype: ' + this.xns + '.' + this.xtype);
            }
            this.el  =   isSeed ? new constructor(this.config) : new constructor();
            
        }
        if (XObject.debug) print("init: typeof(el):" + typeof(this.el));
        
        // always overlay props..
        // check for 'write' on object..
        /*
        if (typeof(XObject.writeablePropsCache[this.xtype.type]) == 'undefined') {
                
            var gi = GIRepository.IRepository.get_default();
            var ty = gi.find_by_gtype(this.xtype.type);
            var write = [];
            for (var i =0; i < GIRepository.object_info_get_n_properties(ty);i++) {
                var p =   GIRepository.object_info_get_property(ty,i);
                if (GIRepository.property_info_get_flags(p) & 2) {
                    write.push(GIRepository.base_info_get_name(p));
                }
            }
            XObject.writeablePropsCache[this.xtype.type] = write;
            print(write.join(", "));
        }
        
        */
        
        for (var i in this.config) {
            // only write to writable properties
          //  if (XObject.writeablePropsCache[this.xtype.type].indexOf(i) < 0) {
          //      continue;
           // }
            this.el[i] = this.config[i];
        }
        // register it!
        //if (o.xnsid  && o.id) {
         //   XObject.registry = XObject.registry || { };
         //   XObject.registry[o.xnsid] = XObject.registry[o.xnsid] || {}; 
         //   XObject.registry[o.xnsid][o.id] = this;
        //}
        var _this=this;
        items.forEach(function(i) {
            _this.addItem(i);
        })
            
        
        for (var i in this.listeners) {
            this.addListener(i, this.listeners[i]);
        }
        // delete this.listeners ?
        
        
        // do we need to call 'init here?'
    },
      
     
     /**
      * @method addItem
      * Adds an item to the object using a new XObject
      * uses pack property to determine how to add it.
      * @arg cfg {Object} same as XObject constructor.
      */
    addItem : function(o) {
        if (typeof(o) == 'undefined') {
            print("Invalid Item added to this!");
            imports.console.dump(this);
            Seed.quit();
           }
        
        var item = (o.constructor == XObject) ? o : new XObject(o);
       
        item.init();
        //print("CTR:PROTO:" + ( item.id ? item.id : '??'));
       // print("addItem - call init [" + item.pack.join(',') + ']');
        if (!item.el) {
            print("NO EL!");
            imports.console.dump(item);
            Seed.quit();
        }
        
        item.parent = this;
        this.items.push(item);
        
        if (item.pack===false) {  // no 
            return;
        }
        if (typeof(item.pack) == 'function') {
            // parent, child
            item.pack.apply(o, [ o , o.items[i] ]);
            item.parent = this;
            return;
        }
        var args = [];
        var pack_m  = false;
        if (typeof(item.pack) == 'string') {
            pack_m = item.pack;
        } else {
            pack_m = item.pack.shift();
            args = item.pack;
        }
        
        // handle error.
        if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
            Seed.print('pack method not available : ' + this.xtype + '.' +  pack_m);
            return;
        }
        
        
        //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');

        args.unshift(item.el);
        if (XObject.debug) print('[' + args.join(',') +']');
        //Seed.print('args: ' + args.length);
        if (pack_m) {
            this.el[pack_m].apply(this.el, args);
        }
        
       
        
    },
    /**
      * @method addListener
      * Connects a method to a signal. (gjs/Seed aware)
      * 
      * @arg sig  {String} name of signal
      * @arg fn  {Function} handler.
      */
    addListener  : function(sig, fn) 
    {
 
        if (XObject.debug) Seed.print("Add signal " + sig);
 
        var _li = XObject.createDelegate(fn,this);
        // private listeners that are not copied to GTk.
        
        if (typeof(Seed) != 'undefined') {
          //   Seed.print(typeof(_li));
            this.el.signal[sig].connect(_li);
        } else {
            this.el.connect( sig, _li);
        }
             
        
    },
     /**
      * @method get
      * Finds an object in the child elements using xid of object.
      * prefix with '.' to look up the tree.. multiple '..' to look further up..
      * 
      * @arg name  {String} name of signal
      * @return   {XObject|false} the object if found.
      */
    get : function(xid)
    {
        var ret=  false;
        if (xid[0] == '.') {
            return this.parent.get(xid.substring(1));
        }
        
        
        this.items.forEach(function(ch) {
            if (ch.id == xid) {
                ret = ch;
                return true;
            }
        })
        if (ret) {
            return ret;
        }
        // iterate children.
        this.items.forEach(function(ch) {
            ret = ch.get(xid);
            if (ret) {
                return true;
            }
        })
        return ret;
    }
      
      
} 
         
     
/**
 * Copies all the properties of config to obj.
 *
 * Pretty much the same as JQuery/Prototype..
 * @param {Object} obj The receiver of the properties
 * @param {Object} config The source of the properties
 * @param {Object} defaults A different object that will also be applied for default values
 * @return {Object} returns obj
 * @member XObject extend
 */


XObject.extend = function(o, c, defaults){
    if(defaults){
        // no "this" reference for friendly out of scope calls
        XObject.extend(o, defaults);
    }
    if(o && c && typeof c == 'object'){
        for(var p in c){
            o[p] = c[p];
        }
    }
    return o;
};

XObject.extend(XObject,
{
    /**
     * @property {Boolean} debug XObject  debugging.  - set to true to debug.
     * 
     */
    debug : false,
    /**
     * Copies all the properties of config to obj, if the do not exist.
     * @param {Object} obj The receiver of the properties
     * @param {Object} config The source of the properties
     * @return {Object} returns obj
     * @member Object extendIf
     */


    extendIf : function(o, c){

        if(!o || !c || typeof c != 'object'){
            return o;
        }
        for(var p in c){
            if (typeof(o[p]) != 'undefined') {
                continue;
            }
            o[p] = c[p];
        }
        return o;
    },

 

    /**
     * Extends one class with another class and optionally overrides members with the passed literal. This class
     * also adds the function "override()" to the class that can be used to override
     * members on an instance.
     *
     * usage:
     * MyObject = Object.define(
     *     function(...) {
     *          ....
     *     },
     *     parentClass, // or Object
     *     {
     *        ... methods and properties.
     *     }
     * });
     * @param {Function} constructor The class inheriting the functionality
     * @param {Object} superclass The class being extended
     * @param {Object} overrides (optional) A literal with members
     * @return {Function} constructor (eg. class
     * @method define
     */
    define : function(){
        // inline overrides
        var io = function(o){
            for(var m in o){
                this[m] = o[m];
            }
        };
        return function(constructor, parentClass, overrides) {
            if (typeof(parentClass) == 'undefined') {
                print("XObject.define: Missing parentClass: when applying: " );
                print(new String(constructor));
                Seed.quit(); 
            }
            if (typeof(parentClass.prototype) == 'undefined') {
                print("Missing protype: when applying: " );
                print(new String(constructor));
                print(new String(parentClass));
                Seed.quit(); 
            }
            var F = function(){};
            var sbp;
            var spp = parentClass.prototype;
            
            F.prototype = spp;
            sbp = constructor.prototype = new F();
            sbp.constructor=constructor;
            constructor.superclass=spp;

            // extends Object.
            if(spp.constructor == Object.prototype.constructor){
                spp.constructor=parentClass;
            }
            
            constructor.override = function(o){
                Object.extend(constructor.prototype, o);
            };
            sbp.override = io;
            XObject.extend(constructor.prototype, overrides);
            return constructor;
        };
    }(),

         
    /**
     * returns a list of keys of the object.
     * @param {Object} obj object to inspect
     * @return {Array} returns list of kyes
     * @member XObject keys
     */
    keys : function(o)
    {
        var ret = [];
        for(var i in o) {
            ret.push(i);
        }
        return ret;
    },
      
    /**
     * @member XObject createDelegate
     * creates a delage metdhod
     * @param {Function} method to wrap
     * @param {Object} scope 
     * @param {Array} args to add
     * @param {Boolean|Number} append arguments or replace after N arguments.
     * @return {Function} returns the delegate
     */

    createDelegate : function(method, obj, args, appendArgs){
        
        return function() {
            var callArgs = args || arguments;
            if(appendArgs === true){
                callArgs = Array.prototype.slice.call(arguments, 0);
                callArgs = callArgs.concat(args);
            }else if(typeof appendArgs == "number"){
                callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
                    var applyArgs = [appendArgs, 0].concat(args); // create method call params
                    Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
                }
                return method.apply(obj || window, callArgs);
            };
    }
    
});