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 if (i == 'buttons') { // problem with Gtk.MessageDialog..
199 if (i[0] == '.') { // parent? -
202 this.el[i] = this.config[i];
206 //if (o.xnsid && o.id) {
207 // XObject.registry = XObject.registry || { };
208 // XObject.registry[o.xnsid] = XObject.registry[o.xnsid] || {};
209 // XObject.registry[o.xnsid][o.id] = this;
212 var type = GObject.type_name(this.xtype.type);
213 print("MAKE " + type);
217 items.forEach(function(i) {
222 for (var i in this.listeners) {
223 this.addListener(i, this.listeners[i]);
226 // delete this.listeners ?
227 // do again so child props work!
228 for (var i in this.config) {
229 if (i[0] != '.') { // problem with Gtk.Window... - not decided on a better way to handle this.
232 this.parent.el.child_set_property(this.el, i.substring(1), this.config[i]);
234 // do we need to call 'init here?'
240 * Adds an item to the object using a new XObject
241 * uses pack property to determine how to add it.
242 * @arg cfg {Object} same as XObject constructor.
244 addItem : function(o) {
245 if (typeof(o) == 'undefined') {
246 print("Invalid Item added to this!");
247 imports.console.dump(this);
250 // what about extended items!?!?!?
251 var item = (o.constructor == XObject) ? o : new XObject(o);
253 this.items.push(item);
255 //print("CTR:PROTO:" + ( item.id ? item.id : '??'));
256 // print("addItem - call init [" + item.pack.join(',') + ']');
259 imports.console.dump(item);
264 if (item.pack===false) { // no
267 if (typeof(item.pack) == 'function') {
269 item.pack.apply(item, [ this , item ]);
275 if (typeof(item.pack) == 'string') {
277 item.pack.split(',').forEach(function(e, i) {
279 if (e == 'false') { args.push( false); return; }
280 if (e == 'true') { args.push( true); return; }
281 if (!isNaN(parseInt(e))) { args.push( parseInt(e)); return; }
284 //print(args.join(","));
286 pack_m = args.shift();
288 pack_m = item.pack.shift();
293 if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
296 name: "ArgumentError",
297 message : 'pack method not available : ' + this.id + " : " + this.xtype + '.' + pack_m + " ADDING " + item.el
308 //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
310 args.unshift(item.el);
311 if (XObject.debug) print(pack_m + '[' + args.join(',') +']');
312 //Seed.print('args: ' + args.length);
314 this.el[pack_m].apply(this.el, args);
321 * @method addListener
322 * Connects a method to a signal. (gjs/Seed aware)
324 * @arg sig {String} name of signal
325 * @arg fn {Function} handler.
327 addListener : function(sig, fn)
330 if (XObject.debug) Seed.print("Add signal " + sig);
332 var _li = XObject.createDelegate(fn,this);
333 // private listeners that are not copied to GTk.
335 if (typeof(Seed) != 'undefined') {
336 // Seed.print(typeof(_li));
337 this.el.signal[sig].connect(_li);
339 this.el.connect( sig, _li);
346 * Finds an object in the child elements using xid of object.
347 * prefix with '.' to look up the tree..
348 * prefix with multiple '..' to look further up..
349 * prefix with '/' to look from the top, eg. '^LeftTree.model'
351 * @arg name {String} name of signal
352 * @return {XObject|false} the object if found.
356 if (XObject.debug) print("SEARCH FOR " + xid + " in " + this.id);
361 name: "ArgumentError",
362 message : "ID not found : empty id"
367 return this.parent.get(xid.substring(1));
371 if (typeof(XObject.cache[xid]) != 'undefined') {
372 return XObject.cache[xid];
374 if (xid.indexOf('.') > -1) {
376 var child = xid.split('.');
377 var nxid = child.shift();
379 child = child.join('.');
380 if (typeof(XObject.cache[nxid]) != 'undefined') {
381 return XObject.cache[nxid].get(child);
392 ret = e.get(xid.substring(1));
397 name: "ArgumentError",
398 message : "ID not found : " + oid
401 XObject.cache[xid] = ret;
402 return XObject.cache[xid];
406 if (xid.indexOf('.') > -1) {
407 child = xid.split('.');
410 child = child.join('.');
413 if (xid == this.id) {
415 return child === false ? this : this.get(child);
418 name: "ArgumentError",
419 message : "ID not found : " + oid
426 this.items.forEach(function(ch) {
436 return child === false ? ret : ret.get(child);
439 name: "ArgumentError",
440 message : "ID not found : " + oid
447 this.items.forEach(function(ch) {
452 print("invalid item...");
453 imports.console.dump(_this);
464 name: "ArgumentError",
465 message : "ID not found : " + oid
469 return child === false ? ret : ret.get(child);
472 name: "ArgumentError",
473 message : "ID not found : " + oid
483 * Copies all the properties of config to obj.
485 * Pretty much the same as JQuery/Prototype..
486 * @param {Object} obj The receiver of the properties
487 * @param {Object} config The source of the properties
488 * @param {Object} defaults A different object that will also be applied for default values
489 * @return {Object} returns obj
490 * @member XObject extend
494 XObject.extend = function(o, c, defaults){
496 // no "this" reference for friendly out of scope calls
497 XObject.extend(o, defaults);
499 if(o && c && typeof c == 'object'){
507 XObject.extend(XObject,
511 * @property {Boolean} debug XObject debugging. - set to true to debug.
516 * @property {Object} cache - cache of object ids
522 * Copies all the properties of config to obj, if the do not exist.
523 * @param {Object} obj The receiver of the properties
524 * @param {Object} config The source of the properties
525 * @return {Object} returns obj
526 * @member Object extendIf
530 extendIf : function(o, c){
532 if(!o || !c || typeof c != 'object'){
536 if (typeof(o[p]) != 'undefined') {
547 * Extends one class with another class and optionally overrides members with the passed literal. This class
548 * also adds the function "override()" to the class that can be used to override
549 * members on an instance.
552 * MyObject = Object.define(
556 * parentClass, // or Object
558 * ... methods and properties.
561 * @param {Function} constructor The class inheriting the functionality
562 * @param {Object} superclass The class being extended
563 * @param {Object} overrides (optional) A literal with members
564 * @return {Function} constructor (eg. class
569 var io = function(o){
574 return function(constructor, parentClass, overrides) {
575 if (typeof(parentClass) == 'undefined') {
576 print("XObject.define: Missing parentClass: when applying: " );
577 print(new String(constructor));
580 if (typeof(parentClass.prototype) == 'undefined') {
581 print("Missing protype: when applying: " );
582 print(new String(constructor));
583 print(new String(parentClass));
586 var F = function(){};
588 var spp = parentClass.prototype;
591 sbp = constructor.prototype = new F();
592 sbp.constructor=constructor;
593 constructor.superclass=spp;
596 if(spp.constructor == Object.prototype.constructor){
597 spp.constructor=parentClass;
600 constructor.override = function(o){
601 Object.extend(constructor.prototype, o);
604 XObject.extend(constructor.prototype, overrides);
611 * returns a list of keys of the object.
612 * @param {Object} obj object to inspect
613 * @return {Array} returns list of kyes
614 * @member XObject keys
626 * @member XObject createDelegate
627 * creates a delage metdhod
628 * @param {Function} method to wrap
629 * @param {Object} scope
630 * @param {Array} args to add
631 * @param {Boolean|Number} append arguments or replace after N arguments.
632 * @return {Function} returns the delegate
635 createDelegate : function(method, obj, args, appendArgs){
638 if (XObject.debug) print("CALL: " + obj.id + ':'+ method.id);
640 var callArgs = args || arguments;
641 if(appendArgs === true){
642 callArgs = Array.prototype.slice.call(arguments, 0);
643 callArgs = callArgs.concat(args);
644 }else if(typeof appendArgs == "number"){
645 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
646 var applyArgs = [appendArgs, 0].concat(args); // create method call params
647 Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
649 return method.apply(obj || window, callArgs);