1 //<script type="text/javascript">
2 GIRepository = imports.gi.GIRepository;
3 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.
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
40 * --- needs a xdebug option!
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?
51 function XObject (cfg) {
52 // first apply cfg if set.
53 //print("new XOBJECT!!!");
55 this.constructor = XObject;
57 // copy down all elements into self..
61 if (typeof(cfg[i]) == 'function') { // do we skip objects.
64 // these properties are not copied to cfg.
75 this.config[i] = cfg[i];
77 this.items = this.items || [];
79 if (typeof(this.pack) == 'undefined') {
83 var Gtk = imports.gi.Gtk;
86 case (this.xtype == Gtk.MenuItem): this.pack = [ 'append' ]; break;
101 * @property el {GObject} the Gtk / etc. element.
105 * @property items {Array} list of sub elements
108 * @property parent {XObject} parent Element
112 * @property config {Object} the construction configuration.
116 * Initializes the Element (el) hooks up all the listeners
117 * and packs the children.
118 * you can override this, in child objects, then
119 * do this to do thi initaliztion.
121 * XObject.prototype.init.call(this);
128 this.items.forEach(function(i) {
132 this.listeners = this.listeners || {};
135 // do we need to call 'beforeInit here?'
138 //if ((this.xtype == 'Include')) {
139 // o = this.pre_registry[cls];
141 var isSeed = typeof(Seed) != 'undefined';
143 // xtype= Gtk.Menu ?? what about c_new stuff?
144 if (XObject.debug) print("init: ID:"+ this.id +" typeof(xtype): " + typeof(this.xtype));
145 if (!this.el && typeof(this.xtype) == 'function') {
146 if (XObject.debug) print("func?" + XObject.keys(this.config).join(','));
147 this.el = this.xtype(this.config);
150 if (!this.el && typeof(this.xtype) == 'object') {
151 if (XObject.debug) print("obj?" + XObject.keys(this.config).join(','));
152 this.el = new (this.xtype)(this.config);
156 if (!this.el && this.xns) {
158 var NS = imports.gi[this.xns];
160 Seed.print('Invalid xns: ' + this.xns);
162 constructor = NS[this.xtype];
164 Seed.print('Invalid xtype: ' + this.xns + '.' + this.xtype);
166 this.el = isSeed ? new constructor(this.config) : new constructor();
169 if (XObject.debug) print("init: ID:"+ this.id +" typeof(el):" + this.el);
171 // always overlay props..
172 // check for 'write' on object..
174 if (typeof(XObject.writeablePropsCache[this.xtype.type]) == 'undefined') {
176 var gi = GIRepository.IRepository.get_default();
177 var ty = gi.find_by_gtype(this.xtype.type);
179 for (var i =0; i < GIRepository.object_info_get_n_properties(ty);i++) {
180 var p = GIRepository.object_info_get_property(ty,i);
181 if (GIRepository.property_info_get_flags(p) & 2) {
182 write.push(GIRepository.base_info_get_name(p));
185 XObject.writeablePropsCache[this.xtype.type] = write;
186 print(write.join(", "));
192 for (var i in this.config) {
193 if (i == 'type') { // problem with Gtk.Window... - not decided on a better way to handle this.
196 this.el[i] = this.config[i];
200 //if (o.xnsid && o.id) {
201 // XObject.registry = XObject.registry || { };
202 // XObject.registry[o.xnsid] = XObject.registry[o.xnsid] || {};
203 // XObject.registry[o.xnsid][o.id] = this;
206 items.forEach(function(i) {
211 for (var i in this.listeners) {
212 this.addListener(i, this.listeners[i]);
214 // delete this.listeners ?
217 // do we need to call 'init here?'
223 * Adds an item to the object using a new XObject
224 * uses pack property to determine how to add it.
225 * @arg cfg {Object} same as XObject constructor.
227 addItem : function(o) {
228 if (typeof(o) == 'undefined') {
229 print("Invalid Item added to this!");
230 imports.console.dump(this);
233 // what about extended items!?!?!?
234 var item = (o.constructor == XObject) ? o : new XObject(o);
236 this.items.push(item);
238 //print("CTR:PROTO:" + ( item.id ? item.id : '??'));
239 // print("addItem - call init [" + item.pack.join(',') + ']');
242 imports.console.dump(item);
247 if (item.pack===false) { // no
250 if (typeof(item.pack) == 'function') {
252 item.pack.apply(item, [ this , item ]);
258 if (typeof(item.pack) == 'string') {
260 item.pack.split(',').forEach(function(e, i) {
262 if (e == 'false') { args.push( false); return; }
263 if (e == 'true') { args.push( true); return; }
264 if (!isNaN(parseInt(e))) { args.push( parseInt(e)); return; }
267 //print(args.join(","));
269 pack_m = args.shift();
271 pack_m = item.pack.shift();
276 if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
278 Seed.print('pack method not available : ' + this.xtype + '.' + pack_m);
281 Seed.print('PARENT: ' + p.xtype);
289 //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
291 args.unshift(item.el);
292 if (XObject.debug) print(pack_m + '[' + args.join(',') +']');
293 //Seed.print('args: ' + args.length);
295 this.el[pack_m].apply(this.el, args);
302 * @method addListener
303 * Connects a method to a signal. (gjs/Seed aware)
305 * @arg sig {String} name of signal
306 * @arg fn {Function} handler.
308 addListener : function(sig, fn)
311 if (XObject.debug) Seed.print("Add signal " + sig);
313 var _li = XObject.createDelegate(fn,this);
314 // private listeners that are not copied to GTk.
316 if (typeof(Seed) != 'undefined') {
317 // Seed.print(typeof(_li));
318 this.el.signal[sig].connect(_li);
320 this.el.connect( sig, _li);
327 * Finds an object in the child elements using xid of object.
328 * prefix with '.' to look up the tree..
329 * prefix with multiple '..' to look further up..
330 * prefix with '/' to look from the top, eg. '^LeftTree.model'
332 * @arg name {String} name of signal
333 * @return {XObject|false} the object if found.
337 if (XObject.debug) print("SEARCH FOR " + xid + " in " + this.id);
342 name: "ArgumentError",
343 message : "ID not found : empty id"
348 return this.parent.get(xid.substring(1));
351 if (typeof(XObject.cache[xid]) != 'undefined') {
352 return XObject.cache[xid];
360 ret = e.get(xid.substring(1));
365 name: "ArgumentError",
366 message : "ID not found : " + oid
369 XObject.cache[xid] = ret;
370 return XObject.cache[xid];
374 if (xid.indexOf('.') > -1) {
375 child = xid.split('.');
378 child = child.join('.');
383 if (xid == this.id) {
385 return child === false ? this : this.get(child);
388 name: "ArgumentError",
389 message : "ID not found : " + oid
396 this.items.forEach(function(ch) {
406 return child === false ? ret : ret.get(child);
409 name: "ArgumentError",
410 message : "ID not found : " + oid
417 this.items.forEach(function(ch) {
422 print("invalid item...");
423 imports.console.dump(_this);
434 name: "ArgumentError",
435 message : "ID not found : " + oid
439 return child === false ? ret : ret.get(child);
442 name: "ArgumentError",
443 message : "ID not found : " + oid
453 * Copies all the properties of config to obj.
455 * Pretty much the same as JQuery/Prototype..
456 * @param {Object} obj The receiver of the properties
457 * @param {Object} config The source of the properties
458 * @param {Object} defaults A different object that will also be applied for default values
459 * @return {Object} returns obj
460 * @member XObject extend
464 XObject.extend = function(o, c, defaults){
466 // no "this" reference for friendly out of scope calls
467 XObject.extend(o, defaults);
469 if(o && c && typeof c == 'object'){
477 XObject.extend(XObject,
481 * @property {Boolean} debug XObject debugging. - set to true to debug.
486 * @property {Object} cache - cache of object ids
492 * Copies all the properties of config to obj, if the do not exist.
493 * @param {Object} obj The receiver of the properties
494 * @param {Object} config The source of the properties
495 * @return {Object} returns obj
496 * @member Object extendIf
500 extendIf : function(o, c){
502 if(!o || !c || typeof c != 'object'){
506 if (typeof(o[p]) != 'undefined') {
517 * Extends one class with another class and optionally overrides members with the passed literal. This class
518 * also adds the function "override()" to the class that can be used to override
519 * members on an instance.
522 * MyObject = Object.define(
526 * parentClass, // or Object
528 * ... methods and properties.
531 * @param {Function} constructor The class inheriting the functionality
532 * @param {Object} superclass The class being extended
533 * @param {Object} overrides (optional) A literal with members
534 * @return {Function} constructor (eg. class
539 var io = function(o){
544 return function(constructor, parentClass, overrides) {
545 if (typeof(parentClass) == 'undefined') {
546 print("XObject.define: Missing parentClass: when applying: " );
547 print(new String(constructor));
550 if (typeof(parentClass.prototype) == 'undefined') {
551 print("Missing protype: when applying: " );
552 print(new String(constructor));
553 print(new String(parentClass));
556 var F = function(){};
558 var spp = parentClass.prototype;
561 sbp = constructor.prototype = new F();
562 sbp.constructor=constructor;
563 constructor.superclass=spp;
566 if(spp.constructor == Object.prototype.constructor){
567 spp.constructor=parentClass;
570 constructor.override = function(o){
571 Object.extend(constructor.prototype, o);
574 XObject.extend(constructor.prototype, overrides);
581 * returns a list of keys of the object.
582 * @param {Object} obj object to inspect
583 * @return {Array} returns list of kyes
584 * @member XObject keys
596 * @member XObject createDelegate
597 * creates a delage metdhod
598 * @param {Function} method to wrap
599 * @param {Object} scope
600 * @param {Array} args to add
601 * @param {Boolean|Number} append arguments or replace after N arguments.
602 * @return {Function} returns the delegate
605 createDelegate : function(method, obj, args, appendArgs){
608 if (XObject.debug) print("CALL: " + obj.id + ':'+ method.id);
610 var callArgs = args || arguments;
611 if(appendArgs === true){
612 callArgs = Array.prototype.slice.call(arguments, 0);
613 callArgs = callArgs.concat(args);
614 }else if(typeof appendArgs == "number"){
615 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
616 var applyArgs = [appendArgs, 0].concat(args); // create method call params
617 Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
619 return method.apply(obj || window, callArgs);