Skip to content

Commit

Permalink
translateToString() adds one more entry to outColumns
Browse files Browse the repository at this point in the history 
Previously, for string 'ab好', outColumns=[0, 1, 2]. Now it becomes [0,
1, 2, 4]. This allows the user to know where does the last character
ends.
  • Loading branch information
Jason Lin committed Oct 11, 2023
1 parent 1b940de commit c3aa63c
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 35 deletions.
2 changes: 1 addition & 1 deletion src/browser/AccessibilityManager.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ export class AccessibilityManager extends Disposable {
if (element) {
if (lineData.length === 0) {
element.innerText = '\u00a0';
this._rowColumns.set(element, [0]);
this._rowColumns.set(element, [0, 1]);
} else {
element.textContent = lineData;
this._rowColumns.set(element, columns);
Expand Down
60 changes: 30 additions & 30 deletions src/common/buffer/BufferLine.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -333,9 +333,9 @@ describe('BufferLine', function(): void {
const line = new TestBufferLine(10, CellData.fromCharData([DEFAULT_ATTR, NULL_CELL_CHAR, NULL_CELL_WIDTH, NULL_CELL_CODE]), false);
const columns: number[] = [];
assert.equal(line.translateToString(false, undefined, undefined, columns), ' ');
assert.deepEqual(columns, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);
assert.deepEqual(columns, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
assert.equal(line.translateToString(true, undefined, undefined, columns), '');
assert.deepEqual(columns, []);
assert.deepEqual(columns, [0]);
});
it('ASCII', function(): void {
const columns: number[] = [];
Expand All @@ -345,16 +345,16 @@ describe('BufferLine', function(): void {
line.setCell(4, CellData.fromCharData([1, 'a', 1, 'a'.charCodeAt(0)]));
line.setCell(5, CellData.fromCharData([1, 'a', 1, 'a'.charCodeAt(0)]));
assert.equal(line.translateToString(false, undefined, undefined, columns), 'a a aa ');
assert.deepEqual(columns, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);
assert.deepEqual(columns, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
assert.equal(line.translateToString(true, undefined, undefined, columns), 'a a aa');
assert.deepEqual(columns, [0, 1, 2, 3, 4, 5]);
assert.deepEqual(columns, [0, 1, 2, 3, 4, 5, 6]);
for (const trimRight of [true, false]) {
assert.equal(line.translateToString(trimRight, 0, 5, columns), 'a a a');
assert.deepEqual(columns, [0, 1, 2, 3, 4]);
assert.deepEqual(columns, [0, 1, 2, 3, 4, 5]);
assert.equal(line.translateToString(trimRight, 0, 4, columns), 'a a ');
assert.deepEqual(columns, [0, 1, 2, 3]);
assert.deepEqual(columns, [0, 1, 2, 3, 4]);
assert.equal(line.translateToString(trimRight, 0, 3, columns), 'a a');
assert.deepEqual(columns, [0, 1, 2]);
assert.deepEqual(columns, [0, 1, 2, 3]);
}

});
Expand All @@ -366,16 +366,16 @@ describe('BufferLine', function(): void {
line.setCell(4, CellData.fromCharData([1, '𝄞', 1, '𝄞'.charCodeAt(0)]));
line.setCell(5, CellData.fromCharData([1, '𝄞', 1, '𝄞'.charCodeAt(0)]));
assert.equal(line.translateToString(false, undefined, undefined, columns), 'a 𝄞 𝄞𝄞 ');
assert.deepEqual(columns, [0, 1, 2, 2, 3, 4, 4, 5, 5, 6, 7, 8, 9]);
assert.deepEqual(columns, [0, 1, 2, 2, 3, 4, 4, 5, 5, 6, 7, 8, 9, 10]);
assert.equal(line.translateToString(true, undefined, undefined, columns), 'a 𝄞 𝄞𝄞');
assert.deepEqual(columns, [0, 1, 2, 2, 3, 4, 4, 5, 5]);
assert.deepEqual(columns, [0, 1, 2, 2, 3, 4, 4, 5, 5, 6]);
for (const trimRight of [true, false]) {
assert.equal(line.translateToString(trimRight, 0, 5, columns), 'a 𝄞 𝄞');
assert.deepEqual(columns, [0, 1, 2, 2, 3, 4, 4]);
assert.deepEqual(columns, [0, 1, 2, 2, 3, 4, 4, 5]);
assert.equal(line.translateToString(trimRight, 0, 4, columns), 'a 𝄞 ');
assert.deepEqual(columns, [0, 1, 2, 2, 3]);
assert.deepEqual(columns, [0, 1, 2, 2, 3, 4]);
assert.equal(line.translateToString(trimRight, 0, 3, columns), 'a 𝄞');
assert.deepEqual(columns, [0, 1, 2, 2]);
assert.deepEqual(columns, [0, 1, 2, 2, 3]);
}
});
it('combining', function(): void {
Expand All @@ -386,16 +386,16 @@ describe('BufferLine', function(): void {
line.setCell(4, CellData.fromCharData([1, 'e\u0301', 1, '\u0301'.charCodeAt(0)]));
line.setCell(5, CellData.fromCharData([1, 'e\u0301', 1, '\u0301'.charCodeAt(0)]));
assert.equal(line.translateToString(false, undefined, undefined, columns), 'a e\u0301 e\u0301e\u0301 ');
assert.deepEqual(columns, [0, 1, 2, 2, 3, 4, 4, 5, 5, 6, 7, 8, 9]);
assert.deepEqual(columns, [0, 1, 2, 2, 3, 4, 4, 5, 5, 6, 7, 8, 9, 10]);
assert.equal(line.translateToString(true, undefined, undefined, columns), 'a e\u0301 e\u0301e\u0301');
assert.deepEqual(columns, [0, 1, 2, 2, 3, 4, 4, 5, 5]);
assert.deepEqual(columns, [0, 1, 2, 2, 3, 4, 4, 5, 5, 6]);
for (const trimRight of [true, false]) {
assert.equal(line.translateToString(trimRight, 0, 5, columns), 'a e\u0301 e\u0301');
assert.deepEqual(columns, [0, 1, 2, 2, 3, 4, 4]);
assert.deepEqual(columns, [0, 1, 2, 2, 3, 4, 4, 5]);
assert.equal(line.translateToString(trimRight, 0, 4, columns), 'a e\u0301 ');
assert.deepEqual(columns, [0, 1, 2, 2, 3]);
assert.deepEqual(columns, [0, 1, 2, 2, 3, 4]);
assert.equal(line.translateToString(trimRight, 0, 3, columns), 'a e\u0301');
assert.deepEqual(columns, [0, 1, 2, 2]);
assert.deepEqual(columns, [0, 1, 2, 2, 3]);
}
});
it('fullwidth', function(): void {
Expand All @@ -409,22 +409,22 @@ describe('BufferLine', function(): void {
line.setCell(7, CellData.fromCharData([1, '１', 2, '１'.charCodeAt(0)]));
line.setCell(8, CellData.fromCharData([0, '', 0, 0]));
assert.equal(line.translateToString(false, undefined, undefined, columns), 'a １ １１ ');
assert.deepEqual(columns, [0, 1, 2, 4, 5, 7, 9]);
assert.deepEqual(columns, [0, 1, 2, 4, 5, 7, 9, 10]);
assert.equal(line.translateToString(true, undefined, undefined, columns), 'a １ １１');
assert.deepEqual(columns, [0, 1, 2, 4, 5, 7]);
assert.deepEqual(columns, [0, 1, 2, 4, 5, 7, 9]);
for (const trimRight of [true, false]) {
assert.equal(line.translateToString(trimRight, 0, 7, columns), 'a １ １');
assert.deepEqual(columns, [0, 1, 2, 4, 5]);
assert.deepEqual(columns, [0, 1, 2, 4, 5, 7]);
assert.equal(line.translateToString(trimRight, 0, 6, columns), 'a １ １');
assert.deepEqual(columns, [0, 1, 2, 4, 5]);
assert.deepEqual(columns, [0, 1, 2, 4, 5, 7]);
assert.equal(line.translateToString(trimRight, 0, 5, columns), 'a １ ');
assert.deepEqual(columns, [0, 1, 2, 4]);
assert.deepEqual(columns, [0, 1, 2, 4, 5]);
assert.equal(line.translateToString(trimRight, 0, 4, columns), 'a １');
assert.deepEqual(columns, [0, 1, 2]);
assert.deepEqual(columns, [0, 1, 2, 4]);
assert.equal(line.translateToString(trimRight, 0, 3, columns), 'a １');
assert.deepEqual(columns, [0, 1, 2]);
assert.deepEqual(columns, [0, 1, 2, 4]);
assert.equal(line.translateToString(trimRight, 0, 2, columns), 'a ');
assert.deepEqual(columns, [0, 1]);
assert.deepEqual(columns, [0, 1, 2]);
}
});
it('space at end', function(): void {
Expand All @@ -436,9 +436,9 @@ describe('BufferLine', function(): void {
line.setCell(5, CellData.fromCharData([1, 'a', 1, 'a'.charCodeAt(0)]));
line.setCell(6, CellData.fromCharData([1, ' ', 1, ' '.charCodeAt(0)]));
assert.equal(line.translateToString(false, undefined, undefined, columns), 'a a aa ');
assert.deepEqual(columns, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);
assert.deepEqual(columns, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
assert.equal(line.translateToString(true, undefined, undefined, columns), 'a a aa ');
assert.deepEqual(columns, [0, 1, 2, 3, 4, 5, 6]);
assert.deepEqual(columns, [0, 1, 2, 3, 4, 5, 6, 7]);
});
it('should always return some sane value', function(): void {
const columns: number[] = [];
Expand All @@ -447,16 +447,16 @@ describe('BufferLine', function(): void {
// fullwidth pairs --> needs to be fixed after settling BufferLine impl
const line = new TestBufferLine(10, CellData.fromCharData([DEFAULT_ATTR, NULL_CELL_CHAR, 0, NULL_CELL_CODE]), false);
assert.equal(line.translateToString(false, undefined, undefined, columns), ' ');
assert.deepEqual(columns, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);
assert.deepEqual(columns, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
assert.equal(line.translateToString(true, undefined, undefined, columns), '');
assert.deepEqual(columns, []);
assert.deepEqual(columns, [0]);
});
it('should work with endCol=0', () => {
const columns: number[] = [];
const line = new TestBufferLine(10, CellData.fromCharData([DEFAULT_ATTR, NULL_CELL_CHAR, 0, NULL_CELL_CODE]), false);
line.setCell(0, CellData.fromCharData([1, 'a', 1, 'a'.charCodeAt(0)]));
assert.equal(line.translateToString(true, 0, 0, columns), '');
assert.deepEqual(columns, []);
assert.deepEqual(columns, [0]);
});
});
describe('addCharToCell', () => {
Expand Down
14 changes: 10 additions & 4 deletions src/common/buffer/BufferLine.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -510,10 +510,13 @@ export class BufferLine implements IBufferLine {

/**
* If outColumns is specified, it will be filled with column numbers such that
* returnedString[i] is display at outColumns[i] column. When a single cell is
* translated to multiple UTF-16 code units (e.g. surrogate pair) in the
* returned string, the corresponding entries in outColumns will have the same
* column number.
* returnedString[i] is display at outColumns[i] column.
* outColumns[returnedString.length] is where the character following
* returnedString will be displayed.
*
* When a single cell is translated to multiple UTF-16 code units (e.g.
* surrogate pair) in the returned string, the corresponding entries in
* outColumns will have the same column number.
*/
public translateToString(trimRight?: boolean, startCol?: number, endCol?: number, outColumns?: number[]): string {
startCol = startCol ?? 0;
Expand All @@ -537,6 +540,9 @@ export class BufferLine implements IBufferLine {
}
startCol += (content >> Content.WIDTH_SHIFT) || 1; // always advance by at least 1
}
if (outColumns) {
outColumns.push(startCol);
}
return result;
}
}

0 comments on commit c3aa63c

Please sign in to comment.