@sccharts-lab/trace 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +277 -0
- package/README.md +233 -2
- package/dist/comparison-report.d.ts +15 -0
- package/dist/comparison-report.js +258 -0
- package/dist/comparison-report.js.map +1 -0
- package/dist/csv.d.ts +13 -0
- package/dist/csv.js +188 -0
- package/dist/csv.js.map +1 -0
- package/dist/data-pool.d.ts +2 -0
- package/dist/data-pool.js +26 -0
- package/dist/data-pool.js.map +1 -0
- package/dist/engine-replay.d.ts +78 -0
- package/dist/engine-replay.js +115 -0
- package/dist/engine-replay.js.map +1 -0
- package/dist/engine-sequence.d.ts +26 -0
- package/dist/engine-sequence.js +132 -0
- package/dist/engine-sequence.js.map +1 -0
- package/dist/engine.d.ts +51 -0
- package/dist/engine.js +210 -0
- package/dist/engine.js.map +1 -0
- package/dist/helper.d.ts +10 -0
- package/dist/helper.js +26 -0
- package/dist/helper.js.map +1 -0
- package/dist/index.d.ts +18 -0
- package/dist/index.js +18 -0
- package/dist/index.js.map +1 -0
- package/dist/input-value.d.ts +2 -0
- package/dist/input-value.js +38 -0
- package/dist/input-value.js.map +1 -0
- package/dist/json.d.ts +8 -0
- package/dist/json.js +122 -0
- package/dist/json.js.map +1 -0
- package/dist/ktrace.d.ts +11 -0
- package/dist/ktrace.js +266 -0
- package/dist/ktrace.js.map +1 -0
- package/dist/protocol.d.ts +25 -0
- package/dist/protocol.js +18 -0
- package/dist/protocol.js.map +1 -0
- package/dist/trace-compare.d.ts +77 -0
- package/dist/trace-compare.js +156 -0
- package/dist/trace-compare.js.map +1 -0
- package/dist/trace-file.d.ts +6 -0
- package/dist/trace-file.js +65 -0
- package/dist/trace-file.js.map +1 -0
- package/dist/trace-record.d.ts +71 -0
- package/dist/trace-record.js +181 -0
- package/dist/trace-record.js.map +1 -0
- package/dist/trace-rename.d.ts +40 -0
- package/dist/trace-rename.js +112 -0
- package/dist/trace-rename.js.map +1 -0
- package/dist/trace-replay.d.ts +72 -0
- package/dist/trace-replay.js +169 -0
- package/dist/trace-replay.js.map +1 -0
- package/dist/trace-timing.d.ts +55 -0
- package/dist/trace-timing.js +122 -0
- package/dist/trace-timing.js.map +1 -0
- package/dist/xml.d.ts +8 -0
- package/dist/xml.js +179 -0
- package/dist/xml.js.map +1 -0
- package/package.json +70 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,277 @@
|
|
|
1
|
+
Eclipse Public License - v 2.0
|
|
2
|
+
|
|
3
|
+
THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
|
|
4
|
+
PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
|
|
5
|
+
OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
|
|
6
|
+
|
|
7
|
+
1. DEFINITIONS
|
|
8
|
+
|
|
9
|
+
"Contribution" means:
|
|
10
|
+
|
|
11
|
+
a) in the case of the initial Contributor, the initial content
|
|
12
|
+
Distributed under this Agreement, and
|
|
13
|
+
|
|
14
|
+
b) in the case of each subsequent Contributor:
|
|
15
|
+
i) changes to the Program, and
|
|
16
|
+
ii) additions to the Program;
|
|
17
|
+
where such changes and/or additions to the Program originate from
|
|
18
|
+
and are Distributed by that particular Contributor. A Contribution
|
|
19
|
+
"originates" from a Contributor if it was added to the Program by
|
|
20
|
+
such Contributor itself or anyone acting on such Contributor's behalf.
|
|
21
|
+
Contributions do not include changes or additions to the Program that
|
|
22
|
+
are not Modified Works.
|
|
23
|
+
|
|
24
|
+
"Contributor" means any person or entity that Distributes the Program.
|
|
25
|
+
|
|
26
|
+
"Licensed Patents" mean patent claims licensable by a Contributor which
|
|
27
|
+
are necessarily infringed by the use or sale of its Contribution alone
|
|
28
|
+
or when combined with the Program.
|
|
29
|
+
|
|
30
|
+
"Program" means the Contributions Distributed in accordance with this
|
|
31
|
+
Agreement.
|
|
32
|
+
|
|
33
|
+
"Recipient" means anyone who receives the Program under this Agreement
|
|
34
|
+
or any Secondary License (as applicable), including Contributors.
|
|
35
|
+
|
|
36
|
+
"Derivative Works" shall mean any work, whether in Source Code or other
|
|
37
|
+
form, that is based on (or derived from) the Program and for which the
|
|
38
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
39
|
+
represent, as a whole, an original work of authorship.
|
|
40
|
+
|
|
41
|
+
"Modified Works" shall mean any work in Source Code or other form that
|
|
42
|
+
results from an addition to, deletion from, or modification of the
|
|
43
|
+
contents of the Program, including, for purposes of clarity any new file
|
|
44
|
+
in Source Code form that contains any contents of the Program. Modified
|
|
45
|
+
Works shall not include works that contain only declarations,
|
|
46
|
+
interfaces, types, classes, structures, or files of the Program solely
|
|
47
|
+
in each case in order to link to, bind by name, or subclass the Program
|
|
48
|
+
or Modified Works thereof.
|
|
49
|
+
|
|
50
|
+
"Distribute" means the acts of a) distributing or b) making available
|
|
51
|
+
in any manner that enables the transfer of a copy.
|
|
52
|
+
|
|
53
|
+
"Source Code" means the form of a Program preferred for making
|
|
54
|
+
modifications, including but not limited to software source code,
|
|
55
|
+
documentation source, and configuration files.
|
|
56
|
+
|
|
57
|
+
"Secondary License" means either the GNU General Public License,
|
|
58
|
+
Version 2.0, or any later versions of that license, including any
|
|
59
|
+
exceptions or additional permissions as identified by the initial
|
|
60
|
+
Contributor.
|
|
61
|
+
|
|
62
|
+
2. GRANT OF RIGHTS
|
|
63
|
+
|
|
64
|
+
a) Subject to the terms of this Agreement, each Contributor hereby
|
|
65
|
+
grants Recipient a non-exclusive, worldwide, royalty-free copyright
|
|
66
|
+
license to reproduce, prepare Derivative Works of, publicly display,
|
|
67
|
+
publicly perform, Distribute and sublicense the Contribution of such
|
|
68
|
+
Contributor, if any, and such Derivative Works.
|
|
69
|
+
|
|
70
|
+
b) Subject to the terms of this Agreement, each Contributor hereby
|
|
71
|
+
grants Recipient a non-exclusive, worldwide, royalty-free patent
|
|
72
|
+
license under Licensed Patents to make, use, sell, offer to sell,
|
|
73
|
+
import and otherwise transfer the Contribution of such Contributor,
|
|
74
|
+
if any, in Source Code or other form. This patent license shall
|
|
75
|
+
apply to the combination of the Contribution and the Program if, at
|
|
76
|
+
the time the Contribution is added by the Contributor, such addition
|
|
77
|
+
of the Contribution causes such combination to be covered by the
|
|
78
|
+
Licensed Patents. The patent license shall not apply to any other
|
|
79
|
+
combinations which include the Contribution. No hardware per se is
|
|
80
|
+
licensed hereunder.
|
|
81
|
+
|
|
82
|
+
c) Recipient understands that although each Contributor grants the
|
|
83
|
+
licenses to its Contributions set forth herein, no assurances are
|
|
84
|
+
provided by any Contributor that the Program does not infringe the
|
|
85
|
+
patent or other intellectual property rights of any other entity.
|
|
86
|
+
Each Contributor disclaims any liability to Recipient for claims
|
|
87
|
+
brought by any other entity based on infringement of intellectual
|
|
88
|
+
property rights or otherwise. As a condition to exercising the
|
|
89
|
+
rights and licenses granted hereunder, each Recipient hereby
|
|
90
|
+
assumes sole responsibility to secure any other intellectual
|
|
91
|
+
property rights needed, if any. For example, if a third party
|
|
92
|
+
patent license is required to allow Recipient to Distribute the
|
|
93
|
+
Program, it is Recipient's responsibility to acquire that license
|
|
94
|
+
before distributing the Program.
|
|
95
|
+
|
|
96
|
+
d) Each Contributor represents that to its knowledge it has
|
|
97
|
+
sufficient copyright rights in its Contribution, if any, to grant
|
|
98
|
+
the copyright license set forth in this Agreement.
|
|
99
|
+
|
|
100
|
+
e) Notwithstanding the terms of any Secondary License, no
|
|
101
|
+
Contributor makes additional grants to any Recipient (other than
|
|
102
|
+
those set forth in this Agreement) as a result of such Recipient's
|
|
103
|
+
receipt of the Program under the terms of a Secondary License
|
|
104
|
+
(if permitted under the terms of Section 3).
|
|
105
|
+
|
|
106
|
+
3. REQUIREMENTS
|
|
107
|
+
|
|
108
|
+
3.1 If a Contributor Distributes the Program in any form, then:
|
|
109
|
+
|
|
110
|
+
a) the Program must also be made available as Source Code, in
|
|
111
|
+
accordance with section 3.2, and the Contributor must accompany
|
|
112
|
+
the Program with a statement that the Source Code for the Program
|
|
113
|
+
is available under this Agreement, and informs Recipients how to
|
|
114
|
+
obtain it in a reasonable manner on or through a medium customarily
|
|
115
|
+
used for software exchange; and
|
|
116
|
+
|
|
117
|
+
b) the Contributor may Distribute the Program under a license
|
|
118
|
+
different than this Agreement, provided that such license:
|
|
119
|
+
i) effectively disclaims on behalf of all other Contributors all
|
|
120
|
+
warranties and conditions, express and implied, including
|
|
121
|
+
warranties or conditions of title and non-infringement, and
|
|
122
|
+
implied warranties or conditions of merchantability and fitness
|
|
123
|
+
for a particular purpose;
|
|
124
|
+
|
|
125
|
+
ii) effectively excludes on behalf of all other Contributors all
|
|
126
|
+
liability for damages, including direct, indirect, special,
|
|
127
|
+
incidental and consequential damages, such as lost profits;
|
|
128
|
+
|
|
129
|
+
iii) does not attempt to limit or alter the recipients' rights
|
|
130
|
+
in the Source Code under section 3.2; and
|
|
131
|
+
|
|
132
|
+
iv) requires any subsequent distribution of the Program by any
|
|
133
|
+
party to be under a license that satisfies the requirements
|
|
134
|
+
of this section 3.
|
|
135
|
+
|
|
136
|
+
3.2 When the Program is Distributed as Source Code:
|
|
137
|
+
|
|
138
|
+
a) it must be made available under this Agreement, or if the
|
|
139
|
+
Program (i) is combined with other material in a separate file or
|
|
140
|
+
files made available under a Secondary License, and (ii) the initial
|
|
141
|
+
Contributor attached to the Source Code the notice described in
|
|
142
|
+
Exhibit A of this Agreement, then the Program may be made available
|
|
143
|
+
under the terms of such Secondary Licenses, and
|
|
144
|
+
|
|
145
|
+
b) a copy of this Agreement must be included with each copy of
|
|
146
|
+
the Program.
|
|
147
|
+
|
|
148
|
+
3.3 Contributors may not remove or alter any copyright, patent,
|
|
149
|
+
trademark, attribution notices, disclaimers of warranty, or limitations
|
|
150
|
+
of liability ("notices") contained within the Program from any copy of
|
|
151
|
+
the Program which they Distribute, provided that Contributors may add
|
|
152
|
+
their own appropriate notices.
|
|
153
|
+
|
|
154
|
+
4. COMMERCIAL DISTRIBUTION
|
|
155
|
+
|
|
156
|
+
Commercial distributors of software may accept certain responsibilities
|
|
157
|
+
with respect to end users, business partners and the like. While this
|
|
158
|
+
license is intended to facilitate the commercial use of the Program,
|
|
159
|
+
the Contributor who includes the Program in a commercial product
|
|
160
|
+
offering should do so in a manner which does not create potential
|
|
161
|
+
liability for other Contributors. Therefore, if a Contributor includes
|
|
162
|
+
the Program in a commercial product offering, such Contributor
|
|
163
|
+
("Commercial Contributor") hereby agrees to defend and indemnify every
|
|
164
|
+
other Contributor ("Indemnified Contributor") against any losses,
|
|
165
|
+
damages and costs (collectively "Losses") arising from claims, lawsuits
|
|
166
|
+
and other legal actions brought by a third party against the Indemnified
|
|
167
|
+
Contributor to the extent caused by the acts or omissions of such
|
|
168
|
+
Commercial Contributor in connection with its distribution of the Program
|
|
169
|
+
in a commercial product offering. The obligations in this section do not
|
|
170
|
+
apply to any claims or Losses relating to any actual or alleged
|
|
171
|
+
intellectual property infringement. In order to qualify, an Indemnified
|
|
172
|
+
Contributor must: a) promptly notify the Commercial Contributor in
|
|
173
|
+
writing of such claim, and b) allow the Commercial Contributor to control,
|
|
174
|
+
and cooperate with the Commercial Contributor in, the defense and any
|
|
175
|
+
related settlement negotiations. The Indemnified Contributor may
|
|
176
|
+
participate in any such claim at its own expense.
|
|
177
|
+
|
|
178
|
+
For example, a Contributor might include the Program in a commercial
|
|
179
|
+
product offering, Product X. That Contributor is then a Commercial
|
|
180
|
+
Contributor. If that Commercial Contributor then makes performance
|
|
181
|
+
claims, or offers warranties related to Product X, those performance
|
|
182
|
+
claims and warranties are such Commercial Contributor's responsibility
|
|
183
|
+
alone. Under this section, the Commercial Contributor would have to
|
|
184
|
+
defend claims against the other Contributors related to those performance
|
|
185
|
+
claims and warranties, and if a court requires any other Contributor to
|
|
186
|
+
pay any damages as a result, the Commercial Contributor must pay
|
|
187
|
+
those damages.
|
|
188
|
+
|
|
189
|
+
5. NO WARRANTY
|
|
190
|
+
|
|
191
|
+
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
|
|
192
|
+
PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
|
|
193
|
+
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
|
|
194
|
+
IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
|
|
195
|
+
TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
|
|
196
|
+
PURPOSE. Each Recipient is solely responsible for determining the
|
|
197
|
+
appropriateness of using and distributing the Program and assumes all
|
|
198
|
+
risks associated with its exercise of rights under this Agreement,
|
|
199
|
+
including but not limited to the risks and costs of program errors,
|
|
200
|
+
compliance with applicable laws, damage to or loss of data, programs
|
|
201
|
+
or equipment, and unavailability or interruption of operations.
|
|
202
|
+
|
|
203
|
+
6. DISCLAIMER OF LIABILITY
|
|
204
|
+
|
|
205
|
+
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
|
|
206
|
+
PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
|
|
207
|
+
SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
208
|
+
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
|
|
209
|
+
PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
210
|
+
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
211
|
+
ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
|
|
212
|
+
EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
|
|
213
|
+
POSSIBILITY OF SUCH DAMAGES.
|
|
214
|
+
|
|
215
|
+
7. GENERAL
|
|
216
|
+
|
|
217
|
+
If any provision of this Agreement is invalid or unenforceable under
|
|
218
|
+
applicable law, it shall not affect the validity or enforceability of
|
|
219
|
+
the remainder of the terms of this Agreement, and without further
|
|
220
|
+
action by the parties hereto, such provision shall be reformed to the
|
|
221
|
+
minimum extent necessary to make such provision valid and enforceable.
|
|
222
|
+
|
|
223
|
+
If Recipient institutes patent litigation against any entity
|
|
224
|
+
(including a cross-claim or counterclaim in a lawsuit) alleging that the
|
|
225
|
+
Program itself (excluding combinations of the Program with other software
|
|
226
|
+
or hardware) infringes such Recipient's patent(s), then such Recipient's
|
|
227
|
+
rights granted under Section 2(b) shall terminate as of the date such
|
|
228
|
+
litigation is filed.
|
|
229
|
+
|
|
230
|
+
All Recipient's rights under this Agreement shall terminate if it
|
|
231
|
+
fails to comply with any of the material terms or conditions of this
|
|
232
|
+
Agreement and does not cure such failure in a reasonable period of
|
|
233
|
+
time after becoming aware of such noncompliance. If all Recipient's
|
|
234
|
+
rights under this Agreement terminate, Recipient agrees to cease use
|
|
235
|
+
and distribution of the Program as soon as reasonably practicable.
|
|
236
|
+
However, Recipient's obligations under this Agreement and any licenses
|
|
237
|
+
granted by Recipient relating to the Program shall continue and survive.
|
|
238
|
+
|
|
239
|
+
Everyone is permitted to copy and distribute copies of this Agreement,
|
|
240
|
+
but in order to avoid inconsistency the Agreement is copyrighted and
|
|
241
|
+
may only be modified in the following manner. The Agreement Steward
|
|
242
|
+
reserves the right to publish new versions (including revisions) of
|
|
243
|
+
this Agreement from time to time. No one other than the Agreement
|
|
244
|
+
Steward has the right to modify this Agreement. The Eclipse Foundation
|
|
245
|
+
is the initial Agreement Steward. The Eclipse Foundation may assign the
|
|
246
|
+
responsibility to serve as the Agreement Steward to a suitable separate
|
|
247
|
+
entity. Each new version of the Agreement will be given a distinguishing
|
|
248
|
+
version number. The Program (including Contributions) may always be
|
|
249
|
+
Distributed subject to the version of the Agreement under which it was
|
|
250
|
+
received. In addition, after a new version of the Agreement is published,
|
|
251
|
+
Contributor may elect to Distribute the Program (including its
|
|
252
|
+
Contributions) under the new version.
|
|
253
|
+
|
|
254
|
+
Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
|
|
255
|
+
receives no rights or licenses to the intellectual property of any
|
|
256
|
+
Contributor under this Agreement, whether expressly, by implication,
|
|
257
|
+
estoppel or otherwise. All rights in the Program not expressly granted
|
|
258
|
+
under this Agreement are reserved. Nothing in this Agreement is intended
|
|
259
|
+
to be enforceable by any entity that is not a Contributor or Recipient.
|
|
260
|
+
No third-party beneficiary rights are created under this Agreement.
|
|
261
|
+
|
|
262
|
+
Exhibit A - Form of Secondary Licenses Notice
|
|
263
|
+
|
|
264
|
+
"This Source Code may also be made available under the following
|
|
265
|
+
Secondary Licenses when the conditions for such availability set forth
|
|
266
|
+
in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
|
|
267
|
+
version(s), and exceptions or additional permissions here}."
|
|
268
|
+
|
|
269
|
+
Simply including a copy of this Agreement, including this Exhibit A
|
|
270
|
+
is not sufficient to license the Source Code under Secondary Licenses.
|
|
271
|
+
|
|
272
|
+
If it is not possible or desirable to put the notice in a particular
|
|
273
|
+
file, then You may include the notice in a location (such as a LICENSE
|
|
274
|
+
file in a relevant directory) where a recipient would be likely to
|
|
275
|
+
look for such a notice.
|
|
276
|
+
|
|
277
|
+
You may add additional accurate notices of copyright ownership.
|
package/README.md
CHANGED
|
@@ -1,3 +1,234 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @sccharts-lab/trace
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Simulation traces for SCCharts: save a run, replay a trace into a model, compare runs. KIELER's KTrace format, plus
|
|
4
|
+
CSV, JSON and XML, the same files as the SCCharts Lab VS Code extension (Save, Replay and Compare in its trace drawer),
|
|
5
|
+
for runs of the in-browser engine [@sccharts-lab/engine](https://www.npmjs.com/package/@sccharts-lab/engine). A trace
|
|
6
|
+
saved here and one the extension saves for the same run on KIELER's own simulator are the same file. No DOM and no Node
|
|
7
|
+
APIs: it runs in browsers and in Node 20+.
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npm install @sccharts-lab/engine @sccharts-lab/trace
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Quick start
|
|
14
|
+
|
|
15
|
+
```js
|
|
16
|
+
import { compile, createSimulation } from '@sccharts-lab/engine'
|
|
17
|
+
import { readTrace, replayTrace, traceFromRun, writeTrace } from '@sccharts-lab/trace'
|
|
18
|
+
|
|
19
|
+
const result = compile(`
|
|
20
|
+
scchart Beeper {
|
|
21
|
+
input bool press
|
|
22
|
+
output int count = 0
|
|
23
|
+
output signal int beep
|
|
24
|
+
|
|
25
|
+
initial state Idle
|
|
26
|
+
if press do count++; beep(count); print("beep", count) go to Idle
|
|
27
|
+
}`)
|
|
28
|
+
const simulation = createSimulation(result)
|
|
29
|
+
for (const press of [false, true, true, false]) simulation.step({ press })
|
|
30
|
+
|
|
31
|
+
const trace = traceFromRun(result, simulation, { model: 'Beeper.sctx' })
|
|
32
|
+
console.log(writeTrace(trace, 'ktrace'))
|
|
33
|
+
// // Beeper.sctx: 4 ticks, saved by SCCharts Lab
|
|
34
|
+
// press = false => beep = false beep_val = 0 count = 0;
|
|
35
|
+
// press = true => beep = true beep_val = 1 count = 1; // printed "beep 1"
|
|
36
|
+
// => beep_val = 2 count = 2; // printed "beep 2"
|
|
37
|
+
// press = false => beep = false;
|
|
38
|
+
const csv = writeTrace(trace, 'csv')
|
|
39
|
+
|
|
40
|
+
// Replay the file into a fresh simulation: every output it holds is checked.
|
|
41
|
+
const outcome = replayTrace(result, readTrace(csv, 'run.csv'), { label: 'run.csv' })
|
|
42
|
+
console.log(outcome.mismatches) // []
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
The format code, comparison, replay matching, timed sequences and renames are ported from the extension
|
|
46
|
+
(`keith-vscode/src/simulation/trace-*.ts`, with its tests); `engine.ts`, `engine-replay.ts` and `engine-sequence.ts`
|
|
47
|
+
connect them to the engine.
|
|
48
|
+
|
|
49
|
+
## API
|
|
50
|
+
|
|
51
|
+
```ts
|
|
52
|
+
import { compile, createSimulation } from '@sccharts-lab/engine'
|
|
53
|
+
import {
|
|
54
|
+
traceFromRun, writeTrace, readTrace, inputsOnly, replayTrace, compareRuns, compareTraces,
|
|
55
|
+
comparisonMarkdown, TRACE_FORMATS,
|
|
56
|
+
} from '@sccharts-lab/trace'
|
|
57
|
+
|
|
58
|
+
const result = compile(source)
|
|
59
|
+
const simulation = createSimulation(result)
|
|
60
|
+
simulation.step({ press: true })
|
|
61
|
+
// ...
|
|
62
|
+
|
|
63
|
+
// Save: the run so far (to the first runtime error), in KTrace, CSV, JSON or XML.
|
|
64
|
+
const trace = traceFromRun(result, simulation, { model: 'Beeper.sctx' })
|
|
65
|
+
const text = writeTrace(trace, 'csv') // TRACE_FORMATS has label and extension per format
|
|
66
|
+
const sequence = writeTrace(inputsOnly(trace), 'ktrace') // an input sequence for another model
|
|
67
|
+
|
|
68
|
+
// Replay: a file into a fresh simulation (or `simulation` to go on from its current tick).
|
|
69
|
+
const file = readTrace(text, 'run.csv') // a format, or a file name with its extension
|
|
70
|
+
const outcome = replayTrace(result, file, { label: 'run.csv' })
|
|
71
|
+
outcome.mismatches // every checked output that differs: { tick, name, expected, actual }
|
|
72
|
+
outcome.state // ReplayState: progress, checked, ignored, unset, firstMismatch, problems, notes
|
|
73
|
+
outcome.run // the replayed run as a trace
|
|
74
|
+
|
|
75
|
+
// Compare: runs (the first is the reference), or traces read from files.
|
|
76
|
+
const comparison = compareRuns([
|
|
77
|
+
{ label: 'Mine', result, run: simulation },
|
|
78
|
+
{ label: 'Solution', result: other, run: otherSimulation },
|
|
79
|
+
])
|
|
80
|
+
const report = comparisonMarkdown(comparison) // comparisonCsv(comparison): every value change
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
| Export | What |
|
|
84
|
+
| --- | --- |
|
|
85
|
+
| `traceFromRun(result, run, { model?, inputs? })` | A `TraceRecord` of a `Simulation` (or its `history`): KIELER's data pool after each tick and the printed lines. Ends before the first tick with a runtime error. `inputs: 'read'` records the inputs as the ticks read them (`ranWith`) instead of the pool's (see Replay) |
|
|
86
|
+
| `traceColumns(result)` | The columns `traceFromRun` gives: name, role (`input`, `output`, `local`), KIELER's type |
|
|
87
|
+
| `poolVariables(result)` | KIELER's data pool for the chart in KIELER's order, with input/output flags, dimensions and `late` (not in the pool before tick 1) |
|
|
88
|
+
| `writeTrace(trace, format)` / `readTrace(text, formatOrFileName)` | The four formats. `readTrace` throws `TraceFileError` with the line and the reason |
|
|
89
|
+
| `inputsOnly(trace)` | The inputs alone: an input sequence |
|
|
90
|
+
| `replayTrace(result, trace, options)` | Replays the whole file and reports. Options: `label`, `checkOutputs` (default true), `renames` (file name → model name), `simulation`, `stopAtMismatch`, `model` |
|
|
91
|
+
| `SimulationReplay` | Step by step, for a UI: `step()` (one tick: `{ tick, inputs, mismatches, pause }`), `run(stop?)`, `rewindTo(tick)`, `state()`, `done`, `error`; `replay` is the underlying `TraceReplay` (`driven`, `ignored`, `unset`, `checked`, `mismatchesOf(name)`) |
|
|
92
|
+
| `replayTargets(result)` | The model's variables as `TraceReplay` targets |
|
|
93
|
+
| `suggestRenames(fileVariables, traceColumns(result), aliases?)` | Names spelled alike (`NS_Green` and `nsGreen`) or matched before; `renameTrace`, `rememberAliases`, `forgetAliases`, `couldMatch`, `unmatched`, `describeRenames` |
|
|
94
|
+
| `runOnSequence(result, sequence, ticks, { label?, model? })` / `runOnTimedSequence(result, sequence, until, { mode? })` | The extension's "Run models on a sequence" without its dialogs: a fresh simulation on an input sequence for a number of ticks, or on a timed sequence for a number of seconds (a model with `deltaT` as its clock asks, another one as `mode` says); the trace and the notes for the report |
|
|
95
|
+
| `compareTraces(named)` / `compareRuns(runs)` | Tick by tick, or moment by moment when the traces have times; value changes lined up with their shift; printed lines too |
|
|
96
|
+
| `comparisonMarkdown(comparison, { maxRows?, preamble? })` / `comparisonCsv(comparison)` | The extension's reports |
|
|
97
|
+
| `TimedSchedule`, `timedEvents` | Ticks of a run on a timed sequence (a CSV with a `time` column and no `deltaT`): `clock`, `timer` or `events` |
|
|
98
|
+
| `traceTimes`, `timeDeltaOf`, `sameTraceValue`, `formatTraceValue`, `traceFormatOf`, `coerceInput` | Helpers |
|
|
99
|
+
|
|
100
|
+
## What a trace holds
|
|
101
|
+
|
|
102
|
+
The extension's columns are the variables of KIELER's data pool, so `traceFromRun` gives the same:
|
|
103
|
+
|
|
104
|
+
- **Names** are KIELER's: inputs, outputs and the chart's own locals; a valued signal `V` as `V` (presence), `V_val`
|
|
105
|
+
(value, with V's role) and `V_curval` (local); `deltaT` and `sleepT` of a timed chart; clocks; a class or struct
|
|
106
|
+
instance as one column holding an object; hoisted statics under KIELER's name. Not the compiler's helpers (`_` and
|
|
107
|
+
`#` names). KIELER's `#interface` also lists the member declarations of classes and structs (`Counter.count`,
|
|
108
|
+
`Point1.x` for a type moved out of an inner state, `C1.field` for a chart used as a class); the extension shows them
|
|
109
|
+
as columns that never have a value, and so does the trace.
|
|
110
|
+
- **Order**: KIELER's `VARIABLE_ORDER` (inputs, in-outs, outputs, the rest; by name within each), the variables
|
|
111
|
+
missing from the pool before tick 1 after the others (strings without a value, member declarations), then inputs,
|
|
112
|
+
outputs and locals. Members of an instance are in name order, as KIELER sends them.
|
|
113
|
+
- **Types**: KIELER's type names (`bool` for a signal's presence, `int` for an enum, `float` for a clock).
|
|
114
|
+
- **Values**: the pool after each tick. A name the pool leaves out (an unset string) keeps its last value.
|
|
115
|
+
|
|
116
|
+
## Formats
|
|
117
|
+
|
|
118
|
+
The run of `if press do count++; beep(count); print("beep", count)` for four ticks, in each format.
|
|
119
|
+
|
|
120
|
+
**KTrace** (`.ktrace`), KIELER's format, written the way KIELER writes it and loaded by the official tools: one tick
|
|
121
|
+
per line, inputs, `=>`, outputs, each only when it changed; floats with a point; `reset`, `pause` and `goto` as names
|
|
122
|
+
escaped with `^`. Locals have no place in KTrace, printed lines go in a comment KIELER skips.
|
|
123
|
+
|
|
124
|
+
```
|
|
125
|
+
// Beeper.sctx: 4 ticks, saved by SCCharts Lab
|
|
126
|
+
press = false => beep = false beep_val = 0 count = 0;
|
|
127
|
+
press = true => beep = true beep_val = 1 count = 1; // printed "beep 1"
|
|
128
|
+
=> beep_val = 2 count = 2; // printed "beep 2"
|
|
129
|
+
press = false => beep = false;
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Reading takes the literal part of KTrace: comments, `#` pragmas, named ticks, `pause`, `reset;` between traces (the
|
|
133
|
+
first is used); not `goto` or single array elements.
|
|
134
|
+
|
|
135
|
+
**CSV** (`.csv`): a row per tick, `tick`, `time` (with `deltaT`: the running sum), `printed` (when anything printed:
|
|
136
|
+
the tick's lines in one cell), then a column per variable. No roles. An empty cell keeps the row before's value
|
|
137
|
+
(`""` is the empty string), so a hand-written sequence only notes changes; a sequence with `time` and no `deltaT`
|
|
138
|
+
is timed.
|
|
139
|
+
|
|
140
|
+
```
|
|
141
|
+
tick,printed,press,beep,beep_val,count,beep_curval
|
|
142
|
+
1,,false,false,0,0,0
|
|
143
|
+
2,beep 1,true,true,1,1,1
|
|
144
|
+
3,beep 2,true,true,2,2,2
|
|
145
|
+
4,,false,false,2,2,2
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
**JSON** (`.json`): `format: "sccharts-lab-trace"`, `version`, `model`, the variables with role and type, then one
|
|
149
|
+
line per tick with `inputs`, `outputs`, `locals` (`values` for an unknown role), `time` and `printed`. Ticks may be
|
|
150
|
+
sparse when written by hand; a bare array of ticks is read too.
|
|
151
|
+
|
|
152
|
+
```json
|
|
153
|
+
{
|
|
154
|
+
"format": "sccharts-lab-trace",
|
|
155
|
+
"version": 1,
|
|
156
|
+
"model": "Beeper.sctx",
|
|
157
|
+
"variables": [
|
|
158
|
+
{ "name": "press", "role": "input", "type": "bool" }, ...
|
|
159
|
+
],
|
|
160
|
+
"ticks": [
|
|
161
|
+
{"tick":1,"inputs":{"press":false},"outputs":{"beep":false,"beep_val":0,"count":0},"locals":{"beep_curval":0}},
|
|
162
|
+
{"tick":2,"printed":["beep 1"],"inputs":{"press":true},"outputs":{"beep":true,"beep_val":1,"count":1},"locals":{"beep_curval":1}},
|
|
163
|
+
...
|
|
164
|
+
]
|
|
165
|
+
}
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
(The file lists each variable over several lines; shortened here.)
|
|
169
|
+
|
|
170
|
+
**XML** (`.xml`): `<trace format="sccharts-lab-trace" version="1" model="...">`, a `<variable name role type/>` per
|
|
171
|
+
variable, then `<tick n="1" time="...">` with `<input>`, `<output>`, `<local>` (or `<value>`) elements and a
|
|
172
|
+
`<printed>` per line.
|
|
173
|
+
|
|
174
|
+
```xml
|
|
175
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
176
|
+
<trace format="sccharts-lab-trace" version="1" model="Beeper.sctx">
|
|
177
|
+
<variable name="press" role="input" type="bool"/>
|
|
178
|
+
...
|
|
179
|
+
<tick n="2">
|
|
180
|
+
<input name="press">true</input>
|
|
181
|
+
<output name="beep">true</output>
|
|
182
|
+
<output name="beep_val">1</output>
|
|
183
|
+
<output name="count">1</output>
|
|
184
|
+
<local name="beep_curval">1</local>
|
|
185
|
+
<printed>beep 1</printed>
|
|
186
|
+
</tick>
|
|
187
|
+
...
|
|
188
|
+
</trace>
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
## Replay
|
|
192
|
+
|
|
193
|
+
As the extension's Replay: the file's first row drives the next tick. Its inputs are matched to the model's by name
|
|
194
|
+
(after `renames`) and converted to the model's types (`"12"` for a string input, `0`/`1` for a bool); inputs the
|
|
195
|
+
model lacks are `ignored`, the model's inputs the file does not set are `unset` and keep their values. After each
|
|
196
|
+
tick the file's outputs that the model also has are `checked` (a CSV, without roles: every column that is an output of
|
|
197
|
+
the model). KTrace `pause` sets `ReplayStep.pause`; the extension's Run stops there, at the end of the file and at
|
|
198
|
+
the first mismatch (`run(step => step.pause || step.mismatches.length > 0)`).
|
|
199
|
+
|
|
200
|
+
A trace holds each input as the pool has it after the tick. Where the chart writes its own input (basics.md B-10,
|
|
201
|
+
or an array index past the end), that is not what the tick read, and replaying the trace does not give the run
|
|
202
|
+
again, in the extension as here. `traceFromRun(..., { inputs: 'read' })` records what each tick read; that trace
|
|
203
|
+
replays such a run exactly (it is no longer the extension's file).
|
|
204
|
+
|
|
205
|
+
## Entry points
|
|
206
|
+
|
|
207
|
+
| Import | What |
|
|
208
|
+
| --- | --- |
|
|
209
|
+
| `@sccharts-lab/trace` | everything above |
|
|
210
|
+
| `@sccharts-lab/trace/trace-file` | the four formats: `readTrace`, `writeTrace`, `inputsOnly`, `TRACE_FORMATS`, ... |
|
|
211
|
+
| `@sccharts-lab/trace/trace-compare`, `/comparison-report` | `compareTraces`; `comparisonMarkdown`, `comparisonCsv` |
|
|
212
|
+
| `@sccharts-lab/trace/trace-replay`, `/trace-rename`, `/trace-timing` | `TraceReplay`, name matching, timed sequences |
|
|
213
|
+
|
|
214
|
+
The subpaths do not load the engine: a tool that only reads, writes or compares trace files (such as the VS Code
|
|
215
|
+
extension, whose runs come from KIELER's simulator) can import them alone.
|
|
216
|
+
|
|
217
|
+
## Verification
|
|
218
|
+
|
|
219
|
+
Every recorded KIELER run in the SCCharts Lab repository (the guide's examples and the conformance suites) is run on
|
|
220
|
+
the engine and saved: the trace has the columns and values the extension builds from KIELER's simulator, the four
|
|
221
|
+
files are byte for byte the extension's, and each reads back as the run and replays without a mismatch. Against the
|
|
222
|
+
lab's KIELER server, KIELER's saved KTrace matches the engine's run, printed lines included, and the engine's KTrace
|
|
223
|
+
loads in KIELER's own parser.
|
|
224
|
+
|
|
225
|
+
## License and credit
|
|
226
|
+
|
|
227
|
+
SCCharts, KIELER and the KTrace format are developed by the
|
|
228
|
+
[Real-Time and Embedded Systems group](https://rtsys.informatik.uni-kiel.de) at Kiel University. This package ports the
|
|
229
|
+
trace code of the SCCharts Lab VS Code extension, a fork of KIELER's VS Code extension, and is licensed under the
|
|
230
|
+
[Eclipse Public License 2.0](./LICENSE). SCCharts Lab is an independent project, not affiliated with or endorsed by
|
|
231
|
+
Kiel University.
|
|
232
|
+
|
|
233
|
+
Source: [github.com/Fallstop/sccharts-lab](https://github.com/Fallstop/sccharts-lab/tree/main/site/packages/trace).
|
|
234
|
+
Tests (in the repository): `pnpm exec vitest run packages/trace tests/trace`.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { TraceComparison } from "./trace-compare.js";
|
|
2
|
+
/**
|
|
3
|
+
* The comparison as Markdown, for the editor's preview: what was compared, a summary per
|
|
4
|
+
* variable, every change of the variables that differ, and the first ticks (or moments) that differ.
|
|
5
|
+
*/
|
|
6
|
+
export declare function comparisonMarkdown(comparison: TraceComparison, options?: {
|
|
7
|
+
maxRows?: number;
|
|
8
|
+
preamble?: string[];
|
|
9
|
+
}): string;
|
|
10
|
+
/**
|
|
11
|
+
* Every change of every shared variable, aligned by its position: one row per n-th change, with
|
|
12
|
+
* each trace's tick, time and value. The table behind "Value changes", for further analysis.
|
|
13
|
+
* Printed lines follow as rows of their own, the n-th line of each trace in one row.
|
|
14
|
+
*/
|
|
15
|
+
export declare function comparisonCsv(comparison: TraceComparison): string;
|