NEWS 133 KB
Newer Older
1
New in spot 2.0.3a (not yet released)
2

3
4
  Command-line tools:

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
  * All tools that input formulas or automata (i.e., autfilt,
    dstar2tgba, ltl2tgba, ltl2tgta, ltlcross, ltldo, ltlfilt,
    ltlgrind) now have a more homogeneous handling of the default
    input.

    - If no formula/automaton have been specified, and the standard
    input is a not a tty, then the default is to read that. This is a
    change for ltl2tgba and ltl2tgta.  In particular, it simplifies

        genltl --dac | ltl2tgba -F- | autfilt ...

    into

        genltl --dac | ltl2tgba | autfilt ...

    - If standard input is a tty and no other input has been
    specified, then an error message is printed.  This is a change for
    autfilt, dstar2tgba, ltlcross, ltldo, ltlfilt, ltlgrind, that used
    to expect the user to type formula or automata at the terminal,
    confusing people.

    - All tools now accept - as a shorthand for -F-, to force reading
    input from the standard input (regardless of whether it is a tty
    or not).  This is a change for ltl2tgba, ltl2tgta, ltlcross, and
    ltldo.

31
32
33
  * ltldo has a new option --errors=... to specify how to deal
    with errors from executed tools.

34
35
  * autfilt learned to filter automata by count of SCCs (--sccs=RANGE)
    or by type of SCCs (--accepting-sccs=RANGE,
36
37
38
    --rejecting-sccs=RANGE, trivial-sccs=RANGE, --terminal-sccs=RANGE,
    --weak-sccs=RANGE, --inherently-weak-sccs=RANGE).

39
40
41
42
  * autfilt learned --remove-unused-ap to remove atomic proposition
    that are declared in the input automaton, but not actually used.
    This of course makes sense only for input/output formats that
    declare atomic proposition (HOA & DSTAR).
43

44
  * autfilt learned two options to filter automata by count of used or
45
46
47
48
    unused atomic propositions: --used-ap=RANGE --unused-ap=RANGE.
    These differ from --ap=RANGE that only consider *declared* atomic
    propositions, regardless of whether they are actually used.

49
50
  * autfilt learned to filter automata by count of nondeterministsic
    states with --nondet-states=RANGE.
51

52
  * autfilt learned to filter automata representing stutter-invariant
53
54
    properties with --is-stutter-invariant.

55
  * autfilt learned two new options to highlight non-determinism:
56
    --highlight-nondet-states=NUM and --highlight-nondet-states=NUM
57
58
    where NUM is a color number.  Additionally --highlight-nondet=NUM is
    a shorthand for using the two.
59

60
  * autfilt learned to highlight a run matching a given word using the
61
62
63
    --highlight-word=[NUM,]WORD option.  However currently this only
    work on automata with Fin-less acceptance.

64
  * ltlcross and ltldo learned a new syntax to specify that an input
65
66
67
68
69
70
71
72
73
74
75
76
77
    formula should be written in some given syntax after rewriting
    some operators away.  For instance the defaults arguments passed
    to ltl2dstar have been changed from
         --output-format=hoa %L %O
    into
         --output-format=hoa %[WM]L %O
    where [WM] specifies that operators W and M should be rewritten
    away.  As a consequence running
         ltldo ltl2dstar -f 'a M b'
    will now work and call ltl2dstar on the equivalent formula
    'b U (a & b)' instead.  The operators that can be listed between
    brackets are the same as those of ltlfilt --unabbreviate option.

78
79
80
  * ltlcross learned to show some counterexamples when diagnosing
    failures of cross-comparison checks against random state spaces.

81
  * genltl learned three new families: --dac-patterns=1..45,
82
83
84
    --eh-patterns=1..12, and --sb-patterns=1..27.  Unlike other options
    these do not output scalable patterns, but simply a list of formulas
    appearing in these three papers: Dwyer et al (FMSP'98), Etessami &
85
    Holzmann (Concur'00), Somenzi & Bloem (CAV'00).
86

87
88
  * genltl learned two options, --positive and --negative, to control
    wether formulas should be output after negation or not (or both).
89

90
91
92
  * Arguments passed to -x (in ltl2tgba, ltl2tgta, autfilt, dstar2tgba)
    that are not used are now reported as they might be typos.
    This ocurred a couple of times in our test-suite.  A similar
93
    check is done for the arguments of autfilt --sat-minimize=...
94

95
96
97
98
99
100
101
102
103
  Library:

  * The print_hoa() function will now output version 1.1 of the HOA
    format when passed the "1.1" option (i.e., use -H1.1 from any
    command-line tool).  As far as Spot is concerned, this allows
    negated properties to be expressed.  Version 1 of the HOA format
    is still the default, but we plan to default to version 1.1 in the
    future.

104
105
106
107
108
109
110
  * The "highlight-states" and "highlight-edges" named properties,
    which were introduced in 1.99.8, will now be output using
    "spot.highlight.edges:" and "spot.highlight.states:" headers if
    version 1.1 of the HOA format is selected.  The automaton parser
    was secretly able of reading that since 1.99.8, but that is now
    documented at https://spot.lrde.epita.fr/hoa.html#extensions

111
112
113
  * highlight_nondet_states() and highlight_nondet_edges() are
    new functions that define the above two named properties.

114
  * is_deterministic(), is_terminal(), is_weak(), and
115
116
117
    is_inherently_weak(), count_nondet_states(),
    highlight_nondet_edges(), highlight_nondet_states() will update
    the corresponding properties of the automaton as a side-effect of
118
    their check.
119

120
121
122
123
124
125
  * the sbacc() function, used by "ltl2tgba -S" and "autfilt -S" to
    convert automata to state-based acceptance, learned some tricks
    (using SCCs, pulling accepting marks common to all outgoing edges,
    and pushing acceptance marks common to all incoming edges) to
    reduce the number of additional states needed.

126
127
128
  * language_containment_checker now has default values for all
    parameters of its constructor.

129
130
131
132
  * spot::twa_run has a new method, project(), that can be used to
    project a run found in a product onto one of the original operand.
    This is for instance used by autfilt --highlight-word.

133
134
135
136
    The old spot::project_twa_run() function has been removed: it was
    not used anywhere in Spot, and had an obvious bug in its
    implementation, so it cannot be missed by anyone.

137
138
  * spot::twa has two new methods that supplement is_empty():
    twa::accepting_run() and twa::accepting_word().  They compute
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
139
    what their names suggest.  Note that twa::accepting_run(), unlike
140
141
142
    the two others, is currently restricted to automata with Fin-less
    acceptance.

143
144
145
146
147
  * spot::check_stutter_invariance() can now work on non-deterministic
    automata for which no corresponding formula is known.  This
    implies that "autfilt --check=stutter" will now label all
    automata, not just deterministic automata.

148
  * New LTL and PSL simplification rules:
149
150
    - if e is pure eventuality and g => e, then e U g = Fg
    - if u is purely universal and u => g, then u R g = Gg
151
152
    - {s[*0..j]}[]->b = {s[*1..j]}[]->b
    - {s[*0..j]}<>->b = {s[*1..j]}<>->b
153

154
155
156
157
  * spot::twa::succ_iterable renamed to
    spot::internal::twa_succ_iterable to make it clear this is not for
    public consumption.

158
159
160
161
162
  * spot::fair_kripke::state_acceptance_conditions() renamed to
    spot::fair_kripke::state_acceptance_mark() for consistency.  This
    is backward incompatible, but we are not aware of any actual use
    of this method.

163
164
  Python:

165
  * The __format__() method for formula supports the same
166
167
168
169
    operator-rewritting feature introduced in ltldo and ltlcross.
    So "{:[i]s}".format(f) is the same as
    "{:s}".format(f.unabbreviate("i")).

170
171
  * Bindings for language_containment_checker were added.

172
173
  * Bindings for randomize() were added.

174
175
176
  * Iterating over edges via "aut.out(s)" or "aut.edges()"
    now allows modifying the edge fields.

177
  * Under IPython the spot.ltsmin module now offers a
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
178
    %%pml magic to define promela models, compile them
179
180
181
    with spins, and dynamically load them.   This is
    akin to the %%dve magic that was already supported.

182
183
184
185
  * The %%dve and %%pml magics honor the SPOT_TMPDIR and
    TMPDIR environment variables.  This especially helps
    when the current directory is read-only.

186
187
188
189
  Documentation:

  * A new example page shows how to test the equivalence of
    two LTL/PSL formulas.  https://spot.lrde.epita.fr/tut04.html
190

191
192
  * A new page discusses explicit vs. on-the-fly interfaces for
    exploring automata in C++.  https://spot.lrde.epita.fr/tut50.html
193

194
195
196
197
  * Another new page shows how to implement an on-the-fly Kripke
    structure to implement a custom state space.
    https://spot.lrde.epita.fr/tut51.html

198
199
  * The concepts.html page now lists all named properties
    used by automata.
200

201
202
203
204
205
206
  Bug fixes:

  * When ltlcross found a bug using a product of complemented
    automata, the error message would report "Comp(Ni)*Comp(Pj)" as
    non-empty while the actual culprit was "Comp(Nj)*Comp(Pi)".

207
208
209
  * Fix some non-deterministic execution of minimize_wdba(), causing
    test-suite failures with the future G++ 7, and clang 3.9.

210
211
212
  * print_lbtt() had a memory leak when printing states without
    successors.

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
213
New in spot 2.0.3 (2016-07-11)
214

215
216
217
218
219
  Bug fixes:

  * The degen-lcache=1 option of the degeneralization algorithm (which
    is a default option) did not behave exactly as documented: instead
    of reusing the first level ever created for a state where the
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
220
221
    choice of the level is free, it reused the last level ever used.
    This caused some posterior simulation-based reductions to be less
222
    efficient at reducing automata (on the average).
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
223
  * The generalized testing automata displayed by the online
224
    translator were incorrect (those output by ltl2tgta were OK).
225
  * ltl2tgta should not offer options --ba, --monitor, --tgba and such.
226
  * the relabel() function could incorrectly unregister old atomic
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
227
228
229
    propositions even when they were still used in the output (e.g.,
    if a&p0 is relabeled to p0&p1).  This could cause ltldo and the
    online translator to report errors.
230

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
231
232
233
234
235
236
237
238
New in spot 2.0.2 (2016-06-17)

  Documentation:

  * We now have a citing page at https://spot.lrde.epita.fr/citing.html
    providing a list of references about Spot.
  * The Python examples have been augmented with the two examples
    from our ATVA'16 tool paper.
239

240
241
242
243
  Bug fixes:

  * Fix compilation error observed with Clang++ 3.7.1 and GCC 6.1.1
    headers.
244
  * Fix an infinite recursion in relabel_bse().
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
245
  * Various small typos and cosmetic cleanups.
246

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
247
New in spot 2.0.1 (2016-05-09)
248

249
250
  Library:

251
  * twa::unregister_ap() and twa_graph::remove_unused_ap() are new
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
252
    methods introduced to fix some of the bugs listed below.
253

254
255
256
257
258
  Documentation:

  * Add missing documentation for the option string passed to
    spot::make_emptiness_check_instantiator().

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
259
  * There is now a spot(7) man page listing all installed
260
261
    command-line tools.

262
263
264
265
  Python:

  * The tgba_determinize() function is now accessible in Python.

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
266
267
  Bug fixes:

268
  * The automaton parser would choke on comments like /******/.
269
  * check_strength() should also set negated properties.
270
271
272
  * Fix autfilt to apply --simplify-exclusive-ap only after
    the simplifications of (--small/--deterministic) have
    been performed.
273
274
  * The automaton parser did not fully register atomic propositions
    for automata read from never claim or as LBTT.
275
  * spot::ltsmin::kripke() had the same issue.
276
277
278
279
  * The sub_stats_reachable() function used to count the number
    of transitions based on the number of atomic propositions
    actually *used* by the automaton instead of using the number
    of AP declared.
280
281
282
283
284
  * print_hoa() will now output all the atomic propositions that have
    been registered, not only those that are used in the automaton.
    (Note that it will also throw an exception if the automaton uses
    an unregistered AP; this is how some of the above bugs were
    found.)
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
285
  * For Small or Deterministic preference, the postprocessor
286
287
288
    will now unregister atomic propositions that are no longer
    used in labels.   Simplification of exclusive properties
    and remove_ap::strip() will do similarly.
289
290
  * bench/ltl2tgba/ was not working since the source code
    reorganization of 1.99.7.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
291
  * Various typos and minor documentation fixes.
292

293

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
294
New in spot 2.0 (2016-04-11)
295

296
297
298
  Command-line tools:

  * ltlfilt now also support the --accept-word=WORD and
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
299
300
    --reject-word=WORD options that were introduced in autfilt in the
    previous version.
301

302
303
304
  Python:

  * The output of spot.atomic_prop_collect() is printable and
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
305
    can now be passed directly to spot.ltsmin.model.kripke().
306

307
308
309
310
  Library:

  * digraph::valid_trans() renamed to digraph::is_valid_edge().

311
312
  Documentation:

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
313
314
315
316
317
  * The concepts page (https://spot.lrde.epita.fr/concepts.html) now
    includes a highlevel description of the architecture, and some
    notes aboute automata properties.

  * More Doxygen documentation for spot::formula and spot::digraph.
318

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
319
New in spot 1.99.9 (2016-03-14)
320

321
322
  Command-line tools:

323
324
325
  * autfilt has two new options: --accept-word=WORD and
    --reject-word=WORD for filtering automata that accept or reject
    some word.  The option may be used multiple times.
326

327
328
  Library:

329
330
331
  * The parse_word() function can be used to parse a lasso-shaped
    word and build a twa_word.  The twa_word::as_automaton()
    method can be used to create an automaton out of that.
332
  * twa::ap_var() renamed to twa::ap_vars().
333
334
335
336
  * emptiness_check_instantiator::min_acceptance_conditions() and
    emptiness_check_instantiator::max_acceptance_conditions() renamed
    to emptiness_check_instantiator::min_sets() and
    emptiness_check_instantiator::max_sets().
337
338
  * tgba_reachable_iterator (and subclasses) was renamed to
    twa_reachable_iterator for consistency.
339

340
341
342
343
  Documentation:

  * The page https://spot.lrde.epita.fr/upgrade2.html should help
    people migrating old C++ code written for Spot 1.2.x, and update
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
344
    it for (the upcoming) Spot 2.0.
345

346
347
348
349
  Bug fixes:

  * spot/twaalgos/gtec/gtec.hh was incorrectly installed as
  spot/tgbaalgos/gtec/gtec.hh.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
350
  * The shared libraries should now compile again on Darwin.
351

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
352
New in spot 1.99.8 (2016-02-18)
353

354
355
  Command-line tools:

356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
  * ltl2tgba now also support the --generic option (already supported
    by ltldo and autfilt) to lift any restriction on the acceptance
    condition produced.  This option now has a short version: -G.

  * ltl2tgba and autfilt have learnt how to determinize automata.
    For this to work, --generic acceptance should be enabled (this
    is the default for autfilt, but not for ltl2tgba).

    "ltl2tgba -G -D" will now always outpout a deterministic automaton.
    It can be an automaton with transition-based parity acceptance in
    case Spot could not find a deterministic automaton with (maybe
    generalized) Büchi acceptance.

    "ltl2tgba -D" is unchanged (the --tgba acceptance is the default),
    and will output a deterministic automaton with (generalized) Büchi
    acceptance only if one could be found.  Otherwise a
    non-deterministic automaton is output, but this does NOT mean that
    no deterministic Büchi automaton exist for this formula.  It only
    means Spot could not find it.

    "autfilt -D" will determinize any automaton, because --generic
    acceptance is the default for autfilt.

    "autfilt -D --tgba" will behave like "ltl2tgba -D", i.e., it may
    fail to find a deterministic automaton (even if one exists) and
    return a nondeterministic automaton.

383
384
385
386
387
  * "autfilt --complement" now also works for non-deterministic
    automata but will output a deterministic automaton.
    "autfilt --complement --tgba" will likely output a
    nondeterministic TGBA.

388
389
390
  * autfilt has a new option, --included-in, to filter automata whose
    language are included in the language of a given automaton.

391
392
393
  * autfilt has a new option, --equivalent-to, to filter automata
    that are equivalent (language-wise) to a given automaton.

394
395
396
397
398
399
400
  * ltlcross has a new option --determinize to instruct it to
    complement non-deterministic automata via determinization.  This
    option is not enabled by default as it can potentially be slow and
    generate large automata.  When --determinize is given, option
    --product=0 is implied, since the tests based on products with
    random state-space are pointless for deterministic automata.

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
401
402
403
  * ltl2tgba and ltldo now support %< and %> in the string passed
    to --stats when reading formulas from a CSV file.

404
405
406
407
408
  * ltlfilt's option --size-min=N, --size-max=N, --bsize-min=N, and
    --bsize-max=N have been reimplemented as --size=RANGE and
    --bsize=RANGE.  The old names are still supported for backward
    compatibility, but they are not documented anymore.

409
410
  * ltlfilt's option --ap=N can now take a RANGE as parameter.

411
412
413
  * autfilt now has a --ap=RANGE option to filter automata by number
    of atomic propositions.

414
415
416
417
418
  Library:

  * Building products with different dictionaries now raise an
    exception instead of using an assertion that could be disabled.

419
  * The load_ltsmin() function has been split in two.  Now you should
420
    first call ltsmin_model::load(filename) to create an ltsmin_model,
421
    and then call the ltsmin_model::kripke(...) method to create an
422
423
424
    automaton that can be iterated on the fly.  The intermediate
    object can be queried about the supported variables and their
    types.
425

426
427
428
429
430
431
432
433
434
435
436
437
  * print_dot() now accepts several new options:
    - use "<N" to specify a maximum number of states to output.
      Incomplete states are then marked appropriately.  For a quick
      example, compare
	ltl2tgba -D 'Ga | Gb | Gc' -d'<3'
      with
        ltl2tgba -D 'Ga | Gb | Gc' -d
    - use "C(color)" to specify the color to use for filling states.
    - use "#" to display the internal number of each transition
    - use "k" to use state-based labels when possible.  This is
      similar to the "k" option already supported by print_hoa(), and
      is useful when printing Kripke structures.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
438

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
439
440
  * Option "k" is automatically used by print_dot() and print_hoa()
    when printing Kripke structures.
441

442
443
444
445
  * print_dot() also honnor two new automaton properties called
    "highlight-edges" and "highlight-states".  These are used to color
    a subset of edges or transitions.

446
447
448
449
  * There is a new tgba_determinize() function.  Despite its name, it
    in facts works on transition-based Büchi automaton, and will first
    degeneralize any automaton with generalized Büchi acceptance.

450
451
452
  * The twa_safra_complement class has been removed.  Use
    tgba_determinize() and dtwa_complement() instead.

453
454
  * The twa::transition_annotation() and
    twa::compute_support_conditions() methods have been removed.
455

456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
  * The interface for all functions parsing formulas (LTL, PSL, SERE,
    etc.) has been changed to use an interface similar to the one used
    for parsing automata.  These function now return a parsed_formula
    object that includes both a formula and a list of syntax errors.

    Typically a function written as

       spot::formula read(std::string input)
       {
	  spot::parse_error_list pel;
	  spot::formula f = spot::parse_infix_psl(input, pel);
	  if (spot::format_parse_errors(std::cerr, input, pel))
	    exit(2);
	  return f;
       }

    should be updated to

       spot::formula read(std::string input)
       {
	  spot::parsed_formula pf = spot::parse_infix_psl(input);
	  if (pf.format_errors(std::cerr))
	    exit(2);
	  return pf.f;
       }

482
483
  Python:

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
484
485
486
  * The ltsmin interface has been binded in Python.  It also
    comes with a %%dve cell magic to edit DiVinE models in the notebook.
    See https://spot.lrde.epita.fr/ipynb/ltsmin.html for a short example.
487

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
488
489
490
491
492
  * spot.setup() sets de maximum number of states to display in
    automata to 50 by default, as more states is likely to be
    unreadable (and slow to process by GraphViz).  This can be
    overridden by calling spot.setup(max_states=N).

493
494
495
496
  * Automata now have methods to color selected states and
    transitions.  See
    https://spot.lrde.epita.fr/ipynb/highlighting.html for an example.

497
498
499
500
501
  Documentation:

  * There is a new page giving informal illustrations (and extra
    pointers) for some concepts used in Spot.
    See https://spot.lrde.epita.fr/concepts.html
502

503
  Bug fixes:
504
505
506

  * Using ltl2tgba -U would fail to output the unambiguous property
    (regression introduced in 1.99.7)
507
508
  * ltlfilt, autfilt, randltl, and randaut could easily crash when
    compiled statically (i.e., with configure --disable-shared).
509
  * "1 U (a | Fb)" was not always simplified to "F(a | b)".
510
511
  * destroying the operands of an otf_product() before the product
    itself could crash.
512

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
513
New in spot 1.99.7 (2016-01-15)
514
515
516

  Command-line tools:

517
  * BACKWARD INCOMPATIBLE CHANGE: All tools that output automata now
518
    use the HOA format by default instead of the GraphViz output.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
519
    This makes it easier to pipe several commands together.
520
521
522
523
524
525

    If you have an old script that relies on GraphViz being the default
    output and that you do not want to update it, use
       export SPOT_DEFAULT_FORMAT=dot
    to get the old behavior back.

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
526
527
528
  * Tools that output automata now accept -d as a shorthand for --dot
    since requesting the GraphViz (a.k.a. dot) output by hand is now
    more frequent.
529
530
    randaut's short option for specifying edge-density used to be -d:
    it has been renamed to -e.
531

532
  * The SPOT_DEFAULT_FORMAT environment variable can be set to 'dot'
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
533
534
    or 'hoa' to force a default output format for automata.  Additional
    options may also be added, as in SPOT_DEFAULT_FORMAT='hoa=iv'.
535

536
537
  * autfilt has a new option: --is-inherently-weak.

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
538
539
540
  * The --check=strength option of all tools that produce automata
    will also test if an automaton is inherently weak.

541
542
  Library:

543
544
545
546
547
548
549
550
551
  * Installed headers now assume that they will be included as
    #include <spot/subdir/header.hh>
    instead of
    #include <subdir/header.hh>

    This implies that when Spot headers are installed in
    /usr/include/spot/... (the default when using the Debian packages)
    or /usr/local/include/spot/... (the default when compiling from
    source), then it is no longuer necessary to add
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
552
553
554
    -I/usr/include/spot or -I/usr/local/include/spot when compiling,
    as /usr/include and /usr/local/include are usually searched by
    default.
555
556
557
558

    Inside the source distribution, the subdirectory src/ has been
    renamed to spot/, so that the root of the source tree can also be
    put on the preprocessor's search path to compile against a
559
560
    non-installed version of Spot.  Similarly, iface/ltsmin/ has been
    renamed to spot/ltsmin/, so that installed and non-installed
561
    directories can be used similarly.
562

563
564
565
566
  * twa::~twa() is now calling
      get_dict()->unregister_all_my_variable(this);
    so this does not need to be done in any subclass.

567
568
569
570
  * is_inherently_weak_automaton() is a new function, and
    check_strength() has been modified to also check inherently weak
    automata.

571
572
573
574
  * decompose_strength() is now extracting inherently weak SCCs
    instead of just weak SCCs.  This gets rid of some corner cases
    that used to require ad hoc handling.

575
576
577
578
  * acc_cond::acc_code's methods append_or(), append_and(), and
    shift_left() have been replaced by operators |=, &=, <<=, and for
    completeness the operators |, &, and << have been added.

579
580
581
  * Several methods have been removed from the acc_cond
    class because they were simply redundant with the methods of
    acc_cond::mark_t, and more complex to use.
582

583
       acc_cond::marks(...)      -> use acc_cond::mark_t(...)
584
       acc_cond::sets(m)         -> use m.sets()
585
       acc_cond::has(m, u)       -> use m.has(u)
586
587
588
589
       acc_cond::cup(l, r)       -> use l | r
       acc_cond::cap(l, r)       -> use l & r
       acc_cond::set_minus(l, r) -> use l - r

590
    Additionally, the following methods/functions have been renamed:
591
592
593

       acc_cond::is_tt() -> acc_cond::is_t()
       acc_cond::is_ff() -> acc_cond::is_f()
594
       parse_acc_code()  -> acc_cond::acc_code(...)
595

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
596
  * Automata property flags (those that tell whether the automaton is
597
598
599
    deterministic, weak, stutter-invariant, etc.) are now stored using
    three-valued logic: in addition to "maybe"/"yes" they can now also
    represent "no".  This is some preparation for the upcomming
600
601
602
603
604
605
606
607
    support of the HOA v1.1 format, but it also saves time in some
    algorithms (e.g, is_deterministic() can now return immediately on
    automata marked as not deterministic).

  * The automaton parser now accept negated properties as they will be
    introduced in HOA v1.1, and will check for some inconsistencies.
    These properties are stored and used when appropriate, but they
    are not yet output by the HOA printer.
608

609
610
  Python:

611
612
613
614
  * Iterating over the transitions leaving a state (the
    twa_graph::out() C++ function) is now possible in Python.  See
    https://spot.lrde.epita.fr/tut21.html for a demonstration.

615
616
617
618
  * Membership to acceptance sets can be specified using Python list
    when calling for instance the Python version of twa_graph::new_edge().
    See https://spot.lrde.epita.fr/tut22.html for a demonstration.

619
620
621
  * Automaton states can be named via the set_state_names() method.
    See https://spot.lrde.epita.fr/ipynb/product.html for an example.

622
623
624
625
626
  Documentation:

  * There is a new page explaining how to compile example programs and
    and link them with Spot.  https://spot.lrde.epita.fr/compile.html

627
628
629
630
631
  * Python bindings for manipulating acceptance conditions are
    demonstrated by https://spot.lrde.epita.fr/ipynb/acc_cond.html,
    and a Python implementation of the product of two automata is
    illustrated by https://spot.lrde.epita.fr/ipynb/product.html

632
633
634
635
636
637
638
639
640
641
642
643
  Source code reorganisation:

  * A lot of directories have been shuffled around in the
    distribution:
      src/                   ->  spot/    (see rational above)
      iface/ltsmin/  (code)  ->  spot/ltsmin/
      wrap/python/           ->  python/
      src/tests/             ->  tests/core/
      src/sanity/            ->  tests/sanity/
      iface/ltsmin/  (tests) ->  tests/ltsmin/
      wrap/python/tests      ->  tests/python/

644
645
  Bug fixes:

646
647
  * twa_graph would incorrectly replace named-states during
    purge_dead_states and purge_unreachable_states.
648
649
  * twa::ap() would contain duplicates when an atomic proposition
    was registered several times.
650
651
  * product() would incorrectly mark the product of two
    sttuter-sensitive automata as stutter-sensitive as well.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
652
653
  * complete() could incorrectly reuse an existing (but accepting!)
    state as a sink.
654

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
655
New in spot 1.99.6 (2015-12-04)
656

657
658
  Command-line tools:

659
660
661
662
  * autfilt has two new filters: --is-weak and --is-terminal.

  * autfilt has a new transformation: --decompose-strength,
    implementing the decomposition of our TACAS'13 paper.
663
664
    A demonstration of this feature via the Python bindings
    can be found at https://spot.lrde.epita.fr/ipynb/decompose.html
665

666
667
668
669
670
671
  * All tools that output HOA files accept a --check=strength option
    to request automata to be marked as "weak" or "terminal" as
    appropriate.  Without this option, these properties may only be
    set as a side-effect of running transformations that use this
    information.

672
673
674
675
676
677
678
  Library:

  * Properties of automata (like the "properties:" line of the HOA
    format) are stored as bits whose interpretation is True=yes,
    False=maybe.  Having getters like "aut->is_deterministic()" or
    "aut->is_unambiguous()" was confusing, because there are separate
    functions "is_deterministic(aut)" and "is_unambiguous(aut)" that
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
679
680
    do actually check the automaton.  The getters have been renamed to
    avoid confusion, and get names more in line with the HOA format.
681
682
683
684
685
686
687
688
689

    - twa::has_state_based_acc() -> twa::prop_state_acc()
    - twa::prop_state_based_acc(bool) -> twa::prop_state_acc(bool)
    - twa::is_inherently_weak() -> twa::prop_inherently_weak()
    - twa::is_deterministic() -> twa::prop_deterministic()
    - twa::is_unambiguous() -> twa::prop_unambiguous()
    - twa::is_stutter_invariant() -> twa::prop_stutter_invariant()
    - twa::is_stutter_sensitive() -> twa::prop_stutter_sensitive()

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
690
    The setters have the same names as the getters, except they take a
691
692
693
    Boolean argument.  This argument used to be optionnal (defaulting
    to True), but it no longer is.

694
695
696
697
698
699
700
701
702
703
  * Automata now support the "weak" and "terminal" properties in
    addition to the previously supported "inherently-weak".

  * By default the HOA printer tries not to bloat the output with
    properties that are redundant and probably useless.  The HOA
    printer now has a new option "v" (use "-Hv" from the command line)
    to output more verbose "properties:".  This currently includes
    outputing "no-univ-branch", outputting "unambiguous" even for
    automata already tagged as "deterministic", and "inherently-weak"
    or "weak" even for automata tagged "weak" or "terminal".
704

705
706
707
708
  * The HOA printer has a new option "k" (use "-Hk" from the command
    line) to output automata using state labels whenever possible.
    This is useful to print Kripke structures.

709
710
711
712
713
  * The dot output will display pair of states when displaying an
    automaton built as an explicit product.  This works in IPython
    with spot.product() or spot.product_or() and in the shell with
    autfilt's --product or --product-or options.

714
715
716
717
718
719
720
  * The print_dot() function supports a new option, +N, where N is a
    positive integer that will be added to all set numbers in the
    output.  This is convenient when displaying two automata before
    building their product: use +N to shift the displayed sets of the
    second automaton by the number of acceptance sets N of the first
    one.

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
721
  * The sat minimization for DTωA now does a better job at selecting
722
723
724
725
726
    reference automata when the output acceptance is the the same as
    the input acceptance.  This can provide nice speedups when tring
    to syntethise larged automata with different acceptance
    conditions.

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
727
  * Explicit Kripke structures (i.e., stored as explicit graphs) have
728
    been rewritten above the graph class, using an interface similar
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
729
730
    to the twa class.  The new class is called kripke_graph.  The ad
    hoc Kripke parser and printer have been removed, because we can
731
732
    now use print_hoa() with the "k" option to print Kripke structure
    in the HOA format, and furthermore the parse_aut() function now
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
733
    has an option to load such an HOA file as a kripke_graph.
734

735
736
737
738
  * The HOA parser now accepts identifier, aliases, and headernames
    containing dots, as this will be allowed in the next version of
    the HOA format.

739
740
  * Renamings:
    is_guarantee_automaton() -> is_terminal_automaton()
741
    tgba_run -> twa_run
742
    twa_word::print -> operator<<
743
744
    dtgba_sat_synthetize() -> dtwa_sat_synthetize()
    dtgba_sat_synthetize_dichotomy() -> dtwa_sat_synthetize_dichotomy()
745

746
  Python:
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
747

748
  * Add bindings for is_unambiguous().
749
  * Better interface for sat_minimize().
750

751
  Bug fixes:
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
752

753
  * the HOA parser was ignoring the "unambiguous" property.
754
755
  * --dot=Bb should work like --dot=b, allowing us to disable
    a B option set via an environment variable.
756

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
757
New in spot 1.99.5 (2015-11-03)
758

759
760
761
  Command-line tools:

  * autfilt has gained a --complement option.
762
    It currently works only for deterministic automata.
763

764
  * By default, autfilt does not simplify automata (this has not
765
    changed), as if the --low --any options were used.  But now, if
766
767
768
    one of --small, --deterministic, or --any is given, the
    optimization level automatically defaults to --high (unless
    specified otherwise).  For symmetry, if one of --low, --medium, or
769
    --high is given, then the translation intent defaults to --small
770
771
    (unless specified otherwise).

772
773
774
775
  * autfilt, dstar2tgba, ltlcross, and ltldo now trust the (supported)
    automaton properties declared in any HOA file they read.  This can
    be disabled with option --trust-hoa=no.

776
777
778
  * ltlgrind FILENAME[/COL] is now the same as
    ltlgrind -F FILENAME[/COL] for consistency with ltlfilt.

779
780
  Library:

781
782
783
784
785
  * dtgba_complement() was renamed to dtwa_complement(), moved to
    complement.hh, and its purpose was restricted to just completing
    the automaton and complementing its acceptance condition.  Any
    further acceptance condition transformation can be done with
    to_generalized_buchi() or remove_fin().
786
787
788
789
790

  * The remove_fin() has learnt how to better deal with automata that
    are declared as weak.  This code was previously in
    dtgba_complement().

791
792
793
794
795
  * scc_filter_states() has learnt to remove useless acceptance marks
    that are on transitions between SCCs, while preserving state-based
    acceptance.  The most visible effect is in the output of "ltl2tgba
    -s XXXa": it used to have 5 accepting states, it now has only one.
    (Changing removing acceptance of those 4 states has no effect on
796
    the language, but it speeds up some algorithms like NDFS-based
797
798
    emptiness checks, as discussed in our Spin'15 paper.)

799
800
801
  * The HOA parser will diagnose any version that is not v1, unless it
    looks like a subversion of v1 and no parse error was detected.

802
  * The way to pass option to the automaton parser has been changed to
803
    make it easier to introduce new options.  One such new option is
804
805
    "trust_hoa": when true (the default) supported properties declared
    in HOA files are trusted even if they cannot be easily be verified.
806
807
808
809
810
    Another option "raise_errors" now replaces the method
      automaton_stream_parser::parse_strict().

  * The output of the automaton parser now include the list of parse
    errors (that does not have to be passed as a parameters) and the
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
811
    input filename (making the output of error messages easier).
812

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
813
  * The following renamings make the code more consistent:
814
815
816
    ltl_simplifier -> tl_simplifier
    tgba_statistics::transitions -> twa_statistics::edges
    tgba_sub_statistics::sub_transitions -> twa_sub_statistics::transitions
817
    tgba_run -> twa_run
818
    reduce_run -> twa_run::reduce
819
820
821
822
    replay_tgba_run -> twa_run::replay
    print_tgba_run -> operator<<
    tgba_run_to_tgba -> twa_run::as_twa
    format_parse_aut_errors -> parsed_aut::format_errors
823
824
825
826
827
828
    twa_succ_iterator::current_state -> twa_succ_iterator::dst
    twa_succ_iterator::current_condition -> twa_succ_iterator::cond
    twa_succ_iterator::current_acceptance_conditions -> twa_succ_iterator::acc
    ta_succ_iterator::current_state -> ta_succ_iterator::dst
    ta_succ_iterator::current_condition -> ta_succ_iterator::cond
    ta_succ_iterator::current_acceptance_conditions -> ta_succ_iterator::acc
829

830
831
  Python:

832
  * The minimum supported Python version is now 3.3.
833
  * Add bindings for complete() and dtwa_complement()
834
835
  * Formulas now have a custom __format__ function.  See
    https://spot.lrde.epita.fr/tut01.html for examples.
836
837
  * The Debian package is now compiled for all Python3 versions
    supported by Debian, not just the default one.
838
  * Automata now have get_name()/set_name() methods.
839
840
841
  * spot.postprocess(aut, *options), or aut.postprocess(*options)
    simplify the use of the spot.postprocessor object.  (Just like we
    have spot.translate() on top of spot.translator().)
842
843
844
845
846
847
848
849
  * spot.automata() and spot.automaton() now have additional
    optional arguments:
    - timeout: to restrict the runtime of commands that
      produce automata
    - trust_hoa: can be set to False to ignore HOA properties
      that cannot be easily verified
    - ignore_abort: can be set to False if you do not want to
      skip automata ended with --ABORT--.
850

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
851
852
853
854
855
856
  Documentation:

  * There is a new page showing how to use spot::postprocessor
    to convert any type of automaton to Büchi.
    https://spot.lrde.epita.fr/tut30.html

857
858
  Bugs fixed:

859
  * Work around some weird exception raised when using the
860
861
862
863
864
    randltlgenerator under Python 3.5.
  * Recognize "nullptr" formulas as None in Python.
  * Fix compilation of bench/stutter/
  * Handle saturation of formula reference counts.
  * Fix typo in the Python code for the CGI server.
865
  * "randaut -Q0 1" used to segfault.
866
867
  * "ltlgrind -F FILENAME/COL" did not preserve other CSV columns.
  * "ltlgrind --help" did not document FORMAT.
868
  * unabbreviate could easily use forbidden operators.
869
870
  * "autfilt --is-unambiguous" could fail to detect the nonambiguity
    of some automata with empty languages.
871
872
873
  * When parsing long tokens (e.g, state labels representing
    very large strings) the automaton parser could die with
    "input buffer overflow, can't enlarge buffer because scanner uses REJECT"
874

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
875
New in spot 1.99.4 (2015-10-01)
876

877
878
  New features:

879
880
881
882
  * autfilt's --sat-minimize now takes a "colored" option to constrain
    all transitions (or states) in the output automaton to belong to
    exactly one acceptance sets.  This is useful when targeting parity
    acceptance.
883

884
885
886
887
888
889
890
891
892
893
  * autfilt has a new --product-or option.  This builds a synchronized
    product of two (completed of needed) automata in order to
    recognize the *sum* of their languages.  This works by just using
    the disjunction of their acceptance conditions (with appropriate
    renumbering of the acceptance sets).

    For consistency, the --product option (that builds a synchronized
    product that recognizes the *intersection* of the languages) now
    also has a --product-and alias.

894
895
896
897
898
899
900
901
902
903
  * the parser for ltl2dstar's format has been merged with the parser
    for the other automata formats.  This implies two things:
    - autfilt and dstar2tgba (despite its name) can now both read
      automata written in any of the four supported syntaxes
      (ltl2dstar's, lbtt's, HOA, never claim).
    - "dstar2tgba some files..." now behaves exactly like
      "autfilt --tgba --high --small some files...".
      (But dstar2tgba does not offer all the filtering and
      transformations options of autfilt.)

904
905
  Major code changes and reorganization:

906
907
908
  * The class hierarchy for temporal formulas has been entirely
    rewritten.  This change is actually quite massive (~13200 lines
    removed, ~8200 lines added), and brings some nice benefits:
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
909
    - LTL/PSL formulas are now represented by lightweight formula
910
911
912
913
      objects (instead of pointers to children of an abstract
      formula class) that perform reference counting automatically.
    - There is no hierachy anymore: all operators are represented by
      a single type of node in the syntax tree, and an enumerator is
914
      used to distinguish between operators.
915
916
917
918
919
920
921
922
    - Visitors have been replaced by member functions such as map()
      or traverse(), that take a function (usually written as a
      lambda function) and apply it to the nodes of the tree.
    - As a consequence, writing algorithms that manipulate formula
      is more friendly, and several algorithms that spanned a few
      pages have been reduced to a few lines.
    The page https://spot.lrde.epita.fr/tut03.html illustrates the
    new interface, in both C++ and Python.
923

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
924
925
926
927
928
  * Directories ltlast/, ltlenv/, and ltlvisit/, have been merged into
    a single tl/ directory (for temporal logic).  This is motivated by
    the fact that these formulas are not restricted to LTL, and by the
    fact that we no longuer use the "visitor" pattern.

929
930
931
  * The LTL/PSL parser is now declared in tl/parse.hh (instead of
    ltlparse/public.hh).

932
933
934
935
936
937
938
939
940
941
942
  * The spot::ltl namespace has been merged with the spot namespace.

  * The dupexp_dfs() function has been renamed to copy(), and has
    learned to preserve named states if required.

  * Atomic propositions can be declared without going through an
    environment using the spot::formula::ap() static function.  They
    can be registered for an automaton directly using the
    spot::twa::register_ap() method.  The vector of atomic
    propositions used by an automaton can now be retrieved using the
    spot::twa::ap() method.
943

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
944
New in spot 1.99.3 (2015-08-26)
945

946
947
948
  * The CGI script for LTL translation offers a HOA download link
    for each generated automaton.

949
  * The html documentation now includes a HTML copies of the man
950
    pages, and HTML copies of the Python notebooks.
951

952
953
954
955
  * scc_filter(aut, true) does not remove Fin marks from rejecting
    SCCs, but it now does remove Fin marks from transitions between
    SCCs.

956
957
958
  * All the unabbreviation functions (unabbreviate_ltl(),
    unabbreviate_logic(), unabbreviate_wm()) have been merged into a
    single unabbreviate() function that takes a string representing
959
960
961
    the list of operators to remove among "eFGiMRW^" where 'e', 'i',
    and '^' stand respectively for <->, ->, and xor.
    This feature is also available via ltlfilt --unabbreviate.
962

963
964
965
966
  * In LTL formulas, atomic propositions specified using double-quotes
    can now include \" and \\.  (This is more consistent with the HOA
    format, which already allows that.)

967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
  * All the conversion routines that were written specifically for
    ltl2dstar's output format (DRA->BA & DRA->TGBA) have been ported
    to the new TωA structure supporting the HOA format.  The DRA->TGBA
    conversion was reimplemented in the previous release, and the
    DRA->BA conversion has been reimplemented in this release (but it
    is still restricted to state-based acceptance).  All these
    conversions are called automatically by to_generalized_buchi()
    or remove_fin() so there should be no need to call them directly.

    As a consequence:
    - "autfilt --remove-fin" or "autfilt -B" is better at converting
      state-based Rabin automata: it will produce a DBA if the input is
      deterministic and DBA-realizable, but will preserve as much
      determinism as possible otherwise.
    - a lot of obsolete code that was here only to support the old
      conversion routines has been removed.  (The number of lines
      removed by this release is twice the number of lines added.)
    - ltlcross now uses automata in ltl2dstar's format directly,
      without converting them to Büchi (this makes the statistics
      reported in CSV files more relevant).
    - ltlcross no longer outputs additional columns about the size
      of the input automaton in the case ltl2dstar's format is used.
    - ltldo uses results in ltl2dstar's format directly, without
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
990
      converting them to Büchi.
991
992
    - dstar2tgba has been greatly simplified and now uses the
      same output routines as all the other tools that output
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
993
      automata.  This implies a few minor semantic changes, for
994
      instance --stats=%A used to output the number of acceptance
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
995
      *pairs* in the input automaton, while it now outputs the
996
997
      number of acceptance sets like in all the other tools.

998
999
  * Bugs fixed
    - Some acceptance conditions like Fin(0)|Fin(1)|Fin(2)&Inf(3)
1000
      were not detected as generalized-Rabin.
1001
1002
    - Unknown arguments for print_hoa() (i.e., option -H in command-line
      tools) are now diagnosed.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1003
    - The CGI script for LTL translation now forces transition-based
1004
1005
1006
1007
      acceptance on WDBA-minimized automata when TGBA is requested.
    - ltlgrind --help output had some options documented twice, or
      in the wrong place.
    - The man page for ltlcross had obsolete examples.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1008
1009
    - When outputting atomic propositions in double quotes, the
      escaping routine used by the two styles of LaTeX output was
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1010
1011
      slightly wrong.  For instance ^ was incorrectly escaped, and
      the double quotes where not always properly rendered.
1012
1013
    - A spurious assertion was triggered by streett_to_generalized_buchi(),
      but only when compiled in DEBUG mode.
1014
    - LTL formula rewritten in Spin's syntax no longer have their ->
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1015
      and <-> rewritten away.
1016
    - Fix some warnings reported by the development version of GCC 6.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1017
    - The spot.translate() function of the Python binding had a typo
1018
      preventing the use of 'low'/'medium'/'high' as argument.
1019
    - Fix spurious failure of uniq.test under different locales.
1020
1021
    - ltlcross now recovers from out-of-memory errors during
      state-space products.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1022
1023
    - bitvect.test was failing on 32bit architectures with
      assertions enabled because of a bug in the test case.
1024

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1025
New in spot 1.99.2 (2015-07-18)
1026

1027
  * The scc_info object, used to build a map of SCCs while gathering
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1028
    additional information, has been simplified and speed up.  One
1029
    test case where ltlcross would take more than 13min (to check the
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1030
    translation of one PSL formula) now takes only 75s.
1031

1032
1033
1034
  * streett_to_generalized_buchi() is a new function that implements
    what its name suggests, with some SCC-based optimizations over the
    naive definition.  It is used by the to_generalized_buchi() and
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1035
    remove_fin() functions when the input automaton is a Streett
1036
1037
1038
1039
1040
1041
1042
1043
1044
    automaton with more than 3 pairs (this threeshold can be changed
    via the SPOT_STREETT_CONV_MIN environment variable -- see the
    spot-x(7) man page for details).

    This is mainly useful to ltlcross, which has to get rid of "Fin"
    acceptance to perform its checks.  As an example, the Streett
    automaton generatated by ltl2dstar (configured with ltl2tgba) for
    the formula
      !((GFa -> GFb) & (GFc -> GFd))
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1045
1046
1047
1048
    has 4307 states and 14 acceptance sets.  The new algorithm can
    translate it into a TGBA with 9754 states and 7 acceptance sets,
    while the default approch used for converting any acceptance
    to TGBA would produce 250967 states and 7 acceptance sets.
1049

1050
  * Bugs fixed:
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1051
    - p[+][:*2] was not detected as belonging to siPSL.
1052
1053
    - scc_filter() would incorrectly remove Fin marks from
      rejecting SCCs.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1054
    - the libspotltsmin library is installed.
1055
    - ltlcross and ltldo did not properly quote atomic propositions
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1056
1057
      and temporary file names containing a single-quote.
    - a missing Python.h is now diagnosed at ./configure time, with
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1058
1059
1060
1061
      the suggestion to either install python3-devel, or run
      ./configure --disable-python.
    - Debian packages for libraries have been split from
      the main Spot package, as per Debian guidelines.
1062

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1063
New in spot 1.99.1 (2015-06-23)
1064

1065
1066
1067
1068
1069
  * Major changes motivating the jump in version number

    - Spot now works with automata that can represent more than
      generalized Büchi acceptance.  Older versions were built around
      the concept of TGBA (Transition-based Generalized Büchi
1070
      Automata) while this version now deals with what we call TωA
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
      (Transition-based ω-Automata).  TωA support arbitrary acceptance
      conditions specified as a Boolean formula of transition sets
      that must be visited infinitely often or finitely often.  This
      genericity allows for instance to represent Rabin or Streett
      automata, as well as some generalized variants of those.

    - Spot has near complete support for the Hanoi Omega Automata
      format.  http://adl.github.io/hoaf/  This formats supports
      automata with the generic acceptance condition described above,
      and has been implemented in a number of third-party tools (see
      http://adl.github.io/hoaf/support.html) to ease their
      interactions.  The only part of the format not yet implemented in
      Spot is the support for alternating automata.

    - Spot is now compiling in C++11 mode.  The set of C++11 features
      we use requires GCC >= 4.8 or Clang >= 3.5.  Although GCC 4.8 is
      more than 2-year old, people with older installations won't be
      able to install this version of Spot.

1090
    - As a consequence of the switches to C++11 and to TωA, a lot of
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
      the existing C++ interfaces have been renamed, and sometime
      reworked.  This makes this version of Spot not backward
      compatible with Spot 1.2.x.  See below for the most important
      API changes.  Furtheremore, the reason this release is not
      called Spot 2.0 is that we have more of those changes planned.

    - Support for Python 2 was dropped.  We now support only Python
      3.2 or later.  The Python bindings have been improved a lot, and
      include some conveniance functions for better integration with
      IPython's rich display system.  User familiar with IPython's
      notebook should have a look at the notebook files in
      wrap/python/tests/*.ipynb

  * Major news for the command-line tools

    - The set of tools installed by spot now consists in the following
      11 commands.  Those marked with a '+' are new in this release.

      - randltl    Generate random LTL/PSL formulas.
      - ltlfilt    Filter and convert LTL/PSL formulas.
      - genltl     Generate LTL formulas from scalable patterns.
      - ltl2tgba   Translate LTL/PSL formulas into Büchi automata.
      - ltl2tgta   Translate LTL/PSL formulas into Testing automata.
      - ltlcross   Cross-compare LTL/PSL-to-Büchi translators.
      + ltlgrind   Mutate LTL/PSL formula.
      - dstar2tgba Convert deterministic Rabin or Streett automata into Büchi.
      + randaut    Generate random automata.
      + autfilt    Filter and convert automata.
      + ltldo      Run LTL/PSL formulas through other tools.

      randaut does not need any presentation: it does what you expect.

      ltlgrind is a new tool that mutates LTL or PSL formulas.  If you
1124
      have a tool that is bogus on some formula that is too large to
1125
1126
1127
      debug, you can use ltlgrind to generate smaller derived formulas
      and see if you can reproduce the bug on those.

1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
      autfilt is a new tool that processes a stream of automata.  It
      allows format conversion, filtering automata based on some
      properties, and general transformations (e.g., change of
      acceptance conditions, removal of useless states, product
      between automata, etc.).

      ltldo is a new tool that runs LTL/PSL formulas through other
      tools, but uses Spot's command-line interfaces for specifying
      input and output.  This makes it easier to use third-party tool
      in a pipe, and it also takes care of some necessary format
      conversion.

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1140
    - ltl2tgba has a new option, -U, to produce unambiguous automata.
1141
1142
1143
      In unambiguous automata any word is recognized by at most one
      accepting run, but there might be several ways to reject a word.
      This works for LTL and PSL formulas.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1144

1145
    - ltl2tgba has a new option, -S, to produce generalized-Büchi
1146
1147
1148
1149
1150
      automata with state-based acceptance.  Those are obtained by
      converting some transition-based GBA into a state-based GBA, so
      they are usually not as small as one would wish.  The same
      option -S is also supported by autfilt.

1151
1152
1153
1154
1155
    - ltlcross will work with translator producing automata with any
      acceptance condition, provided the output is in the HOA format.
      So it can effectively be used to validate tools producing Rabin
      or Streett automata.

1156
    - ltlcross has several new options:
1157

1158
1159
        --grind attempts to reduce the size of any bogus formula it
        discovers, while still exhibiting the bug.
1160

1161
1162
        --ignore-execution-failures ignores cases where a translator
        exits with a non-zero status.
1163
1164

	--automata save the produced automata into the CSV or JSON
1165
        file.  Those automata are saved using the HOA format.
1166
1167
1168
1169
1170

      ltlcross will also output two extra columns in its CSV/JSON
      output: "ambiguous_aut" and "complete_aut" are Boolean
      that respectively tells whether the automaton is
      ambiguous and complete.
1171

1172
    - "ltlfilt --stutter-invariant" will now work with PSL formulas.
1173
      The implementation is actually much more efficient
1174
      than our previous implementation that was only for LTL.
1175

1176
1177
1178
1179
1180
    - ltlfilt's old -q/--quiet option has been renamed to
      --ignore-errors.  The new -q/--quiet semantic is the
      same as in grep (and also autfilt): disable all normal
      input, for situtations where only the exit status matters.

1181
1182
1183
1184
    - ltlfilt's old -n/--negate option can only be used as --negate
      now.  The short '-n NUM' option is now the same as the new
      --max-count=N option, for consistency with other tools.

1185
1186
1187
    - ltlfilt has a new --count option to count the number of matching
      automata.

1188
1189
1190
    - ltlfilt has a new --exclusive-ap option to constrain formulas
      based on a list of mutually exclusive atomic propositions.

1191
1192
1193
1194
    - ltlfilt has a new option --define to be used in conjunction with
      --relabel or --relabel-bool to print the mapping between old and
      new labels.

1195
1196
1197
1198
1199
1200
    - all tools that produce formulas or automata now have an --output
      (a.k.a. -o) option to redirect that output to a file instead of
      standard output.  The name of this file can be constructed using
      the same %-escape sequences that are available for --stats or
      --format.

1201
1202
1203
1204
    - all tools that output formulas have a -0 option to separate
      formulas with \0.  This helps in conjunction with xargs -0.

    - all tools that output automata have a --check option that
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
      request extra checks to be performed on the output to fill
      in properties values for the HOA format.  This options
      implies -H for HOA output.  For instance
      	ltl2tgba -H 'formula'
      will declare the output automaton as 'stutter-invariant'
      only if the formula is syntactically stutter-invariant
      (e.g., in LTL\X).  With
        ltl2tgba --check 'formula'
      additional checks will be performed, and the automaton
      will be accurately marked as either 'stutter-invariant'
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1215
1216
      or 'stutter-sensitive'.  Another check performed by
      --check is testing whether the automaton is unambiguous.
1217

1218
1219
1220
1221
1222
1223
    - ltlcross (and ltldo) have a list of hard-coded shorthands
      for some existing tools.  So for instance running
      'ltlcross spin ...' is the same as running
      'ltlcross "spin -f %s>%N" ...'.   This feature is much
      more useful for ltldo.

1224
1225
    - For options that take an output filename (i.e., ltlcross's
      --save-bogus, --grind, --csv, --json) you can force the file
1226
1227
      to be opened in append mode (instead of being truncated) by
      by prefixing the filename with ">>".  For instance
1228
1229
1230
      	  --save-bogus=">>bugs.ltl"
      will append to the end of the file.

1231
1232
  * Other noteworthy news

1233
1234
1235
1236
1237
1238
1239
1240
    - The web site moved to http://spot.lrde.epita.fr/.

    - We now have Debian packages.
      See http://spot.lrde.epita.fr/install.html

    - The documentation now includes some simple code examples
      for both Python and C++.  (This is still a work in progress.)

1241
1242
1243
1244
    - The curstomized version of BuDDy (libbdd) used by Spot has be
      renamed as (libbddx) to avoid issues with copies of BuDDy
      already installed on the system.

1245
1246
    - There is a parser for the HOA format
      (http://adl.github.io/hoaf/) available as a
1247
1248
1249
1250
1251
1252
      spot::automaton_stream_parser object or spot::parse_aut()
      function.  The former version is able to parse a stream of
      automata in order to do batch processing.  This format can be
      output by all tools (since Spot 1.2.5) using the --hoa option,
      and it can be read by autfilt (by default) and ltlcross (using
      the %H specifier).  The current implementation does not support
1253
1254
      alternation.  Multiple initial states are converted into an
      extra initial state; complemented acceptance sets Inf(!x) are
1255
1256
      converted to Inf(x); explicit or implicit labels can be used;
      aliases are supported; "--ABORT--" can be used in a stream.
1257

1258
1259
1260
1261
1262
1263
    - The above HOA parser can also parse never claims, and LBTT
      automata, so the never claim parser and the LBTT parser have
      been removed.  This implies that autfilt can input a mix of HOA,
      never claims, and LBTT automata.  ltlcross also use the same
      parser for all these output, and the old %T and %N specifiers
      have been deprecated and replaced by %O (for output).
1264

1265
1266
    - While not all algorithms in the library are able to work with
      any acceptance condition supported by the HOA format, the
1267
      following two new functions mitigate that:
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277