led-matrix-ts
Version:
Highly customizable led matrix for the browser
858 lines (856 loc) • 26.7 kB
HTML
<html lang="en">
<head>
<title>Code coverage report for core/board.ts</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="../prettify.css" />
<link rel="stylesheet" href="../base.css" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<style type='text/css'>
.coverage-summary .sorter {
background-image: url(../sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class='wrapper'>
<div class='pad1'>
<h1>
<a href="../index.html">All files</a> / <a href="index.html">core</a> board.ts
</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">94.79% </span>
<span class="quiet">Statements</span>
<span class='fraction'>91/96</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">82.61% </span>
<span class="quiet">Branches</span>
<span class='fraction'>38/46</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">88.46% </span>
<span class="quiet">Functions</span>
<span class='fraction'>23/26</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">94.68% </span>
<span class="quiet">Lines</span>
<span class='fraction'>89/94</span>
</div>
</div>
</div>
<div class='status-line high'></div>
<pre><table class="coverage">
<tr><td class="line-count quiet">1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265</td><td class="line-coverage quiet"><span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-yes">13x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">358378x</span>
<span class="cline-any cline-yes">358378x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">358375x</span>
<span class="cline-any cline-yes">4300373x</span>
<span class="cline-any cline-yes">3941998x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">176587x</span>
<span class="cline-any cline-yes">176587x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1942352x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">6x</span>
<span class="cline-any cline-yes">6x</span>
<span class="cline-any cline-yes">5x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">42x</span>
<span class="cline-any cline-yes">42x</span>
<span class="cline-any cline-yes">61x</span>
<span class="cline-any cline-yes">60x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">40x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">40x</span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">176572x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">176572x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">176570x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">176570x</span>
<span class="cline-any cline-yes">1147694x</span>
<span class="cline-any cline-yes">1147694x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">176569x</span>
<span class="cline-any cline-yes">176569x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">176569x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">971125x</span>
<span class="cline-any cline-yes">971125x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">176570x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">14x</span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">25x</span>
<span class="cline-any cline-yes">25x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">25x</span>
<span class="cline-any cline-yes">25x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">25x</span>
<span class="cline-any cline-yes">175x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">175x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-yes">174x</span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">15x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">15x</span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">172x</span>
<span class="cline-any cline-yes">172x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">22x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">22x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">358378x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">358378x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">176590x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">353161x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span></td><td class="text"><pre class="prettyprint lang-js">import Character from './character';
import BitArray, { bit } from '../utils/bit-array';
import { Padding, DetailedPadding } from '../types';
import CharacterDictionary from './character-dictionary';
import { NearestNeighbor } from "./character-sizer";
import { Event } from '../utils/event';
import { Exception } from '../utils/exception';
export interface BoardParameters {
letterSpacing: number
padding: Padding,
size: number
}
/**
* The board creates the link between the dictionnary and the input.
* Its role is to create the matrix reprentation of the entire board
*/
export default class Board {
readonly CLASS_NAME = Board.name;
private _characters: Array<Character>;
private _letterSpacing: number;
private _padding: DetailedPadding;
private _input: string;
private _size: number;
protected readonly onPropertyChange = new Event<void>();
public get PropertyChange() { return this.onPropertyChange.expose(); }
constructor(params: BoardParameters) {
this._characters = [];
this._letterSpacing = params.letterSpacing;
this.padding = params.padding;
this._size = params.size;
this.onPropertyChange.trigger();
}
/** Returns the spacing between characters on the board */
public get letterSpacing() {
return this._letterSpacing;
}
/** Returns the padding of the board */
public get padding() {
return this._padding;
}
/** Returns the characters used by the board */
<span class="fstat-no" title="function not covered" > public get </span>characters() {
<span class="cstat-no" title="statement not covered" > return this._characters</span>
}
/** Returns the input of the board */
<span class="fstat-no" title="function not covered" > public get </span>input() {
<span class="cstat-no" title="statement not covered" > return this._input;</span>
}
/** Returns how many times bigger the character's appear on the board in comparaison to their original size */
<span class="fstat-no" title="function not covered" > public get </span>size() {
<span class="cstat-no" title="statement not covered" > return this._size;</span>
}
/** Returns the total width of the board */
public get width() {
const paddingAndSpacingWidth = this._horizontalPaddingWidth() + this._totalSpacingWidth();
if (this._characters.length > 0) {
// horizontal padding + space between characters + characters width
return paddingAndSpacingWidth + this._characters
.map(character => character.width)
.reduce((accumulator, current) => accumulator + current);
} else {
// horizontal padding + space between characters
return paddingAndSpacingWidth;
}
}
/** Returns the total height of the board */
public get height() {
// vertical padding + size of tallest character
<span class="missing-if-branch" title="else path not taken" >E</span>if (this._characters.length > 0) {
return this._verticalPaddingWidth() +
this._characters
.reduce((accumulator, current) => current.height > accumulator.height ? <span class="branch-0 cbranch-no" title="branch not covered" >current </span>: accumulator).height;
} else {
<span class="cstat-no" title="statement not covered" > return this._verticalPaddingWidth();</span>
}
}
/** Sets the spacing between characters on the board */
public set letterSpacing(value: number) {
const letterSpacingDescription = Exception.getDescriptionForProperty(this.CLASS_NAME, 'padding')
Exception.throwIfNull(value, letterSpacingDescription);
Exception.throwIfNegative(value, letterSpacingDescription);
const prevLetterSpacing = this._letterSpacing;
this._letterSpacing = value;
this._emitPropertyChangeEvent(value, prevLetterSpacing);
}
/** Sets the spacing around the board */
public set padding(value: Padding) {
const paddingDescription = Exception.getDescriptionForProperty(this.CLASS_NAME, 'padding')
value.forEach(x => {
Exception.throwIfNull(x, paddingDescription);
Exception.throwIfNegative(x, paddingDescription);
});
const nextPadding = value.length == 1 ?
[value[0], value[0], value[0], value[0]] :
value.length == 2 ?
[value[0], value[1], value[0], value[1]] :
value;
if (this._padding) {
let prevPadding = [...this._padding];
this._padding = [nextPadding[0], nextPadding[1], nextPadding[2], nextPadding[3]];
<span class="missing-if-branch" title="else path not taken" >E</span>if (this._padding[0] != prevPadding[0] ||
this._padding[1] != prevPadding[1] ||
<span class="branch-2 cbranch-no" title="branch not covered" > this._padding[2] != prevPadding[2] </span>||
<span class="branch-3 cbranch-no" title="branch not covered" > this._padding[3] != prevPadding[3])</span> {
this.onPropertyChange.trigger();
}
} else {
this._padding = [nextPadding[0], nextPadding[1], nextPadding[2], nextPadding[3]];
this.onPropertyChange.trigger();
}
}
/**
* Gets the column of the board at the specified index
* @param index The index of the column to fetch
*/
public getColumnAtIndex(index: number): Array<bit> {
index %= this.width;
if (index < this._padding[3] || index >= this.width - this._padding[1]) {
// Column is padding
return this._createBitOffArrayOfLength(this.height + this._verticalPaddingWidth());
}
let accumulator = this._padding[3];
let toReturn;
this._characters.some((character) => {
accumulator += character.width;
if (accumulator > index) {
// Column is character
const characterColumn = character.getColumn(index - (accumulator - character.width));
toReturn = this._createBitOffArrayOfLength(this._padding[0])
.concat(characterColumn)
.concat(this._createBitOffArrayOfLength(this._padding[2]))
// Character might be shorter than the tallest character
// If so, append 0s to make up the difference in size
.concat(characterColumn.length < this.height ? <span class="branch-0 cbranch-no" title="branch not covered" >this._createBitOffArrayOfLength(this.height - characterColumn.length) </span>: []);
return true;
}
accumulator += this._letterSpacing;
if (accumulator > index) {
// Column is space
toReturn = this._createBitOffArrayOfLength(this.height + this._verticalPaddingWidth());
return true;
}
});
return toReturn;
}
/**
* Gets the row of the board at the specified index
* @param index The index of the row to fetch
*/
public getRowAtIndex(index: number): Array<bit> {
index %= this.height;
if (index < this._padding[0] || index >= this.height - this._padding[2]) {
// Column is padding
return this._createBitOffArrayOfLength(this.width);
}
// left padding + iterate[ character + space] - space + right padding
let charactersWithSpace = [].concat.apply([], this._characters.map(x => x.getRow(index - this._padding[0]).concat(this._createBitOffArrayOfLength(this._letterSpacing))));
charactersWithSpace = charactersWithSpace.slice(0, charactersWithSpace.length - this._letterSpacing);
return this._createBitOffArrayOfLength(this._padding[3])
.concat(charactersWithSpace)
.concat(this._createBitOffArrayOfLength(this._padding[1]));
}
/**
* Loads a new input onto the board
* @param input The input to load on the board
* @param dictionnary The dictionnary for which the input details is fetched
*/
public load(input: string, dictionnary: CharacterDictionary, size: number = 1): void {
const escapeCharacter = '\\';
const delimiterWord = {
start: "(",
end: ")"
}
this._characters = [];
this._size = size;
for (let i = 0; i < input.length; i++) {
let characterBuffer = input[i];
if (characterBuffer === escapeCharacter) {
// Check if were at the end of the input
<span class="missing-if-branch" title="else path not taken" >E</span>if (i == input.length - 1) {
throw `No character escaped at the end of the string input`;
}
// Change the characterBuffer to the character which is escaped
<span class="cstat-no" title="statement not covered" > characterBuffer = input[++i];</span>
} else if (characterBuffer === delimiterWord.start && (i === 0 || input[i - 1] !== escapeCharacter)) {
do {
// Add characters within brackets to the buffer
characterBuffer += input[++i];
// Check if we've reached the end of the input without finding the closing bracket
if (i == input.length) {
throw `Could not find the ending delimiter "${delimiterWord.end}" for pattern ${characterBuffer}`;
}
} while (input[i] != delimiterWord.end);
// Remove delimiter from buffer
characterBuffer = characterBuffer.slice(1, -1);
}
const character = dictionnary.find(characterBuffer);
this._characters.push(new Character(
character.pattern,
new BitArray(NearestNeighbor.scale(character.output.atIndexRange(0, character.output.size), character.width, this._size)),
character.width * this._size
));
}
this._input = input;
this.onPropertyChange.trigger();
}
private _horizontalPaddingWidth(): number {
return this._padding[1] + this._padding[3];
}
private _totalSpacingWidth(): number {
// There's a space between each character
return (this._characters.length - 1) * this._letterSpacing;
}
private _verticalPaddingWidth(): number {
return this._padding[0] + this._padding[2];
}
private _createBitOffArrayOfLength(length: number) {
return Array.apply(null, Array(length)).map(() => 0);
}
private _emitPropertyChangeEvent<T>(value: T, prevValue: T) {
<span class="missing-if-branch" title="else path not taken" >E</span>if (value != prevValue) {
this.onPropertyChange.trigger();
}
}
};</pre></td></tr>
</table></pre>
<div class='push'></div><!-- for sticky footer -->
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage
generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Fri Nov 23 2018 15:09:41 GMT-0500 (EST)
</div>
</div>
<script src="../prettify.js"></script>
<script>
window.onload = function () {
if (typeof prettyPrint === 'function') {
prettyPrint();
}
};
</script>
<script src="../sorter.js"></script>
</body>
</html>