Skip to content
Snippets Groups Projects
Commit 17b04680 authored by mcmlxxix's avatar mcmlxxix
Browse files

remove frame.getoff() method, add frame.cursor, frame.offset properties, use... 

remove frame.getoff() method, add frame.cursor, frame.offset properties, use "y" based matrix for frame data. use self-validating cursor and offset objects for position. update documentation.
ToDo: punch deuce
parent 9d854dfa
Branches
Tags
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 204 additions and 84 deletions
exec/load/frame.js
+ 204
− 84
View file @ 17b04680
...@@ -33,7 +33,7 @@ METHODS: ...@@ -33,7 +33,7 @@ METHODS:
frame.scrollTo(x,y) //scroll frame to absolute offset frame.scrollTo(x,y) //scroll frame to absolute offset
frame.move(x,y) //move frame n spaces in any direction frame.move(x,y) //move frame n spaces in any direction
frame.moveTo(x,y) //move frame to absolute position frame.moveTo(x,y) //move frame to absolute position
frame.getoff() //retrieve frame data offset (x,y) frame.end() //opposite of frame.home()
frame.clearline(attr) //see http://synchro.net/docs/jsobjs.html#console frame.clearline(attr) //see http://synchro.net/docs/jsobjs.html#console
frame.cleartoeol(attr) frame.cleartoeol(attr)
frame.putmsg(str) frame.putmsg(str)
...@@ -52,12 +52,18 @@ PROPERTIES: ...@@ -52,12 +52,18 @@ PROPERTIES:
frame.y //y screen position frame.y //y screen position
frame.width //frame width frame.width //frame width
frame.height //frame height frame.height //frame height
frame.data_height //true height of frame contents (READ ONLY)
frame.data_width //true width of frame contents (READ ONLY)
frame.attr //default attributes for frame frame.attr //default attributes for frame
frame.checkbounds //toggle true/false to restrict/allow frame movement outside display frame.checkbounds //toggle true/false to restrict/allow frame movement outside display
frame.lf_strict //toggle true/false to force newline after a crlf-terminated string frame.lf_strict //toggle true/false to force newline after a crlf-terminated string
frame.v_scroll //toggle true/false to enable/disable vertical scrolling frame.v_scroll //toggle true/false to enable/disable vertical scrolling
frame.h_scroll //toggle true/false to enable/disable horizontal scrolling frame.h_scroll //toggle true/false to enable/disable horizontal scrolling
frame.scrollbars //toggle true/false to show/hide scrollbars frame.scrollbars //toggle true/false to show/hide scrollbars
frame.offset //current offset object {x,y}
frame.cursor //current cursor object {x,y}
frame.parent //the parent frame of a frame
frame.id //a unique identifier (e.g. "0.1.1.2.3")
USAGE: USAGE:
...@@ -361,6 +367,88 @@ function Frame(x,y,width,height,attr,frame) { ...@@ -361,6 +367,88 @@ function Frame(x,y,width,height,attr,frame) {
this.attr = attr; this.attr = attr;
} }
/* self-validating cursor position object */
function Cursor(x,y,frame) {
var properties = {
x:undefined,
y:undefined,
frame:undefined
}
this.__defineGetter__("x", function() {
return properties.x;
});
this.__defineSetter__("x", function(x) {
if(x == undefined)
throw("invalid x coordinate: " + x);
else if(x < 0)
x = 0;
else if(x >= properties.frame.width)
x = properties.frame.width - 1;
properties.x = x;
});
this.__defineGetter__("y", function() {
return properties.y;
});
this.__defineSetter__("y", function(y) {
if(y == undefined)
throw("invalid y coordinate: " + y);
else if(y < 0)
y = 0;
else if(y > properties.frame.height)
y = properties.frame.height - 1;
properties.y = y;
});
if(frame instanceof Frame)
properties.frame = frame;
else
throw("the frame is not a frame");
this.x = x;
this.y = y;
}
/* self-validating scroll offset object */
function Offset(x,y,frame) {
var properties = {
x:undefined,
y:undefined,
frame:undefined
}
this.__defineGetter__("x", function() {
return properties.x;
});
this.__defineSetter__("x", function(x) {
if(x == undefined)
throw("invalid x offset: " + x);
else if(x < 0)
x = 0;
else if(x > properties.frame.data_width - properties.frame.width)
x = properties.frame.data_width - properties.frame.width;
properties.x = x;
});
this.__defineGetter__("y", function() {
return properties.y;
});
this.__defineSetter__("y", function(y) {
if(y == undefined)
throw("invalid y offset: " + y);
else if(y < 0)
y = 0;
else if(y > properties.frame.data_height - properties.frame.height)
y = properties.frame.data_height - properties.frame.height;
properties.y = y;
});
if(frame instanceof Frame)
properties.frame = frame;
else
throw("the frame is not a frame");
this.x = x;
this.y = y;
}
/* private properties */ /* private properties */
var properties = { var properties = {
x:undefined, x:undefined,
...@@ -385,9 +473,9 @@ function Frame(x,y,width,height,attr,frame) { ...@@ -385,9 +473,9 @@ function Frame(x,y,width,height,attr,frame) {
child:[] child:[]
} }
var position = { var position = {
cursor:{x:0,y:0}, cursor:new Cursor(0,0,this),
offset:{x:0,y:0}, offset:new Offset(0,0,this),
stored:{x:0,y:0} stored:new Cursor(0,0,this)
} }
/* protected properties */ /* protected properties */
...@@ -459,6 +547,12 @@ function Frame(x,y,width,height,attr,frame) { ...@@ -459,6 +547,12 @@ function Frame(x,y,width,height,attr,frame) {
}); });
/* read-only properties */ /* read-only properties */
this.__defineGetter__("cursor",function() {
return position.cursor;
});
this.__defineGetter__("offset",function() {
return position.offset;
});
this.__defineGetter__("id", function() { this.__defineGetter__("id", function() {
if(relations.parent) if(relations.parent)
return relations.parent.id+"."+properties.id; return relations.parent.id+"."+properties.id;
...@@ -471,10 +565,10 @@ function Frame(x,y,width,height,attr,frame) { ...@@ -471,10 +565,10 @@ function Frame(x,y,width,height,attr,frame) {
return properties.display; return properties.display;
}); });
this.__defineGetter__("data_height", function() { this.__defineGetter__("data_height", function() {
return properties.data[0].length; return properties.data.length;
}); });
this.__defineGetter__("data_width", function() { this.__defineGetter__("data_width", function() {
return properties.data.length; return properties.data[0].length;
}); });
this.__defineGetter__("data", function() { this.__defineGetter__("data", function() {
return properties.data; return properties.data;
...@@ -520,24 +614,24 @@ function Frame(x,y,width,height,attr,frame) { ...@@ -520,24 +614,24 @@ function Frame(x,y,width,height,attr,frame) {
/* public methods */ /* public methods */
this.getData = function(x,y,use_offset) { this.getData = function(x,y,use_offset) {
if(use_offset) if(use_offset)
return properties.data[x + position.offset.x][y + position.offset.y]; return properties.data[y + position.offset.y][x + position.offset.x];
else else
return properties.data[x][y]; return properties.data[y][x];
} }
this.setData = function(x,y,ch,attr,use_offset) { this.setData = function(x,y,ch,attr,use_offset) {
if(use_offset) { if(use_offset) {
if(ch) if(ch)
properties.data[x + position.offset.x][y + position.offset.y].ch = ch; properties.data[y + position.offset.y][x + position.offset.x].ch = ch;
if(attr) if(attr)
properties.data[x + position.offset.x][y + position.offset.y].attr = attr; properties.data[y + position.offset.y][x + position.offset.x].attr = attr;
if(properties.open) if(properties.open)
properties.display.updateChar(this,x,y); properties.display.updateChar(this,x,y);
} }
else { else {
if(ch) if(ch)
properties.data[x][y].ch = ch; properties.data[y][x].ch = ch;
if(attr) if(attr)
properties.data[x][y].attr = attr; properties.data[y][x].attr = attr;
if(properties.open && (x >= position.offset.x && x < position.offset.x + this.width && if(properties.open && (x >= position.offset.x && x < position.offset.x + this.width &&
y >= position.offset.y && y < position.offset.y + this.height)) y >= position.offset.y && y < position.offset.y + this.height))
properties.display.updateChar(this,x,y); properties.display.updateChar(this,x,y);
...@@ -728,9 +822,9 @@ function Frame(x,y,width,height,attr,frame) { ...@@ -728,9 +822,9 @@ function Frame(x,y,width,height,attr,frame) {
/* set character and attribute */ /* set character and attribute */
var ch = line[0]; var ch = line[0];
line = line.substr(1); line = line.substr(1);
if(!properties.data[x]) if(!properties.data[y])
properties.data[x]=[]; properties.data[y]=[];
properties.data[x][y]=new Char(ch,attr); properties.data[y][x]=new Char(ch,attr);
x++; x++;
} }
y++; y++;
...@@ -751,9 +845,9 @@ function Frame(x,y,width,height,attr,frame) { ...@@ -751,9 +845,9 @@ function Frame(x,y,width,height,attr,frame) {
return(false); return(false);
c.attr = f.readBin(1); c.attr = f.readBin(1);
c.id = this.id; c.id = this.id;
if(!properties.data[x]) if(!properties.data[y])
properties.data[x]=[]; properties.data[y]=[];
properties.data[x][y] = c; properties.data[y][x] = c;
} }
} }
f.close(); f.close();
...@@ -772,43 +866,35 @@ function Frame(x,y,width,height,attr,frame) { ...@@ -772,43 +866,35 @@ function Frame(x,y,width,height,attr,frame) {
} }
} }
this.scroll = function(x,y) { this.scroll = function(x,y) {
var update = false;
/* default: add a new line to the data matrix */ /* default: add a new line to the data matrix */
if(x == undefined && y == undefined) { if(x == undefined && y == undefined) {
if(settings.v_scroll) { if(settings.v_scroll) {
var newrow = [];
for(var x = 0;x<this.width;x++) { for(var x = 0;x<this.width;x++) {
for(var y = 0;y<this.height;y++) for(var y = 0;y<this.height;y++)
properties.display.updateChar(this,x,y); properties.display.updateChar(this,x,y);
properties.data[x].push(new Char()); newrow.push(new Char());
} }
properties.data.push(newrow);
position.offset.y++; position.offset.y++;
update = true;
} }
} }
/* otherwise, adjust the x/y offset */ /* otherwise, adjust the x/y offset */
else { else {
var update = false; if(typeof x == "number" && x !== 0 && settings.h_scroll) {
if(typeof x == "number") { position.offset.x += x;
if(settings.h_scroll) { update = true;
position.offset.x += x;
if(position.offset.x < 0)
position.offset.x = 0;
else if(position.offset.x + this.width > this.data_width)
position.offset.x = this.data_width - this.width;
update = true;
}
} }
if(typeof y == "number") { if(typeof y == "number" && y !== 0 && settings.v_scroll) {
if(settings.v_scroll) { position.offset.y += y;
position.offset.y += y; update = true;
if(position.offset.y < 0)
position.offset.y = 0;
else if(position.offset.y + this.height > this.data_height)
position.offset.y = this.data_height - this.height;
update = true;
}
} }
if(update) if(update)
this.refresh(); this.refresh();
} }
return update;
} }
this.scrollTo = function(x,y) { this.scrollTo = function(x,y) {
var update = false; var update = false;
...@@ -841,16 +927,36 @@ function Frame(x,y,width,height,attr,frame) { ...@@ -841,16 +927,36 @@ function Frame(x,y,width,height,attr,frame) {
/* console method emulation */ /* console method emulation */
this.home = function() { this.home = function() {
if(position.cursor.x == 0 && position.cursor.y == 0)
return false;
position.cursor.x = 0; position.cursor.x = 0;
position.cursor.y = 0; position.cursor.y = 0;
return true;
}
this.end = function() {
if(position.cursor.x == this.width-1 && position.cursor.y == this.height-1)
return false;
position.cursor.x = this.width-1;
position.cursor.y = this.height-1;
return true;
}
this.pagedown = function() {
position.offset.y += this.height-1;
if(position.offset.y >= this.data_height)
position.offset.y = this.data_height - this.height;
}
this.pageup = function() {
position.offset.y -= this.height-1;
if(position.offset.y < 0)
position.offset.y = 0;
} }
this.clear = function(attr) { this.clear = function(attr) {
if(attr != undefined) if(attr != undefined)
this.attr = attr; this.attr = attr;
for(var x = 0;x<this.width;x++) { for(var y = 0;y<this.height;y++) {
for(var y = 0;y<this.height;y++) { for(var x = 0;x<this.width;x++) {
properties.data[x][y].ch = undefined; properties.data[y][x].ch = undefined;
properties.data[x][y].attr = this.attr; properties.data[y][x].attr = this.attr;
properties.display.updateChar(this,x,y); properties.display.updateChar(this,x,y);
} }
} }
...@@ -861,8 +967,8 @@ function Frame(x,y,width,height,attr,frame) { ...@@ -861,8 +967,8 @@ function Frame(x,y,width,height,attr,frame) {
attr = this.attr; attr = this.attr;
for(var x = 0;x<this.width;x++) { for(var x = 0;x<this.width;x++) {
properties.display.updateChar(this,x,y); properties.display.updateChar(this,x,y);
properties.data[x][y].ch = undefined; properties.data[y][x].ch = undefined;
properties.data[x][y].attr = attr; properties.data[y][x].attr = attr;
} }
} }
this.cleartoeol = function(attr) { this.cleartoeol = function(attr) {
...@@ -870,8 +976,8 @@ function Frame(x,y,width,height,attr,frame) { ...@@ -870,8 +976,8 @@ function Frame(x,y,width,height,attr,frame) {
attr = this.attr; attr = this.attr;
for(var x = position.cursor.x;x<this.width;x++) { for(var x = position.cursor.x;x<this.width;x++) {
properties.display.updateChar(this,x,y); properties.display.updateChar(this,x,y);
properties.data[x][y].ch = undefined; properties.data[y][x].ch = undefined;
properties.data[x][y].attr = attr; properties.data[y][x].attr = attr;
} }
} }
this.crlf = function() { this.crlf = function() {
...@@ -1017,26 +1123,16 @@ function Frame(x,y,width,height,attr,frame) { ...@@ -1017,26 +1123,16 @@ function Frame(x,y,width,height,attr,frame) {
if(typeof x == "object" && x.x && x.y) { if(typeof x == "object" && x.x && x.y) {
position.cursor.x = x.x-1; position.cursor.x = x.x-1;
position.cursor.y = x.y-1; position.cursor.y = x.y-1;
return; return true;
} }
if(x <= this.width) position.cursor.x = x-1;
position.cursor.x = x-1; position.cursor.y = y-1;
if(y <= this.height)
position.cursor.y = y-1;
} }
this.getxy = function() { this.getxy = function() {
var xy = { return {
x:position.cursor.x+1, x:position.cursor.x+1,
y:position.cursor.y+1 y:position.cursor.y+1
}
return xy;
}
this.getoff = function() {
var xy = {
x:position.offset.x,
y:position.offset.y
}; };
return xy;
} }
this.pushxy = function() { this.pushxy = function() {
position.stored.x = position.cursor.x; position.stored.x = position.cursor.x;
...@@ -1047,44 +1143,68 @@ function Frame(x,y,width,height,attr,frame) { ...@@ -1047,44 +1143,68 @@ function Frame(x,y,width,height,attr,frame) {
position.cursor.y = position.stored.y; position.cursor.y = position.stored.y;
} }
this.up = function(n) { this.up = function(n) {
if(position.cursor.y == 0 && position.offset.y == 0)
return false;
if(isNaN(n)) if(isNaN(n))
n = 1; n = 1;
position.cursor.y-=n; while(n > 0) {
if(position.cursor.y < 0) { if(position.cursor.y > 0) {
if(position.offset.y > 0) position.cursor.y--;
this.scroll(0,-(n)); n--;
position.cursor.y = 0; }
else break;
} }
if(n > 0)
this.scroll(0,-(n));
return true;
} }
this.down = function(n) { this.down = function(n) {
if(position.cursor.y == this.height-1 && position.offset.y == this.data_height - this.height)
return false;
if(isNaN(n)) if(isNaN(n))
n = 1; n = 1;
position.cursor.y+=n; while(n > 0) {
if(position.cursor.y > this.height-1) { if(position.cursor.y < this.height - 1) {
if(position.offset.y < this.data_height - this.height) position.cursor.y++;
this.scroll(0,n); n--;
position.cursor.y = this.height-1; }
else break;
} }
if(n > 0)
this.scroll(0,n);
return true;
} }
this.left = function(n) { this.left = function(n) {
if(position.cursor.x == 0 && position.offset.x == 0)
return false;
if(isNaN(n)) if(isNaN(n))
n = 1; n = 1;
position.cursor.x-=n; while(n > 0) {
if(position.cursor.x < 0) { if(position.cursor.x > 0) {
if(position.offset.x > 0) position.cursor.x--;
this.scroll(-(n),0); n--;
position.cursor.x=0; }
else break;
} }
if(n > 0)
this.scroll(-(n),0);
return true;
} }
this.right = function(n) { this.right = function(n) {
if(position.cursor.x == this.width-1 && position.offset.x == this.data_width - this.width)
return false;
if(isNaN(n)) if(isNaN(n))
n = 1; n = 1;
position.cursor.x+=n; while(n > 0) {
if(position.cursor.x > this.width-1) { if(position.cursor.x < this.width - 1) {
if(position.offset.x < this.data_width - this.width) position.cursor.x++;
this.scroll(n,0); n--;
position.cursor.x=this.width-1; }
else break;
} }
if(n > 0)
this.scroll(n,0);
return true;
} }
/* private functions */ /* private functions */
...@@ -1143,10 +1263,10 @@ function Frame(x,y,width,height,attr,frame) { ...@@ -1143,10 +1263,10 @@ function Frame(x,y,width,height,attr,frame) {
this.height = height; this.height = height;
this.attr = attr; this.attr = attr;
for(var w=0;w<this.width;w++) { for(var h=0;h<this.height;h++) {
properties.data.push(new Array(this.height)); properties.data.push(new Array(this.width));
for(var h=0;h<this.height;h++) { for(var w=0;w<this.width;w++) {
properties.data[w][h] = new Char(); properties.data[h][w] = new Char();
} }
} }
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment