NEWS 117 KB
Newer Older
1
2
New in spot 1.99.7a (not yet released)

3
4
5
6
7
  Command-line tools:

  * ltl2tgba and ltldo now support %< and %> in the string passed
    to --stats when reading formulas from a CSV file.

8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
  * 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.

35
36
37
38
39
  Library:

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

40
  * The load_ltsmin() function has been split in two.  Now you should
41
    first call ltsmin_model::load(filename) to create an ltsmin_model,
42
    and then call the ltsmin_model::kripke(...) method to create an
43
44
45
    automaton that can be iterated on the fly.  The intermediate
    object can be queried about the supported variables and their
    types.
46

47
48
49
50
51
52
53
54
55
56
57
58
  * 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
59

60
61
62
  * Option "k" is automatically passed used by print_dot() and
    print_hoa() when printing Kripke structures.

63
64
65
66
  * 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.

67
68
69
70
  * 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.

71
72
73
  * The twa_safra_complement class has been removed.  Use
    tgba_determinize() and dtwa_complement() instead.

74
75
76
77
78
  Python:

  * The ltsmin interface has been binded in Python.  See
    https://spot.lrde.epita.fr/ipynb/ltsmin.html for a short example.

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
79
80
81
82
83
  * 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).

84
85
86
87
  * Automata now have methods to color selected states and
    transitions.  See
    https://spot.lrde.epita.fr/ipynb/highlighting.html for an example.

88
89
90
91
92
  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
93

94
  Bug fixes:
95
96
97

  * Using ltl2tgba -U would fail to output the unambiguous property
    (regression introduced in 1.99.7)
98
99
  * ltlfilt, autfilt, randltl, and randaut could easily crash when
    compiled statically (i.e., with configure --disable-shared).
100
  * "1 U (a | Fb)" was not always simplified to "F(a | b)".
101

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
102
New in spot 1.99.7 (2016-01-15)
103
104
105

  Command-line tools:

106
  * BACKWARD INCOMPATIBLE CHANGE: All tools that output automata now
107
    use the HOA format by default instead of the GraphViz output.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
108
    This makes it easier to pipe several commands together.
109
110
111
112
113
114

    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
115
116
117
  * 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.
118
119
    randaut's short option for specifying edge-density used to be -d:
    it has been renamed to -e.
120

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

125
126
  * autfilt has a new option: --is-inherently-weak.

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

130
131
  Library:

132
133
134
135
136
137
138
139
140
  * 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
141
142
143
    -I/usr/include/spot or -I/usr/local/include/spot when compiling,
    as /usr/include and /usr/local/include are usually searched by
    default.
144
145
146
147

    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
148
149
    non-installed version of Spot.  Similarly, iface/ltsmin/ has been
    renamed to spot/ltsmin/, so that installed and non-installed
150
    directories can be used similarly.
151

152
153
154
155
  * twa::~twa() is now calling
      get_dict()->unregister_all_my_variable(this);
    so this does not need to be done in any subclass.

156
157
158
159
  * is_inherently_weak_automaton() is a new function, and
    check_strength() has been modified to also check inherently weak
    automata.

160
161
162
163
  * 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.

164
165
166
167
  * 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.

168
169
170
  * 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.
171

172
       acc_cond::marks(...)      -> use acc_cond::mark_t(...)
173
       acc_cond::sets(m)         -> use m.sets()
174
       acc_cond::has(m, u)       -> use m.has(u)
175
176
177
178
       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

179
    Additionally, the following methods/functions have been renamed:
180
181
182

       acc_cond::is_tt() -> acc_cond::is_t()
       acc_cond::is_ff() -> acc_cond::is_f()
183
       parse_acc_code()  -> acc_cond::acc_code(...)
184

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
185
  * Automata property flags (those that tell whether the automaton is
186
187
188
    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
189
190
191
192
193
194
195
196
    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.
197

198
199
  Python:

200
201
202
203
  * 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.

204
205
206
207
  * 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.

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

211
212
213
214
215
  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

216
217
218
219
220
  * 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

221
222
223
224
225
226
227
228
229
230
231
232
  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/

233
234
  Bug fixes:

235
236
  * twa_graph would incorrectly replace named-states during
    purge_dead_states and purge_unreachable_states.
237
238
  * twa::ap() would contain duplicates when an atomic proposition
    was registered several times.
239
240
  * 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
241
242
  * complete() could incorrectly reuse an existing (but accepting!)
    state as a sink.
243

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

246
247
  Command-line tools:

248
249
250
251
  * 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.
252
253
    A demonstration of this feature via the Python bindings
    can be found at https://spot.lrde.epita.fr/ipynb/decompose.html
254

255
256
257
258
259
260
  * 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.

261
262
263
264
265
266
267
  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
268
269
    do actually check the automaton.  The getters have been renamed to
    avoid confusion, and get names more in line with the HOA format.
270
271
272
273
274
275
276
277
278

    - 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
279
    The setters have the same names as the getters, except they take a
280
281
282
    Boolean argument.  This argument used to be optionnal (defaulting
    to True), but it no longer is.

283
284
285
286
287
288
289
290
291
292
  * 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".
293

294
295
296
297
  * 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.

298
299
300
301
302
  * 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.

303
304
305
306
307
308
309
  * 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
310
  * The sat minimization for DTωA now does a better job at selecting
311
312
313
314
315
    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
316
  * Explicit Kripke structures (i.e., stored as explicit graphs) have
317
    been rewritten above the graph class, using an interface similar
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
318
319
    to the twa class.  The new class is called kripke_graph.  The ad
    hoc Kripke parser and printer have been removed, because we can
320
321
    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
322
    has an option to load such an HOA file as a kripke_graph.
323

324
325
326
327
  * The HOA parser now accepts identifier, aliases, and headernames
    containing dots, as this will be allowed in the next version of
    the HOA format.

328
329
  * Renamings:
    is_guarantee_automaton() -> is_terminal_automaton()
330
    tgba_run -> twa_run
331
    twa_word::print -> operator<<
332
333
    dtgba_sat_synthetize() -> dtwa_sat_synthetize()
    dtgba_sat_synthetize_dichotomy() -> dtwa_sat_synthetize_dichotomy()
334

335
  Python:
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
336

337
  * Add bindings for is_unambiguous().
338
  * Better interface for sat_minimize().
339

340
  Bug fixes:
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
341

342
  * the HOA parser was ignoring the "unambiguous" property.
343
344
  * --dot=Bb should work like --dot=b, allowing us to disable
    a B option set via an environment variable.
345

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

348
349
350
  Command-line tools:

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

353
  * By default, autfilt does not simplify automata (this has not
354
    changed), as if the --low --any options were used.  But now, if
355
356
357
    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
358
    --high is given, then the translation intent defaults to --small
359
360
    (unless specified otherwise).

361
362
363
364
  * 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.

365
366
367
  * ltlgrind FILENAME[/COL] is now the same as
    ltlgrind -F FILENAME[/COL] for consistency with ltlfilt.

368
369
  Library:

370
371
372
373
374
  * 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().
375
376
377
378
379

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

380
381
382
383
384
  * 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
385
    the language, but it speeds up some algorithms like NDFS-based
386
387
    emptiness checks, as discussed in our Spin'15 paper.)

388
389
390
  * 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.

391
  * The way to pass option to the automaton parser has been changed to
392
    make it easier to introduce new options.  One such new option is
393
394
    "trust_hoa": when true (the default) supported properties declared
    in HOA files are trusted even if they cannot be easily be verified.
395
396
397
398
399
    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
400
    input filename (making the output of error messages easier).
401

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
402
  * The following renamings make the code more consistent:
403
404
405
    ltl_simplifier -> tl_simplifier
    tgba_statistics::transitions -> twa_statistics::edges
    tgba_sub_statistics::sub_transitions -> twa_sub_statistics::transitions
406
    tgba_run -> twa_run
407
    reduce_run -> twa_run::reduce
408
409
410
411
    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
412
413
414
415
416
417
    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
418

419
420
  Python:

421
  * The minimum supported Python version is now 3.3.
422
  * Add bindings for complete() and dtwa_complement()
423
424
  * Formulas now have a custom __format__ function.  See
    https://spot.lrde.epita.fr/tut01.html for examples.
425
426
  * The Debian package is now compiled for all Python3 versions
    supported by Debian, not just the default one.
427
  * Automata now have get_name()/set_name() methods.
428
429
430
  * 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().)
431
432
433
434
435
436
437
438
  * 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--.
439

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
440
441
442
443
444
445
  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

446
447
  Bugs fixed:

448
  * Work around some weird exception raised when using the
449
450
451
452
453
    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.
454
  * "randaut -Q0 1" used to segfault.
455
456
  * "ltlgrind -F FILENAME/COL" did not preserve other CSV columns.
  * "ltlgrind --help" did not document FORMAT.
457
  * unabbreviate could easily use forbidden operators.
458
459
  * "autfilt --is-unambiguous" could fail to detect the nonambiguity
    of some automata with empty languages.
460
461
462
  * 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"
463

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

466
467
  New features:

468
469
470
471
  * 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.
472

473
474
475
476
477
478
479
480
481
482
  * 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.

483
484
485
486
487
488
489
490
491
492
  * 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.)

493
494
  Major code changes and reorganization:

495
496
497
  * 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
498
    - LTL/PSL formulas are now represented by lightweight formula
499
500
501
502
      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
503
      used to distinguish between operators.
504
505
506
507
508
509
510
511
    - 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.
512

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
513
514
515
516
517
  * 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.

518
519
520
  * The LTL/PSL parser is now declared in tl/parse.hh (instead of
    ltlparse/public.hh).

521
522
523
524
525
526
527
528
529
530
531
  * 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.
532

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

535
536
537
  * The CGI script for LTL translation offers a HOA download link
    for each generated automaton.

538
  * The html documentation now includes a HTML copies of the man
539
    pages, and HTML copies of the Python notebooks.
540

541
542
543
544
  * scc_filter(aut, true) does not remove Fin marks from rejecting
    SCCs, but it now does remove Fin marks from transitions between
    SCCs.

545
546
547
  * All the unabbreviation functions (unabbreviate_ltl(),
    unabbreviate_logic(), unabbreviate_wm()) have been merged into a
    single unabbreviate() function that takes a string representing
548
549
550
    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.
551

552
553
554
555
  * 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.)

556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
  * 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
579
      converting them to Büchi.
580
581
    - 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
582
      automata.  This implies a few minor semantic changes, for
583
      instance --stats=%A used to output the number of acceptance
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
584
      *pairs* in the input automaton, while it now outputs the
585
586
      number of acceptance sets like in all the other tools.

587
588
  * Bugs fixed
    - Some acceptance conditions like Fin(0)|Fin(1)|Fin(2)&Inf(3)
589
      were not detected as generalized-Rabin.
590
591
    - 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
592
    - The CGI script for LTL translation now forces transition-based
593
594
595
596
      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
597
598
    - 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
599
600
      slightly wrong.  For instance ^ was incorrectly escaped, and
      the double quotes where not always properly rendered.
601
602
    - A spurious assertion was triggered by streett_to_generalized_buchi(),
      but only when compiled in DEBUG mode.
603
    - LTL formula rewritten in Spin's syntax no longer have their ->
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
604
      and <-> rewritten away.
605
    - Fix some warnings reported by the development version of GCC 6.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
606
    - The spot.translate() function of the Python binding had a typo
607
      preventing the use of 'low'/'medium'/'high' as argument.
608
    - Fix spurious failure of uniq.test under different locales.
609
610
    - ltlcross now recovers from out-of-memory errors during
      state-space products.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
611
612
    - bitvect.test was failing on 32bit architectures with
      assertions enabled because of a bug in the test case.
613

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

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

621
622
623
  * 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
624
    remove_fin() functions when the input automaton is a Streett
625
626
627
628
629
630
631
632
633
    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
634
635
636
637
    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.
638

639
  * Bugs fixed:
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
640
    - p[+][:*2] was not detected as belonging to siPSL.
641
642
    - scc_filter() would incorrectly remove Fin marks from
      rejecting SCCs.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
643
    - the libspotltsmin library is installed.
644
    - ltlcross and ltldo did not properly quote atomic propositions
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
645
646
      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
647
648
649
650
      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.
651

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

654
655
656
657
658
  * 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
659
      Automata) while this version now deals with what we call TωA
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
      (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.

679
    - As a consequence of the switches to C++11 and to TωA, a lot of
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
      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
713
      have a tool that is bogus on some formula that is too large to
714
715
716
      debug, you can use ltlgrind to generate smaller derived formulas
      and see if you can reproduce the bug on those.

717
718
719
720
721
722
723
724
725
726
727
728
      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
729
    - ltl2tgba has a new option, -U, to produce unambiguous automata.
730
731
732
      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
733

734
    - ltl2tgba has a new option, -S, to produce generalized-Büchi
735
736
737
738
739
      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.

740
741
742
743
744
    - 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.

745
    - ltlcross has several new options:
746

747
748
        --grind attempts to reduce the size of any bogus formula it
        discovers, while still exhibiting the bug.
749

750
751
        --ignore-execution-failures ignores cases where a translator
        exits with a non-zero status.
752
753

	--automata save the produced automata into the CSV or JSON
754
        file.  Those automata are saved using the HOA format.
755
756
757
758
759

      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.
760

761
    - "ltlfilt --stutter-invariant" will now work with PSL formulas.
762
      The implementation is actually much more efficient
763
      than our previous implementation that was only for LTL.
764

765
766
767
768
769
    - 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.

770
771
772
773
    - 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.

774
775
776
    - ltlfilt has a new --count option to count the number of matching
      automata.

777
778
779
    - ltlfilt has a new --exclusive-ap option to constrain formulas
      based on a list of mutually exclusive atomic propositions.

780
781
782
783
    - 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.

784
785
786
787
788
789
    - 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.

790
791
792
793
    - 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
794
795
796
797
798
799
800
801
802
803
      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
804
805
      or 'stutter-sensitive'.  Another check performed by
      --check is testing whether the automaton is unambiguous.
806

807
808
809
810
811
812
    - 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.

813
814
    - For options that take an output filename (i.e., ltlcross's
      --save-bogus, --grind, --csv, --json) you can force the file
815
816
      to be opened in append mode (instead of being truncated) by
      by prefixing the filename with ">>".  For instance
817
818
819
      	  --save-bogus=">>bugs.ltl"
      will append to the end of the file.

820
821
  * Other noteworthy news

822
823
824
825
826
827
828
829
    - 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.)

830
831
832
833
    - 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.

834
835
    - There is a parser for the HOA format
      (http://adl.github.io/hoaf/) available as a
836
837
838
839
840
841
      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
842
843
      alternation.  Multiple initial states are converted into an
      extra initial state; complemented acceptance sets Inf(!x) are
844
845
      converted to Inf(x); explicit or implicit labels can be used;
      aliases are supported; "--ABORT--" can be used in a stream.
846

847
848
849
850
851
852
    - 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).
853

854
855
    - While not all algorithms in the library are able to work with
      any acceptance condition supported by the HOA format, the
856
      following two new functions mitigate that:
857
858
859
860
861
862
863
864
865
866

      - remove_fin() takes a TωA whose accepting condition uses Fin(x)
	primitive, and produces an equivalent TωA without Fin(x):
	i.e., the output acceptance is a disjunction of generalized
	Büchi acceptance.  This type of acceptance is supported by
	SCC-based emptiness-check, for instance.

      - similarly, to_tgba() converts any TωA into an automaton with
	generalized-Büchi acceptance.

867
868
869
    - randomize() is a new algorithm that randomly reorders the states
      and transitions of an automaton.  It can be used from the
      command-line using "autfilt --randomize".
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
870

871
872
    - the interface in iface/dve2 has been renamed to iface/ltsmin
      because it can now interface the dynamic libraries created
873
      either by Divine (as patched by the LTSmin group) or by
874
875
      Spins (the LTSmin compiler for Promela).

876
877
878
879
880
881
882
883
    - LTL/PSL formulas can include /* comments */.

    - PSL SEREs support a new operator [:*i..j], the iterated fusion.
      [:*i..j] is to the fusion operator ':' what [*i..j] is to the
      concatenation operator ';'.  For instance (a*;b)[:*3] is the
      same as (a*;b):(a*;b):(a*;b).  The operator [:+], is syntactic
      sugar for [:*1..], and corresponds to the operator ⊕ introduced
      by Dax et al. (ATVA'09).
884

885
886
887
888
889
890
    - GraphViz output now uses an horizontal layout by default, and
      also use circular states (unless the automaton has more than 100
      states, or uses named-states).  The --dot option of the various
      command-line tools takes an optional parameter to fine-tune the
      GraphViz output (including vertical layout, forced circular or
      elliptic states, named automata, SCC information, ordered
891
892
893
894
      transitions, and different ways to colorize the acceptance
      sets).  The environment variables SPOT_DOTDEFAULT and
      SPOT_DOTEXTRA can also be used to respectively provide a default
      argument to --dot, and add extra attributes to the output graph.
895

896
    - Never claims can now be output in the style used by Spin since
897
898
899
900
901
902
      version 6.2.4 (i.e., using do..od instead of if..fi, and with
      atomic statements for terminal acceptance).  The default output
      is still the old one for compatibility with existing tools.  The
      new style can be requested from command-line tools using option
      --spin=6 (or -s6 for short).

903
    - Support for building unambiguous automata.  ltl_to_tgba() has a
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
904
905
906
907
      new options to produce unambiguous TGBA (used by ltl2tgba -U as
      discussed above).   The function is_unambiguous() will check
      whether an automaton is unambigous, and this is used by
      autfilt --is-unmabiguous.
908

909
910
911
912
913
914
915
916
    - The SAT-based minimization algorithm for deterministic automata
      has been updated to work with ω-Automaton with any acceptance.
      The input and the output acceptance can be different, so for
      instance it is possible to create a minimal deterministic
      Streett automaton starting from a deterministic Rabin automaton.
      This functionnality is available via autfilt's --sat-minimize
      option.  See doc/userdoc/satmin.html for details.

917
918
919
    - The on-line interface at http://spot.lrde.epita.fr/trans.html
      can be used to check stutter-invariance of any LTL/PSL formula.

920
921
922
923
    - The on-line interface will work around atomic propositions not
      supported by ltl3ba.  (E.g. you can now translate F(A) or
      G("foo < bar").)

924
  * Noteworthy code changes
925
926
927

    - Boost is not used anymore.

928
929
930
931
932
933
934
935
936
937
938
939
940
    - Automata are now manipulated exclusively via shared pointers.

    - Most of what was called tgba_something is now called
      twa_something, unless it is really meant to work only for TGBA.
      This includes functions, classes, file, and directory names.
      For instance the class tgba originally defined in tgba/tgba.hh,
      has been replaced by the class twa defined in twa/twa.hh.

    - the tgba_explicit class has been completely replaced by a more
      efficient twa_graph class.  Many of the algorithms that were
      written against the abstract tgba (now twa) interface have been
      rewritten using twa_graph instances as input and output, making
      the code a lot simpler.
941

942
943
944
    - The tgba_succ_iterator (now twa_succ_iterator) interface has
      changed.  Methods next(), and first() should now return a bool
      indicating whether the current iteration is valid.
945

946
947
    - The twa base class has a new method, release_iter(), that can
      be called to give a used iterator back to its automaton.  This
948
949
950
951
      iterator is then stored in a protected member, iter_cache_, and
      all implementations of succ_iter() can be updated to recycle
      iter_cache_ (if available) instead of allocating a new iterator.

952
953
954
    - The tgba (now called twa) base class has a new method, succ(),
      to support C++11' range-based for loop, and hide all the above
      change.
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977

      Instead of the following syntax:

	tgba_succ_iterator* i = aut->succ_iter(s);
	for (i->first(); !i->done(); i->next())
	  {
	     // use i->current_state()
	     //     i->current_condition()
	     //     i->current_acceptance_conditions()
	  }
	delete i;

      We now prefer:

	for (auto i: aut->succ(s))
	  {
	    // use i->current_state()
	    //     i->current_condition()
	    //     i->current_acceptance_conditions()
	  }

      And the above syntax is really just syntactic suggar for

978
	twa_succ_iterator* i = aut->succ_iter(s);
979
980
981
982
983
984
985
986
987
988
989
990
	if (i->first())
	  do
	    {
	      // use i->current_state()
	      //     i->current_condition()
	      //     i->current_acceptance_conditions()
	    }
	  while (i->next());
	aut->release_iter(i); // allow the automaton to recycle the iterator

      Where the virtual calls to done() and delete have been avoided.

991
    - twa::succ_iter() now takes only one argument.  The optional
992
993
994
995
996
997
998
999
1000
      global_state and global_automaton arguments have been removed.

    - The following methods have been removed from the TGBA interface and
      all their subclasses:
        - tgba::support_variables()
	- tgba::compute_support_variables()
	- tgba::all_acceptance_conditions()       // use acc().accepting(...)
	- tgba::neg_acceptance_conditions()
	- tgba::number_of_acceptance_conditions() // use acc().num_sets()
1001

1002
    - Membership to acceptance sets are now stored using bit sets,
1003
      currently limited to 32 bits.  Each TωA has a acc() method that
1004
1005
1006
1007
      returns a reference to an acceptance object (of type
      spot::acc_cond), able to operate on acceptance marks
      (spot::acc_cond::mark_t).

1008
      Instead of writing code like
1009
1010
1011
        i->current_acceptance_conditions() == aut->all_acceptance_conditions()
      we now write
        aut->acc().accepting(i->current_acceptance_conditions())
1012
      (Note that for accepting(x) to return something meaningful, x
1013
      should be a set of acceptance sets visitied infinitely often.  So let's
1014
      imagine that in the above example i is looking at a self-loop.)
1015
1016
1017
1018
1019
1020

      Similarly,
        aut->number_of_acceptance_conditions()
      is now
        aut->acc().num_sets()

1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
    - All functions used for printing LTL/PSL formulas or automata
      have been renamed to print_something().  Likewise the various
      parsers should be called parse_something() (they haven't yet
      all been renamed).

    - All test suites under src/ have been merged into a single one in
      src/tests/.  The testing tool that was called
      src/tgbatest/ltl2tgba has been renamed as src/tests/ikwiad
      (short for "I Know What I Am Doing") so that users should be
      less tempted to use it instead of src/bin/ltl2tgba.

1032
1033
  * Removed features

1034
    - The long unused interface to GreatSPN (or rather, interface to
1035
      a non-public, customized version of GreatSPN) has been removed.
1036
      As a consequence, we could get rid of many cruft in the
1037
1038
      implementation of Couvreur's FM'99 emptiness check.

1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
    - Support for symbolic, BDD-encoded TGBAs has been removed.  This
      includes the tgba_bdd_concrete class and associated supporting
      classes, as well as the ltl_to_tgba_lacim() LTL translation
      algorithm.  Historically, this TGBA implementation and LTL
      translation were the first to be implemented in Spot (by
      mistake!) and this resulted in many bad design decisions.  In
      practice they were of no use as we only work with explicit
      automata (i.e. not symbolic) in Spot, and those produced by
      these techniques are simply too big.

    - All support for ELTL, i.e., LTL logic extended with operators
1050
      represented by automata has been removed.  It was never used in
1051
1052
1053
1054
      practice because it had no practical user interface, and the
      translation was a purely-based BDD encoding producing huge
      automata (when viewed explictely), using the above and non
      longuer supported tgba_bdd_concrete class.
1055

1056
    - Our implementation of the Kupferman-Vardi complementation has
1057
      been removed: it was unused in practice beause of the size of
1058
1059
1060
      the automata built, and it did not survive the conversion of
      acceptance sets from BDDs to bitsets.

1061
1062
    - The unused implementation of state-based alternating Büchi
      automata has been removed.
1063

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1064
1065
1066
1067
1068
    - Input and output in the old, Spot-specific, text format for
      TGBA, has been fully removed.  We now use HOA everywhere.  (In
      case you have a file in this format, install Spot 1.2.6 and use
      "src/tgbatest/ltl2tgba -H -X file" to convert the file to HOA.)

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1069
New in spot 1.2.6 (2014-12-06)
1070

1071
1072
1073
  * New features:

    - ltlcross --verbose is a new option to see what is being done
1074

1075
1076
  * Bug fixes:

1077
1078
1079
1080
    - Remove one incorrect simplification rule for PSL discovered
      via checks on random formulaes.  (The bug was very unlikely
      to trigger on non-random formulas, because it requires a SERE
      with an entire subexpression that is unsatisfiable.)
1081
1082
1083
1084
1085
1086
    - When the automaton resulting from the translation of a positive
      formula is deterministic, ltlcross will compute its complement
      to perform additional checks against other translations of the
      positive formula.  The same procedure should be performed with
      automata obtained from negated formulas, but because of a typo
      this was not the case.
1087
1088
    - the neverclaim parser will now diagnose redefinitions of
      state labels.
1089
1090
    - the acceptance specification in the HOA format output have been
      adjusted to match recent changes in the format specifications.
1091
    - atomic propositions are correctly escaped in the HOA output.
1092
1093
1094
1095
    - the build rules for documentation have been made compatible with
      version 8.0 of Org-mode.  (This was only a problem if you build
      from the git repository, or if you want to edit the
      documentation.)
1096
1097
1098
1099
    - recent to changes to libstd++ (as shipped by g++ 4.9.2) have
      demonstrated that the order of transitions output by the
      LTL->TGBA translation used to be dependent on the implementation
      of the STL.  This is now fixed.
1100
1101
1102
1103
1104
    - some developpement version of libstd++ had a bug (PR 63698) in
      the assignment of std::set, and that was triggered in two places
      in Spot.  The workaround (not assigning sets) is actually more
      efficient, so we can consider it as a bug fix, even though
      libstd++ has also been fixed.
1105
1106
    - all parsers would report wrong line numbers while processing
      files with DOS style newlines.
1107
    - add support for SWIG 3.0.
1108

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1109
New in spot 1.2.5 (2014-08-21)
1110

1111
  * New features:
1112
1113
1114

    - The online ltl2tgba translator will automatically attempt to
      parse a formula using LBT's syntax if it cannot parse it using
1115
1116
      the normal infix syntax.  It also has an option to display
      formulas using LBT's syntax.
1117

1118
1119
1120
1121
1122
1123
    - ltl2tgba and dstar2tgba have a new experimental option --hoaf to
      output automata in the Hanoï Omega Automaton Format whose
      current draft is at http://adl.github.io/hoaf/
      The corresponding C++ function is spot::hoaf_reachable() in
      tgbaalgos/hoaf.hh.

1124
1125
    - 'randltl 4' is now a shorthand for 'randltl p0 p1 p2 p3'.

1126
1127
1128
1129
    - ltlcross has a new option --save-bogus=FILENAME to save any
      formula for which a problem (other than timeout) was detected
      during translation or using the resulting automatas.

1130
  * Documentation:
1131
1132
1133
1134

    - The man page for ltl2tgba has some new notes and references
      about TGBA and about monitors.

1135
1136
  * Bug fixes:

1137
1138
1139
1140
    - Fix incorrect simplification of promises in the translation
      of the M operator (you may suffer from the bug even if you do
      not use this operator as some LTL patterns are automatically
      reduced to it).
1141
    - Fix simplification of bounded repetition in SERE formulas.
1142
1143
1144
    - Fix incorrect translation of PSL formulas of the form !{f} where
      f is unsatisifable.  A similar bug was fixed for {f} in Spot
      1.1.4, but for some reason it was not fixed for !{f}.
1145
    - Fix parsing of neverclaims produced by Modella.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1146
1147
1148
    - Fix a memory leak in the little-used conversion from
      transition-based alternating automata to tgba.
    - Fix a harmless uninitialized read in BuDDy.
1149
1150
1151
1152
1153
    - When writing to the terminal, ltlcross used to display each
      formula in bright white, to make them stand out.  It turns out
      this was actually hiding the formulas for people using a
      terminal with white background... This version displays formula
      in bright blue instead.
1154
1155
1156
1157
    - 'randltl -n -1 --seed 0' and 'randltl -n -1 --seed 1' used to
      generate nearly the same list of formulas, shifted by one,
      because the PRNG write reset with an incremented seed between
      each output formula.  The PRNG is now reset only once.
1158

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1159
New in spot 1.2.4 (2014-05-15)
1160

1161
1162
1163
  * New features:

    - "-B -x degen-lskip" can be used to disable level-skipping in the
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1164
1165
      degeralization procedure called by ltl2tgba and dstar2tgba.
      This is mostly meant for running experiments.
1166
1167
1168
1169
1170
1171
    - "-B -x degen-lcache=N" can be used to experiment with different
      type of level caching during degeneralization.

  * Bug fixes:

    - Change the Python bindings to make them compatible with Swig 3.0.
1172
1173
1174
    - "ltl2tgta --ta" could crash in certain conditions due to the
      introduction of a simulation-based reduction after
      degeneralization.
1175
1176
1177
1178
1179
    - Fix four incorrect formula-simplification rules, three were
      related to the factorization of Boolean subformulas in
      operands of the non-length-matching "&" SERE operator, and
      a fourth one could only be enabled by explicitely passing the
      favor_event_univ option to the simplifier (not the default).
1180
1181
    - Fix incorrect translation of the fusion operator (":") in SERE
      such as {xx;1}:yy[*] where the left operand has 1 as tail.
1182

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1183
New in spot 1.2.3 (2014-02-11)
1184

1185
1186
1187
1188
1189
  * New features:

    - The SPOT_SATLOG environment variable can be set to a filename to
      obtain statistics about the different iterations of the
      SAT-based minimization.  For an example, see
1190
      http://spot.lrde.epita.fr/satmin.html
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1191
1192
    - The bench/dtgbasat/ benchmark has been updated to use SPOT_SATLOG
      and record more statistics.
1193
1194
1195
1196
    - The default value for the SPOT_SATSOLVER environment
      variable has been changed to "glucose -verb=0 -model %I >%O".
      This assumes that glucose 3.0 is installed.   For older
      versions of glucose, remove the "-model" option.
1197

1198
1199
1200
  * Bug fixes:

    - More fixes for Python 3 compatibility.
1201
1202
1203
    - Fix calculation of length_boolone(), were 'Xa|b|c' was
      considered as length 6 instead of 4 (because it is 'Xa|(b|a)'
      were (b|a) is Boolean).
1204
1205
1206
1207
    - Fix Clang-3.5 warnings.
    - randltl -S did not honor --boolean-priorities.
    - randltl had trouble generating formulas when all unary, or
      all binary/n-ary operators were disabled.
1208
    - Fix spurious testsuite failure when using Pandas 0.13.
1209
1210
1211
1212
1213
    - Add the time spent in child processes when measuring time
      with the timer class.
    - Fix determinism of the SAT-based minimization encoding.
      (It would sometimes produce different equivalent automata,
      because of a different encoding order.)
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1214
1215
    - If the SAT-based minimization is asked for a 10-state automaton
      and returns a 6-state automaton, do not ask for a 9-state
1216
      automaton in the next iteration...
1217
1218
1219
1220
    - Fix some compilation issue with the version of Apple's Clang
      that is installed with MacOS X 10.9.
    - Fix VPATH builds when building from the git repository.
    - Fix UP links in the html documentation for command-line tools.
1221

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1222
New in spot 1.2.2 (2014-01-24)
1223

1224
1225
1226
1227
1228
1229
1230
1231
  * Bug fixes:

    - Fix compilation *and* behavior of bitvectors on 32-bit
      architectures.
    - Fix some compilation errors observed using the antique G++ 4.0.1.
    - Fix compatibility with Python 3 in the test suite.
    - Fix a couple of new clang warnings (like "unused private member").
    - Add some missing #includes that are not included indirectly
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1232
      when the C++ compiler is in C++11 mode.
1233
1234
1235
1236
    - Fix detection of numbers that are too large in the ELTL parser.
    - Fix a memory leak in the ELTL parser, and avoid some unnecessary
      calls to strlen() at the same time.

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1237
New in spot 1.2.1 (2013-12-11)
1238

1239
  * New features:
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1240

1241
1242
1243
1244
1245
1246
    - commands for translators specified to ltlcross can now
      be given "short names" to be used in the CSV or JSON output.
      For instance
         ltlcross '{small} ltl2tgba -s --small %f >%N' ...
      will run the command "ltl2tgba -s --small %f >%N", but only
      print "small" in output files.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1247

1248
1249
1250
1251
1252
1253
1254
    - ltlcross' CSV and JSON output now contains two additional
      columns: exit_status and exit_code, used to report failures of
      the translator.  If the translation failed, only the time is
      reported, and the rest of the statistics, which are missing,
      area left empty (in CVS) or null (in JSON).  A new option,
      --omit-missing can be used to remove lines for failed
      translations, and remove these two columns.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1255

1256
1257
1258
    - if ltlcross is used with --products=+5 instead of --products=5
      then the stastics for each of the five products will be output
      separately instead of being averaged.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1259

1260
1261
1262
1263
1264
    - if ltlcross is used with tools that produce deterministic Streett
      or Rabin automata (as specified with %D), then the statistics
      output in CSV or JSON will have some extra columns to report
      the size of these input automata before ltlcross converts them
      into TGBA to perform its regular checks.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1265

1266
1267
1268
1269
    - ltlfilt, ltl2tgba, ltl2tgta, and ltlcross can now read formulas
      from CSV files.  Use option -F FILE/COL to read formulas from
      column COL of FILE.  Use -F FILE/-COL if the first line of
      FILE be ignored.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1270

1271
1272
1273
1274
1275
    - when ltlfilt processes formulas from a CSV file, it will output
      each CSV line whose formula matches the given constraints, with
      the rewriten formula.  The new escape sequence %< (text in
      columns before the formula) and %> (text after) can be used
      with the --format option to alter this output.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1276

1277
1278
    - ltlfile, genltl, randltl, and ltl2tgba have a --csv-escape option
      to help escape formulas in CSV files.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1279

1280
    - Please check
1281
            http://spot.lrde.epita.fr/csv.html
1282
      for some discussion and examples of the last few features.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1283

1284
  * Bug fixes:
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1285

1286
1287
1288
1289
1290
1291
    - ltlcross' CSV output has been changed to be more RFC 4180
      compliant: it no longuer output useless cosmetic spaces, and
      use double-quotes with proper escaping for strings.  The only
      RFC 4180 rule that it does not follow is that it will terminate
      lines with \n instead of \r\n because the latter cause issues
      with a couple of tools.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1292

1293
1294
    - ltlcross failed to report missing input or output escape sequences
      on all but the first configured translator.
1295

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1296
New in spot 1.2 (2013-10-01)
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1297

Alexandre Duret-Lutz's avatar