tests/TreeBuilder.vala
[app.Builder.js] / XObject.js
index 6670257..872ec44 100644 (file)
@@ -30,6 +30,9 @@ GObject = imports.gi.GObject;
  * 
  * use XObject.debug = 1 to turn on debugging
  * 
+ * If XObjectBase/[xns]/[xtype].js exists, it will use this to override properties..
+ * 
+ * 
  * He's some questions.
  * - should we have a special property to use as the constructor / gobject.properties rather
  *   than sending all basic types to this?
@@ -41,36 +44,40 @@ GObject = imports.gi.GObject;
  * @cfg listeners {Object}   (optional) map Gobject signals to functions
  * @cfg pack {Function|String|Array}   (optional) how this object gets added to it's parent
  * @cfg el {Object}   (optional) premade GObject
- * 
- * 
- * 
- * 
- * 
- * 
+ *  
  */
 
 function XObject (cfg) {
     // first apply cfg if set.
       //print("new XOBJECT!!!");
-    this.config = {};
-    this.constructor = XObject;
+      
+    //print ("XObject ctr");
+      
+    this.config = {}; // used to initialize GObject
     
+    this.cfg = XObject.extend({}, cfg); // used to store original configuration.. for referencing..
     
+    // used by baseobject to create fake child elements on init..
+    if (cfg.el) {
+        this.el = cfg.el;
+    }
     
-    // start by seeing if we have a base class....
-    try {
-        // loocks for XObject/Gtk/TreeView.js [   TreeView = { .... } ]
-        var base = imports.XObject[cfg.xns][cfg.xtype][cfg.xtype];
-        for (var i in base) {
-            this[i] = base[i];
-        }
+    // we could use this to determine if 
+    // we are actually inside a inherited class...
+    // as define() should actually set this up..
+    
+    if (!this.constructor) {
         
-    } catch (e) {
+        this.constructor = XObject;
+        var base = XObject.baseXObject(cfg);
+        if (base) {
+            XObject.extend(this,  base.prototype);
+        }
         
     }
     
-    
     // copy down all elements into self..
+    // make an extra copy in this.config?? - which is the one used in the constructor later
     
     for (var i in cfg) {
         this[i] = cfg[i];
@@ -110,10 +117,29 @@ function XObject (cfg) {
         
     }
     
+    // interesting question should we call constructor on items here...
+    // as the real work is done in init anyway..
+    var _this= this;
+    var items = []
+    for(var i = 0; i < this.items.length;i++) {
+       items.push(this.items[i]);
+    }
+
+
+
+    this.items = [];
+    // create XObject for all the children.
+    for(var i = 0; i < items.length;i++) {
     
-    
-    
-    
+        var base = XObject.baseXObject(items[i]);
+        base = base || XObject;
+        var item = (items[i].constructor == XObject) ? items[i] : new base(items[i]);
+        item.parent = _this;
+        _this.items.push(item);
+        //_this.addItem(i);
+    };
+     
     
 }
 
@@ -144,16 +170,16 @@ XObject.prototype = {
       * XObject.prototype.init.call(this); 
       * 
       */ 
-    init : function()
+    init : function(parent)
     {
          
-        var items = [];
-        this.items.forEach(function(i) {
-            items.push(i);
-        });
+       // var items = [];
+        //this.items.forEach(function(i) {
+        //    items.push(i);
+        //});
         // remove items.
         this.listeners = this.listeners || {}; 
-        this.items = [];
+        //this.items = [];
          
         // do we need to call 'beforeInit here?'
          
@@ -164,14 +190,14 @@ XObject.prototype = {
         var isSeed = typeof(Seed) != 'undefined';
          
         // xtype= Gtk.Menu ?? what about c_new stuff?
-        if (XObject.debug) print("init: ID:"+ this.id +" typeof(xtype): "  + typeof(this.xtype));
+        XObject.log("init: ID:"+ this.id +" typeof(xtype): "  + typeof(this.xtype));
         if (!this.el && typeof(this.xtype) == 'function') {
-            if (XObject.debug) print("func?"  + XObject.keys(this.config).join(','));
+            XObject.log("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(','));
+            XObject.log("obj?"  + XObject.keys(this.config).join(','));
             this.el = new (this.xtype)(this.config);
       
         }
@@ -180,16 +206,16 @@ XObject.prototype = {
             
             var NS = imports.gi[this.xns];
             if (!NS) {
-                Seed.print('Invalid xns: ' + this.xns);
+                XObject.error('Invalid xns: ' + this.xns, true);
             }
             constructor = NS[this.xtype];
             if (!constructor) {
-                Seed.print('Invalid xtype: ' + this.xns + '.' + this.xtype);
+                XObject.error('Invalid xtype: ' + this.xns + '.' + this.xtype);
             }
             this.el  =   isSeed ? new constructor(this.config) : new constructor();
             
         }
-        if (XObject.debug) print("init: ID:"+ this.id +" typeof(el):" + this.el);
+        XObject.log("init: ID:"+ this.id +" typeof(el):" + this.el);
         
         // always overlay props..
         // check for 'write' on object..
@@ -233,32 +259,20 @@ XObject.prototype = {
         //}
         
         var type = this.xtype.type ? GObject.type_name(this.xtype.type) : '';
-        print("MAKE " + type);
-        
+        XObject.log("add children to " + type);
         
         var _this=this;
-        items.forEach(function(i,n) {
-            
-            if (type == 'GtkTable' && i.pack == 'add') {
-                var c = n % _this.config.n_columns;
-                var r = Math.floor(n/_this.config.n_columns);
-                i.pack = [ 'attach', c, c+1, r, r+1, 
-                        typeof(i.x_options) == 'undefined' ?  5 : i.x_options,
-                        typeof(i.y_options) == 'undefined' ?  5 : i.y_options,
-                        typeof(i.x_padding) == 'undefined' ?  0 : i.x_padding,
-                        typeof(i.x_padding) == 'undefined' ?  0 : i.x_padding
-                       
-                ]
-            }
-            
-            _this.addItem(i);
-        })
+        for (var i = 0; i < this.items.length;i++) { 
+            _this.addItem(this.items[i],i);
+        }
             
         
         for (var i in this.listeners) {
             this.addListener(i, this.listeners[i]);
         }
         
+        this.init = XObject.emptyFn;
+           
         // delete this.listeners ?
         // do again so child props work!
        
@@ -267,40 +281,42 @@ XObject.prototype = {
       
      
      /**
-      * @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);
+    addItem : function(item, pos) 
+    {
+        
+        if (typeof(item) == 'undefined') {
+            XObject.error("Invalid Item added to this!");
+            imports.console.dump(this.cfg);
             Seed.quit();
         }
         // what about extended items!?!?!?
-        var item = (o.constructor == XObject) ? o : new XObject(o);
-        item.parent = this;
-        this.items.push(item);
-        item.init();
+       
+        item.init(this);
         //print("CTR:PROTO:" + ( item.id ? item.id : '??'));
        // print("addItem - call init [" + item.pack.join(',') + ']');
         if (!item.el) {
-            print("NO EL!");
+            XObject.error("NO EL!");
             imports.console.dump(item);
             Seed.quit();
         }
-         
+        XObject.log(XObject.type(this.xtype) + ":pack=" + item.pack);
         
-        if (item.pack===false) {  // no 
+        if (item.pack===false) {  // no packing.. various items have this ..
             return;
         }
-        if (typeof(item.pack) == 'function') {
+        
+        if (typeof(item.pack) == 'function') { // pack is a function..
             // parent, child
             item.pack.apply(item, [ this , item  ]);
             item.parent = this;
             return;
         }
+        
+        // pack =  'add,x,y'
         var args = [];
         var pack_m  = false;
         if (typeof(item.pack) == 'string') {
@@ -329,17 +345,20 @@ XObject.prototype = {
                     
             }
            
-            
-            
-            
             return;
         }
         
         
+        // finally call the pack method 
         //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
-
+        
         args.unshift(item.el);
-        if (XObject.debug) print(pack_m + '[' + args.join(',') +']');
+        
+         
+        
+        
+        
+        XObject.log(pack_m + '[' + args.join(',') +']');
         //Seed.print('args: ' + args.length);
         if (pack_m) {
             this.el[pack_m].apply(this.el, args);
@@ -349,16 +368,15 @@ XObject.prototype = {
         
     },
     /**
-      * @method addListener
-      * Connects a method to a signal. (gjs/Seed aware)
-      * 
-      * @arg sig  {String} name of signal
-      * @arg fn  {Function} handler.
-      */
+    * Connects a method to a signal. (gjs/Seed aware)
+    * 
+    * @param {String} sig  name of signal
+    * @param {Function} fn  handler.
+    */
     addListener  : function(sig, fn) 
     {
  
-        if (XObject.debug) Seed.print("Add signal " + sig);
+        XObject.log("Add signal " + sig);
         fn.id= sig;
         var _li = XObject.createDelegate(fn,this);
         // private listeners that are not copied to GTk.
@@ -379,12 +397,16 @@ XObject.prototype = {
       * prefix with multiple '..' to look further up..
       * prefix with '/' to look from the top, eg. '^LeftTree.model'
       * 
-      * @arg name  {String} name of signal
-      * @return   {XObject|false} the object if found.
+      * @param {String} name name of signal
+      * @return  {XObject|false} the object if found.
       */
     get : function(xid)
     {
-        if (XObject.debug) print("SEARCH FOR " + xid + " in " + this.id);
+        XObject.log("SEARCH FOR " + xid + " in " + this.id);
+        return this.getBySearch(xid);
+    },
+    getBySearch : function(xid) {
+        
         var ret=  false;
         var oid = '' + xid;
         if (!xid.length) {
@@ -395,7 +417,7 @@ XObject.prototype = {
         }
         
         if (xid[0] == '.') {
-            return this.parent.get(xid.substring(1));
+            return this.parent.getBySearch(xid.substring(1));
         }
         if (xid[0] == '/') {
             
@@ -409,7 +431,7 @@ XObject.prototype = {
                     
                 child = child.join('.');
                 if (typeof(XObject.cache[nxid]) != 'undefined') {
-                    return XObject.cache[nxid].get(child);
+                    return XObject.cache[nxid].getBySearch(child);
                 }
                 
                 
@@ -420,7 +442,7 @@ XObject.prototype = {
             }
             
             try {
-                ret = e.get(xid.substring(1));
+                ret = e.getBySearch(xid.substring(1));
             } catch (ex) { }
             
             if (!ret) {
@@ -443,7 +465,7 @@ XObject.prototype = {
         }
         if (xid == this.id) {
             try {
-                return child === false ? this : this.get(child);
+                return child === false ? this : this.getBySearch(child);
             } catch (ex) {
                 throw {
                     name: "ArgumentError", 
@@ -464,7 +486,7 @@ XObject.prototype = {
         })
         if (ret) {
             try {
-                return child === false ? ret : ret.get(child);
+                return child === false ? ret : ret.getBySearch(child);
             } catch (ex) {
                 throw {
                     name: "ArgumentError", 
@@ -480,12 +502,12 @@ XObject.prototype = {
                 return;
             }
             if (!ch.get) {
-                print("invalid item...");
+                XObject.error("invalid item...");
                 imports.console.dump(_this);
                 Seed.quit();
             }
             try {
-                ret = ch.get(xid);
+                ret = ch.getBySearch(xid);
             } catch (ex) { }
             
             
@@ -497,7 +519,7 @@ XObject.prototype = {
             }
         }
         try {
-            return child === false ? ret : ret.get(child);
+            return child === false ? ret : ret.getBySearch(child);
         } catch (ex) {
             throw {
                 name: "ArgumentError", 
@@ -548,7 +570,48 @@ XObject.extend(XObject,
      * 
      */
     cache: { },
-    
+    /**
+     * Empty function
+     * 
+     */
+    emptyFn : function () { },
+      
+      
+      
+    /**
+     * Debug Logging
+     * @param {String|Object} output String to print.
+     */
+    log : function(output)
+    {
+        if (!this.debug) {
+            return;
+        }
+        print("LOG:" + output);  
+    },
+     
+    /**
+     * Error Logging
+     * @param {String|Object} output String to print.
+     */
+    error : function(output)
+    {
+        print("ERROR: " + output);  
+    },
+    /**
+     * fatal error
+     * @param {String|Object} output String to print.
+     */
+    fatal : function(output)
+    {
+        
+        throw {
+                name: "ArgumentError", 
+                message : output
+                    
+            }
+    },
+   
     /**
      * Copies all the properties of config to obj, if the do not exist.
      * @param {Object} obj The receiver of the properties
@@ -573,7 +636,40 @@ XObject.extend(XObject,
         return o;
     },
 
+    /**
+     * Deep clone..
+     * @param {Object} o the object to clone..
+     * @return {Object} returns clone of object
+     * @member Object xclone
+     */
+    xclone : function(o)
+    {
+        var cp = function(e) {
+             
+            if (typeof(e) != 'object') {
+                return e;
+            }
+            
+            if (typeof(e) == 'object' && Array.isArray(e)) {
+                var ar  = [];
+                for (var i =0; i < e.length;i++) {
+                    ar.push(cp(e[i])); 
+                }
+                return ar;
+            }
+            
+            return XObject.xclone(e);
+            
+        };
+        
+        var r = {};
+        for(var p in o){
+            //print (p + ': ' + typeof(o[p]));
+            r[p] = cp(o[p])
+        }
+        return r;
+    },
+
 
     /**
      * Extends one class with another class and optionally overrides members with the passed literal. This class
@@ -606,14 +702,14 @@ XObject.extend(XObject,
         };
         return function(constructor, parentClass, overrides) {
             if (typeof(parentClass) == 'undefined') {
-                print("XObject.define: Missing parentClass: when applying: " );
-                print(new String(constructor));
+                XObject.error("XObject.define: Missing parentClass: when applying: " );
+                XObject.error(new String(constructor));
                 Seed.quit(); 
             }
             if (typeof(parentClass.prototype) == 'undefined') {
-                print("Missing protype: when applying: " );
-                print(new String(constructor));
-                print(new String(parentClass));
+                XObject.error("Missing protype: when applying: " );
+                XObject.error(new String(constructor));
+                XObject.error(new String(parentClass));
                 Seed.quit(); 
             }
             var F = function(){};
@@ -654,7 +750,59 @@ XObject.extend(XObject,
         }
         return ret;
     },
-      
+    /**
+     * return the Gobject name of a constructor - does not appear to work on structs..
+     * @param {Object} gobject ctr
+     * @return {String} returns name
+     * @member XObject type
+     */
+    type : function(o)
+    {
+        if (typeof(o) == 'object') {
+            return GObject.type_name(o.type);
+           // print("GNAME:" +gname + " GTYPE:"+cfg.xtype.type);
+        }
+        return 'unknown';
+    },
+    /**
+     * return the XObjectBase class for a cfg (which includes an xtype)
+     * @param {Object} configuration.
+     * @return {function} constructor
+     * @member XObject baseXObject
+     */
+    baseXObject : function(cfg)
+    {
+          try {
+            // loocks for XObject/Gtk/TreeView.js [   TreeView = { .... } ]
+            // xns is not a string!!!?
+            var gname = false;
+            if (typeof(cfg.xtype) == 'object') {
+                gname = XObject.type(cfg.xtype);
+            
+            }
+            if (typeof(cfg.xtype) == 'string') {
+                gname  = cfg.xtype;
+            }
+            
+            XObject.log("TRYING BASE OBJECT : " + gname);
+            // in the situation where we have been called and there is a base object
+            // defining the behavior..
+            // then we should copy the prototypes from the base object into this..
+            
+            // see if file exists???
+            
+            var base = gname  ? imports.XObjectBase[gname][gname] : false;
+            return base;
+            
+        } catch (e) {
+            // if debug?
+            XObject.log("error finding " + gname + " - " + e.toString());
+            return false;
+        }
+        
+        
+    },
+    
     /**
      * @member XObject createDelegate
      * creates a delage metdhod
@@ -668,7 +816,7 @@ XObject.extend(XObject,
     createDelegate : function(method, obj, args, appendArgs){
         
         return function() {
-            if (XObject.debug) print("CALL: " + obj.id + ':'+ method.id);
+            XObject.log("CALL: " + obj.id + ':'+ method.id);
             
             var callArgs = args || arguments;
             if(appendArgs === true){
@@ -683,4 +831,4 @@ XObject.extend(XObject,
             };
     }
     
-});
\ No newline at end of file
+});