1 //<script type="text/javascript">
2 const GIRepository = imports.gi.GIRepository;
3 const GObject = imports.gi.GObject;
6 * Yet another attempt to create a usable object construction library for seed..
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..
16 * Extend this.. to use it's wonderful features..
19 * XObject = imports.XObject.XObject;
28 * Xyz.init(); // create and show.
31 * use XObject.debug = 1 to turn on debugging
33 * If XObjectBase/[xns]/[xtype].js exists, it will use this to override properties..
36 * He's some questions.
37 * - should we have a special property to use as the constructor / gobject.properties rather
38 * than sending all basic types to this?
40 * @cfg xtype {String|Function} constructor or string.
41 * @cfg id {String} (optional) id for registry
42 * @cfg xns {String|Object} (optional) namespace eg. Gtk or 'Gtk' - used with xtype.
43 * @cfg items {Array} (optional) list of child elements which will be constructed.. using XObject
44 * @cfg listeners {Object} (optional) map Gobject signals to functions
45 * @cfg pack {Function|String|Array} (optional) how this object gets added to it's parent
46 * @cfg el {Object} (optional) premade GObject
50 function XObject (cfg) {
51 // first apply cfg if set.
52 //print("new XOBJECT!!!");
54 //print ("XObject ctr");
56 this.config = {}; // used to initialize GObject
58 this.cfg = XObject.extend({}, cfg); // used to store original configuration.. for referencing..
60 // used by baseobject to create fake child elements on init..
65 // we could use this to determine if
66 // we are actually inside a inherited class...
67 // as define() should actually set this up..
69 if (!this.constructor) {
71 this.constructor = XObject;
72 var base = XObject.baseXObject(cfg);
74 XObject.extend(this, base.prototype);
79 // copy down all elements into self..
80 // make an extra copy in this.config?? - which is the one used in the constructor later
84 if (typeof(cfg[i]) == 'function') { // do we skip objects.
87 // these properties are not copied to cfg.
98 this.config[i] = cfg[i];
102 this.items = this.items || [];
105 // pack can be false!
106 if (typeof(this.pack) == 'undefined') {
108 this.pack = [ 'add' ]
110 var Gtk = imports.gi.Gtk;
113 case (this.xtype == Gtk.MenuItem): this.pack = [ 'append' ]; break;
120 // interesting question should we call constructor on items here...
121 // as the real work is done in init anyway..
125 for(var i = 0; i < this.items.length;i++) {
126 items.push(this.items[i]);
132 // create XObject for all the children.
133 for(var i = 0; i < items.length;i++) {
135 var base = XObject.baseXObject(items[i]);
136 base = base || XObject;
137 var item = (items[i].constructor == XObject) ? items[i] : new base(items[i]);
139 _this.items.push(item);
148 XObject.prototype = {
150 * @property el {GObject} the Gtk / etc. element.
154 * @property items {Array} list of sub elements
157 * @property parent {XObject} parent Element
161 * @property config {Object} the construction configuration.
165 * Initializes the Element (el) hooks up all the listeners
166 * and packs the children.
167 * you can override this, in child objects, then
168 * do this to do thi initaliztion.
170 * XObject.prototype.init.call(this);
173 init : function(parent)
177 //this.items.forEach(function(i) {
181 this.listeners = this.listeners || {};
184 // do we need to call 'beforeInit here?'
187 //if ((this.xtype == 'Include')) {
188 // o = this.pre_registry[cls];
190 var isSeed = typeof(Seed) != 'undefined';
192 // xtype= Gtk.Menu ?? what about c_new stuff?
193 XObject.log("init: ID:"+ this.id +" typeof(xtype): " + typeof(this.xtype));
195 var xtypeof = isSeed ? typeof(this.xtype) :
196 // oterhwise it's gjs, which case ctors are functions, not objects...
197 ( typeof(this.xtype) == 'function' ? 'object' : typeof(this.xtype) );
199 if (!this.el && xtypeof == 'function') {
200 XObject.log("func?" + XObject.keys(this.config).join(','));
201 this.el = this.xtype(this.config);
204 if (!this.el && xtypeof == 'object') {
205 XObject.log(this.xtype.toString());
207 XObject.log("obj?" + XObject.keys(this.config).join(','));
210 // gjs does not like properties that do not exist..
212 this.el = new (this.xtype)({});
213 XObject.extend(this.el, this.config);
217 this.el = new (this.xtype)(this.config);
220 print(JSON.stringify(e,null,4));
221 print(JSON.stringify(this.config,null,4));
225 name: "ArgumentError",
226 message :"Error creating object from xtype(object)"
233 if (!this.el && this.xns) {
235 var NS = imports.gi[this.xns];
237 XObject.error('Invalid xns: ' + this.xns, true);
239 constructor = NS[this.xtype];
241 XObject.error('Invalid xtype: ' + this.xns + '.' + this.xtype);
243 this.el = isSeed ? new constructor(this.config) : new constructor();
246 XObject.log("init: ID:"+ this.id +" typeof(el):" + this.el);
248 // always overlay props..
249 // check for 'write' on object..
251 if (typeof(XObject.writeablePropsCache[this.xtype.type]) == 'undefined') {
253 var gi = GIRepository.IRepository.get_default();
254 var ty = gi.find_by_gtype(this.xtype.type);
256 for (var i =0; i < GIRepository.object_info_get_n_properties(ty);i++) {
257 var p = GIRepository.object_info_get_property(ty,i);
258 if (GIRepository.property_info_get_flags(p) & 2) {
259 write.push(GIRepository.base_info_get_name(p));
262 XObject.writeablePropsCache[this.xtype.type] = write;
263 print(write.join(", "));
269 for (var i in this.config) {
270 if (i == 'type') { // problem with Gtk.Window... - not decided on a better way to handle this.
273 if (i == 'buttons') { // problem with Gtk.MessageDialog..
276 if (i[0] == '.') { // parent? -
279 this.el[i] = this.config[i];
283 //if (o.xnsid && o.id) {
284 // XObject.registry = XObject.registry || { };
285 // XObject.registry[o.xnsid] = XObject.registry[o.xnsid] || {};
286 // XObject.registry[o.xnsid][o.id] = this;
289 var type = this.xtype && this.xtype.type ? GObject.type_name(this.xtype.type) : '';
290 XObject.log("add children to " + type);
293 for (var i = 0; i < this.items.length;i++) {
294 _this.addItem(this.items[i],i);
298 for (var i in this.listeners) {
299 this.addListener(i, this.listeners[i]);
302 this.init = XObject.emptyFn;
304 // delete this.listeners ?
305 // do again so child props work!
307 // do we need to call 'init here?'
312 * Adds an item to the object using a new XObject
313 * uses pack property to determine how to add it.
314 * @arg cfg {Object} same as XObject constructor.
316 addItem : function(item, pos)
319 if (typeof(item) == 'undefined') {
320 XObject.error("Invalid Item added to this!");
321 imports.console.dump(this.cfg);
324 // what about extended items!?!?!?
327 //print("CTR:PROTO:" + ( item.id ? item.id : '??'));
328 // print("addItem - call init [" + item.pack.join(',') + ']');
330 XObject.error("NO EL!");
331 imports.console.dump(item);
334 XObject.log(XObject.type(this.xtype) + ":pack=" + item.pack);
336 if (item.pack===false) { // no packing.. various items have this ..
340 if (typeof(item.pack) == 'function') { // pack is a function..
342 item.pack.apply(item, [ this , item ]);
350 if (typeof(item.pack) == 'string') {
352 item.pack.split(',').forEach(function(e, i) {
354 if (e == 'false') { args.push( false); return; }
355 if (e == 'true') { args.push( true); return; }
356 if (!isNaN(parseInt(e))) { args.push( parseInt(e)); return; }
359 //print(args.join(","));
361 pack_m = args.shift();
363 pack_m = item.pack.shift();
368 if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
371 name: "ArgumentError",
372 message : 'pack method not available : ' + this.id + " : " + this.xtype + '.' + pack_m + " ADDING " + item.el
380 // finally call the pack method
381 //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
383 args.unshift(item.el);
389 XObject.log(pack_m + '[' + args.join(',') +']');
390 //Seed.print('args: ' + args.length);
392 this.el[pack_m].apply(this.el, args);
399 * Connects a method to a signal. (gjs/Seed aware)
401 * @param {String} sig name of signal
402 * @param {Function} fn handler.
404 addListener : function(sig, fn)
407 XObject.log("Add signal " + sig);
409 var _li = XObject.createDelegate(fn,this);
410 // private listeners that are not copied to GTk.
413 print('missing el?');
415 print(JSON.stringify(this.cfg));
419 if (typeof(Seed) != 'undefined') {
420 // Seed.print(typeof(_li));
421 this.el.signal[sig].connect(_li);
423 this.el.connect( sig, _li);
430 * Finds an object in the child elements using xid of object.
431 * prefix with '.' to look up the tree..
432 * prefix with multiple '..' to look further up..
433 * prefix with '/' to look from the top, eg. '^LeftTree.model'
435 * @param {String} name name of signal
436 * @return {XObject|false} the object if found.
440 XObject.log("SEARCH FOR " + xid + " in " + this.id);
445 name: "ArgumentError",
446 message : "ID not found : empty id"
451 return this.parent.get(xid.substring(1));
455 if (typeof(XObject.cache[xid]) != 'undefined') {
456 return XObject.cache[xid];
458 if (xid.indexOf('.') > -1) {
460 var child = xid.split('.');
461 var nxid = child.shift();
463 child = child.join('.');
464 if (typeof(XObject.cache[nxid]) != 'undefined') {
465 return XObject.cache[nxid].get(child);
476 ret = e.get(xid.substring(1));
481 name: "ArgumentError",
482 message : "ID not found : " + oid
485 XObject.cache[xid] = ret;
486 return XObject.cache[xid];
490 if (xid.indexOf('.') > -1) {
491 child = xid.split('.');
494 child = child.join('.');
497 if (xid == this.id) {
499 return child === false ? this : this.get(child);
502 name: "ArgumentError",
503 message : "ID not found : " + oid
510 this.items.forEach(function(ch) {
520 return child === false ? ret : ret.get(child);
523 name: "ArgumentError",
524 message : "ID not found : " + oid
531 this.items.forEach(function(ch) {
536 XObject.error("invalid item...");
537 imports.console.dump(_this);
548 name: "ArgumentError",
549 message : "ID not found : " + oid
553 return child === false ? ret : ret.get(child);
556 name: "ArgumentError",
557 message : "ID not found : " + oid
567 * Copies all the properties of config to obj.
569 * Pretty much the same as JQuery/Prototype.. or Roo.apply
570 * @param {Object} obj The receiver of the properties
571 * @param {Object} config The source of the properties
572 * @param {Object} defaults A different object that will also be applied for default values
573 * @return {Object} returns obj
574 * @member XObject extend
578 XObject.extend = function(o, c, defaults){
580 // no "this" reference for friendly out of scope calls
581 XObject.extend(o, defaults);
583 if(o && c && typeof c == 'object'){
591 XObject.extend(XObject,
595 * @property {Boolean} debug XObject debugging. - set to true to debug.
600 * @property {Object} cache - cache of object ids
608 emptyFn : function () { },
614 * @param {String|Object} output String to print.
616 log : function(output)
621 print("LOG:" + output);
626 * @param {String|Object} output String to print.
628 error : function(output)
630 print("ERROR: " + output);
634 * @param {String|Object} output String to print.
636 fatal : function(output)
640 name: "ArgumentError",
646 * usefull for compatibilyt.
649 isSeed : typeof(Seed) != 'undefined',
651 * Copies all the properties of config to obj, if the do not exist.
652 * @param {Object} obj The receiver of the properties
653 * @param {Object} config The source of the properties
654 * @return {Object} returns obj
655 * @member Object extendIf
659 extendIf : function(o, c)
662 if(!o || !c || typeof c != 'object'){
666 if (typeof(o[p]) != 'undefined') {
677 * Extends one class with another class and optionally overrides members with the passed literal. This class
678 * also adds the function "override()" to the class that can be used to override
679 * members on an instance.
682 * MyObject = Object.define(
686 * parentClass, // or Object
688 * ... methods and properties.
691 * @param {Function} constructor The class inheriting the functionality
692 * @param {Object} superclass The class being extended
693 * @param {Object} overrides (optional) A literal with members
694 * @return {Function} constructor (eg. class
700 var io = function(o){
705 return function(constructor, parentClass, overrides) {
706 if (typeof(parentClass) == 'undefined') {
707 XObject.error("XObject.define: Missing parentClass: when applying: " );
708 XObject.error(new String(constructor));
711 if (typeof(parentClass.prototype) == 'undefined') {
712 XObject.error("Missing protype: when applying: " );
713 XObject.error(new String(constructor));
714 XObject.error(new String(parentClass));
717 var F = function(){};
719 var spp = parentClass.prototype;
722 sbp = constructor.prototype = new F();
723 sbp.constructor=constructor;
724 constructor.superclass=spp;
727 if(spp.constructor == Object.prototype.constructor){
728 spp.constructor=parentClass;
731 constructor.override = function(o){
732 Object.extend(constructor.prototype, o);
735 XObject.extend(constructor.prototype, overrides);
742 * returns a list of keys of the object.
743 * @param {Object} obj object to inspect
744 * @return {Array} returns list of kyes
745 * @member XObject keys
756 * return the Gobject name of a constructor - does not appear to work on structs..
757 * @param {Object} gobject ctr
758 * @return {String} returns name
759 * @member XObject type
763 if (typeof(o) == 'object') {
764 return GObject.type_name(o.type);
765 // print("GNAME:" +gname + " GTYPE:"+cfg.xtype.type);
770 * return the XObjectBase class for a cfg (which includes an xtype)
771 * @param {Object} configuration.
772 * @return {function} constructor
773 * @member XObject baseXObject
775 baseXObject : function(cfg)
778 // loocks for XObject/Gtk/TreeView.js [ TreeView = { .... } ]
779 // xns is not a string!!!?
781 if (typeof(cfg.xtype) == 'object') {
782 gname = XObject.type(cfg.xtype);
785 if (typeof(cfg.xtype) == 'string') {
789 XObject.log("TRYING BASE OBJECT : " + gname);
791 // in the situation where we have been called and there is a base object
792 // defining the behavior..
793 // then we should copy the prototypes from the base object into this..
795 // see if file exists???
797 var base = gname ? imports.XObjectBase[gname][gname] : false;
802 XObject.log("error finding " + gname + " - " + e.toString());
810 * @member XObject createDelegate
811 * creates a delage metdhod
812 * @param {Function} method to wrap
813 * @param {Object} scope
814 * @param {Array} args to add
815 * @param {Boolean|Number} append arguments or replace after N arguments.
816 * @return {Function} returns the delegate
819 createDelegate : function(method, obj, args, appendArgs){
822 XObject.log("CALL: " + obj.id + ':'+ method.id);
824 var callArgs = args || arguments;
825 if(appendArgs === true){
826 callArgs = Array.prototype.slice.call(arguments, 0);
827 callArgs = callArgs.concat(args);
828 }else if(typeof appendArgs == "number"){
829 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
830 var applyArgs = [appendArgs, 0].concat(args); // create method call params
831 Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
833 return method.apply(obj || window, callArgs);